From 54284aa152c0e311bb95a478cae13903b9cdbc5a Mon Sep 17 00:00:00 2001 From: mahdanoura Date: Wed, 22 May 2024 11:24:39 +0200 Subject: [PATCH 01/10] argument parsing, json schema generator added --- main.py | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/main.py b/main.py index e69de29..3bc90d1 100644 --- a/main.py +++ b/main.py @@ -0,0 +1,22 @@ +import argparse +from linkml.generators.jsonschemagen import JsonSchemaGenerator +from pathlib import Path + +RESOURCES_PATH = Path('resources') +GENS_PATH = RESOURCES_PATH / 'gens' +JSON_SCHEMA_PATH = GENS_PATH / 'jsonschema' +YAML_SCHEMA_PATH = RESOURCES_PATH / 'thing_description_schema.yaml' + + +def main(yaml_path): + yaml_content = yaml_path.read_text() + json_schema_generator = JsonSchemaGenerator(yaml_content) + (JSON_SCHEMA_PATH / f'{yaml_path.stem}.json').write_text(json_schema_generator.serialize()) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser() + parser.add_argument('-y', '--yaml', default=RESOURCES_PATH / 'thing_description_schema.yaml', + help='the YAML file path including the LinkML schema.') + args = parser.parse_args() + main(Path(args.yaml)) From 14ca29fe7bee87941931cbfeed07c70fcb54b677 Mon Sep 17 00:00:00 2001 From: mahdanoura Date: Wed, 22 May 2024 12:51:31 +0200 Subject: [PATCH 02/10] config-file parsing --- main.py | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/main.py b/main.py index 3bc90d1..56de20d 100644 --- a/main.py +++ b/main.py @@ -1,4 +1,6 @@ import argparse + +import yaml from linkml.generators.jsonschemagen import JsonSchemaGenerator from pathlib import Path @@ -6,17 +8,32 @@ GENS_PATH = RESOURCES_PATH / 'gens' JSON_SCHEMA_PATH = GENS_PATH / 'jsonschema' YAML_SCHEMA_PATH = RESOURCES_PATH / 'thing_description_schema.yaml' +SOURCE_PATH = Path('src') +LINKML_PATH = Path('linkml') +LINKML_GENERATORS_CONFIG_YAML_PATH = SOURCE_PATH / LINKML_PATH / 'config.yaml' + + +def config_file_parse(config_path): + with open(config_path, 'r') as config_file: + config_content = config_file.read() + yaml_content = yaml.safe_load(config_content) + generator_args = yaml_content.get('generator_args', {}) + generators = list(generator_args.keys()) + return generators -def main(yaml_path): +def main(yaml_path, config_path): + generators = config_file_parse(config_path) yaml_content = yaml_path.read_text() json_schema_generator = JsonSchemaGenerator(yaml_content) (JSON_SCHEMA_PATH / f'{yaml_path.stem}.json').write_text(json_schema_generator.serialize()) if __name__ == '__main__': - parser = argparse.ArgumentParser() - parser.add_argument('-y', '--yaml', default=RESOURCES_PATH / 'thing_description_schema.yaml', - help='the YAML file path including the LinkML schema.') + parser = argparse.ArgumentParser(description='WoT TD toolchain for automating specification generation') + parser.add_argument('-y', '--yaml', default=YAML_SCHEMA_PATH, + help='Path to the LinkML schema formatted as a YAML file.') + parser.add_argument('-c', '--config-file', default=LINKML_GENERATORS_CONFIG_YAML_PATH, + help='Path to YAML configuration for specifying the required LinkML generators.') args = parser.parse_args() - main(Path(args.yaml)) + main(Path(args.yaml), Path(args.config_file)) From 949bf5650b2d3b210f8a250d877f9363cf5e056a Mon Sep 17 00:00:00 2001 From: mahdanoura Date: Wed, 22 May 2024 15:07:55 +0200 Subject: [PATCH 03/10] LinkML generators added --- main.py | 45 +- .../gens/excel/thing_description_schema.xlsx | Bin 11479 -> 0 bytes .../graphql/thing_description_schema.graphql | 161 -- .../thing_description_schema.context.jsonld | 283 --- .../jsonld/thing_description_schema.jsonld | 2159 ----------------- .../thing_description_schema.schema.json | 1086 --------- .../gens/owl/thing_description_schema.owl.ttl | 1287 ---------- .../prefixmap/thing_description_schema.yaml | 33 - .../protobuf/thing_description_schema.proto | 159 -- .../shacl/thing_description_schema.shacl.ttl | 638 ----- .../gens/shex/thing_description_schema.shex | 225 -- .../sqlschema/thing_description_schema.sql | 454 ---- 12 files changed, 42 insertions(+), 6488 deletions(-) delete mode 100644 resources/gens/excel/thing_description_schema.xlsx delete mode 100644 resources/gens/graphql/thing_description_schema.graphql delete mode 100644 resources/gens/jsonld/thing_description_schema.context.jsonld delete mode 100644 resources/gens/jsonld/thing_description_schema.jsonld delete mode 100644 resources/gens/jsonschema/thing_description_schema.schema.json delete mode 100644 resources/gens/owl/thing_description_schema.owl.ttl delete mode 100644 resources/gens/prefixmap/thing_description_schema.yaml delete mode 100644 resources/gens/protobuf/thing_description_schema.proto delete mode 100644 resources/gens/shacl/thing_description_schema.shacl.ttl delete mode 100644 resources/gens/shex/thing_description_schema.shex delete mode 100644 resources/gens/sqlschema/thing_description_schema.sql diff --git a/main.py b/main.py index 56de20d..7d6bafe 100644 --- a/main.py +++ b/main.py @@ -2,6 +2,14 @@ import yaml from linkml.generators.jsonschemagen import JsonSchemaGenerator +from linkml.generators.shaclgen import ShaclGenerator +from linkml.generators.shexgen import ShExGenerator +from linkml.generators.owlgen import OwlSchemaGenerator +from linkml.generators.markdowngen import MarkdownGenerator +from linkml.generators.jsonldgen import JSONLDGenerator +from linkml.generators.jsonldcontextgen import ContextGenerator +from linkml.generators.typescriptgen import TypescriptGenerator +from linkml.generators.protogen import ProtoGenerator from pathlib import Path RESOURCES_PATH = Path('resources') @@ -23,11 +31,42 @@ def config_file_parse(config_path): def main(yaml_path, config_path): - generators = config_file_parse(config_path) yaml_content = yaml_path.read_text() - json_schema_generator = JsonSchemaGenerator(yaml_content) - (JSON_SCHEMA_PATH / f'{yaml_path.stem}.json').write_text(json_schema_generator.serialize()) + generators = config_file_parse(config_path) + for generator in generators: + output_dir = GENS_PATH / generator + output_dir.mkdir(parents=True, exist_ok=True) + if generator == 'jsonschema': + json_schema_generator = JsonSchemaGenerator(yaml_content) + (JSON_SCHEMA_PATH / f'{yaml_path.stem}.json').write_text(json_schema_generator.serialize()) + elif generator == 'owl': + owl_generator = OwlSchemaGenerator(yaml_content) + (output_dir / f'{yaml_path.stem}.owl.ttl').write_text(owl_generator.serialize()) + elif generator == 'markdown': + markdown_generator = MarkdownGenerator(yaml_content) + (output_dir / f'{yaml_path.stem}.md').write_text(markdown_generator.serialize(directory=str(output_dir))) + elif generator == 'shacl': + shacl_generator = ShaclGenerator(yaml_content) + (output_dir / f'{yaml_path.stem}.shacl.ttl').write_text(shacl_generator.serialize()) + elif generator == 'shex': + shex_generator = ShExGenerator(yaml_content) + (output_dir / f'{yaml_path.stem}.shex').write_text(shex_generator.serialize()) + elif generator == 'jsonld': + jsonld_generator = JSONLDGenerator(yaml_content) + (output_dir / f'{yaml_path.stem}.jsonld').write_text(jsonld_generator.serialize()) + elif generator == 'jsonldcontext': + context_generator = ContextGenerator(yaml_content) + (output_dir / f'{yaml_path.stem}.context.jsonld').write_text(context_generator.serialize()) + elif generator == 'typescript': + typescript_generator = TypescriptGenerator(yaml_content) + (output_dir / f'{yaml_path.stem}.js').write_text(typescript_generator.serialize()) + elif generator == 'protobuf': + protobuf_generator = ProtoGenerator(yaml_content) + (output_dir / f'{yaml_path.stem}.js').write_text(protobuf_generator.serialize()) + else: + print(f"Unknown generator: {generator}") + continue if __name__ == '__main__': parser = argparse.ArgumentParser(description='WoT TD toolchain for automating specification generation') diff --git a/resources/gens/excel/thing_description_schema.xlsx b/resources/gens/excel/thing_description_schema.xlsx deleted file mode 100644 index f673d0c0d31f5a17dc26f44c6bf6ce22f60e25e7..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 11479 zcmaKS1yq!6w>I59bazNdcXxNU44N?-4(%mhMbT?9x()=UucaER@z6aLK zEY@OQb3c3U>)xp>2ML7<1_lNP=IL0YEvegq6bSmO67)g?z0B-Qm7VMzoL|0jaA5MV zwNZ#xKK=3U`i> z?gC%*0V%LrM9D6($s#-{Dts$#V&M_bNWh$BH)RDuAEYssJljax9nnDz?+#%z$2#5K z=epqJbeE*pEVNfi)@RYdGtDHm_SdhV+v0DamH#-e=_1hd2z1UNa4<0R|30s&y_5N` z11H8RD0ML-g**;Uz1h!Ohza{*D4Z@VYJw4_m*Al%ewN)`xYSm_sK*6`6Mb@fRaq)c z6pR9&r52XlZ(?{}cA>LdPlqC|0%qnTT;Rlk<_qUe#v{?ic1ZT(KKl}m!<1_^CP5|7 z81sW8CpJy~conPfCpQdSy!$K}dHN}*k4;k}>7T=uP~Y3|Fc^Y*ZTqLLf?UKm(4Tf&p1VA>9D(_beb zKN!;8xF+Dw5j8D|=>O0@;t5B8=O5d)0^#??J8uk2keQX8?_88@LH zGd)UIql^!i+8=Ns6-d^zSbl$z)HIOC=9S^YJ7S&SXZ0Dp;IJueH2%(ccQdOXenvrb z#G#o1{^XWI?^P&`9Us7nm(Wtwd-U=$HlK=h^!OTKUyLxx1GmrZejB!$1gRS7ju)evA~mXSJ;a=7<#5X z65CHo)A@-27{dvOFd`vIl++kSJiZFjfCu{g`G@pL;U5VvDQ{$B-&<8t6u3|i@3P@{ zNR|`0h5{$}y&j;i(>V|bV+n{LED5S4$%3q!eh`;aMyHl`qSK2Cn&5HbJJnzZ)H)Ug z8S7&7j(aFhRHNVNlyJlg8uuRz$GVP8$D*Le8FGRCcO)_fy^T18TQ>DD$59*VKGU#E zreim7$l|`c1*xXbd_?95e*IC7(?1F{FtO(F24a9<5 zULFWsA9|aW%L3nkKaS6Hb$-4IZ0GS~@)^xPZa5dno~YxZ@UiTejMQ6}wA1UpEn}IV zVP~Q>)p8o{?^7?2r<>);YCpIK3TB=h-po-3m8a@3Qeel(1yqSp*55@A{&>+1ziXyP z1wW)dY0edakts@Gx2JX?n>e#o-auQ=ueZ5Zp6w#YFnY~zv{OBd$R<|jB=@~Gp|ysZ zTlT#2tAir(5E7pye;iS*`$r;<+e-ttO^SSGwIs26e9=}&+s2GVUhd4~*an12)foG( z>%ATi{B@o=s0N>8E!&;h@$uW84wZ`BWBw0BePO3LWJlQ{$)jCjp`LGyk}VT^mDw?E zZAvH^BxHC`$?=wdC$a0WlcaC7F&?+E@X5T! zuAI&t&z4-3r_(AKVEK7)*}SqtgJ@Jk@3f-zwLmqN;^>1;X@3?Hx*|3rhO}t{&L`QN zGd#7{9eSB=4emAxwpxrN+~$q#K1W5hdJMN(R0!6FCY~ZMa~8`_rz?y|@CT_hkV5(#0j zaacE%kK$rr0N}$31L8j*0?j@V`X}EYwwxk0&|!^~3i9|#FuV;>G@PKqz>KIsf+oXp z+BiOrf9?Km=7u4_Hb|Y->>JLYSa^p3o0HhAI@MX(JT+qQ!n*o!6MieTv0RszT?Qk~ zk5y<0`D@U;WmIlEYG*YCnCZh{j*7H zW4Y2bRXShwo09<2w7cnryvwCkB=4!uy7^}G=t6R^-Xw7_rtkF5*^S;~nv{O3EbX0V zLGtw1K10g3;9d!pNX2LS7Fog*g|iOfzI3vI}fQp=gUsffV8_;8F| z(b*lnb{N?P{$~I&V6yul35u-J5MW@q{{#?sdnapWpt-q=^UJ4?rzqm8x}XROviFHE zNGe>U_1S9@XVC&-^Q-_r(rfGp7{le(Rj%HoyWn`N($#J_SH_!&x1kDvnHx>lD@SAk zwWaaC6PF;c5w@QwL@vKrpK@nKB36$Vp6>t5-xjNBMN>@vZMyZv4`E3@?OO)I5{-v9 z@GyO6WIh9!ooPb80C+uT@92>@&w8`3K=obh=2E(WDYTM#15S! zJ2E|8Odx-s*)FUQD|&JQPtQ!vS{eVIqNqMha`X5~{4sgk@(mxBaqzYQ*HqHFq8W1a zcVpn&4FI8KW2?5ea$a%gM)Ebcjm8v9SlnWvf&Rn?{uvH>m3#xzt=F`am66)<7wA=Y zsHTxfKiGRVN$svAuA`w@AsGQ%ReG0uG(&2l+<7>2Wa#slmvmtPi-7nQw_sl%bx)Wti5J-5Ly2QHroebb4C|DDHkJjq|3(^ii$?d@Kf0Hm z?r-Avi+R%h)}Ok+LVD6YPbEnAbY%bNUJ#a=IRPg_QqMsocZk0_UwZ^+C_MH>EBm`O z>XCJ3zHT3=V+Fd?U3jD^Oe#!2-&fGR;#6*@&KOuTpJF`;vbKyS?`-S~AWFu(_d{+} z`NK;BG>MRG9lYO8%Ky}gd>Nsx;X%ko5?UI;3sXsj^BO0qnrhT@IHPdBt1_k=hCG3T z*6V{AZ@&{pKki#RD_26M3iDSlkw|K0VICU|Sx^v%^ z_w6zHPYHf=^Y*r%&o&B$@sE3Ht=}&$Hf1P-7Xed(KrHnoDs5Q&@^53 zm%ior)l=#-4VR9?mNyi{a31<)Y%GH7qX$h>!evU}kuWjEXdk>gk=}*J*2lf~Q9emy zkMr9SyYgHSN~%)@w*W4?$|z7XNvMkEbB18g3beNtRIOmxV-@jV%u)$*rWHtFn#j6M zF`-z=WFDrnsVEN42p3V7k?ERM(%AKeN%A4goI~YnzFfeDnVkdHzIt3>@k5pDkwIa0 zH+|MaWv8RzivWYd(@Is%9|3f37BzT|PV* z)M6Ql>HY=&wxlO|IMN$o)zjn>m3U)cPQUQ;fOu<4XR$6`;yR;7Zl-}${1$m^ryUw; zOQ&EQTYqeq71fpwyXxAcSQ^g=zt;iF(lMEFohh*H6Q<`m6wK=gj0mB&3MkVY48Cig zhzPk!ZBL@CO`{1AJw8J)jQ>NA2oOCEkxL!DgE!>eaUw_mqzBC}dXSAaZ!4;Q+l3?a zA%p>4PO;KMsi<=4-U_LXmdF3$h|~2jr2A!jI6NAPRi7TEXj*6HBhgiI`%gyl3=#d# zYaaE-KXnectynS#>Ad6LbgB+4=+S+IKVc8m`u+giiQWQwf9x3h?a3|yn04LlLT(q-&#s@*QDAsvL9 zh%izp;L=C5($4Iio!_Q&%gYO>QP3}_sR)IpJz(QBEohgVM(zO{oz$GFfcCN$Xm7gv zswRuvE5jZh{KE8S)%9!P?sx9+Elm~iq!yv|s3U4Al~%j(n3$NfL4K{q@UqaR z3HR8@{c^YBk7yUSmu{UM7~et}iUwwh)e@=&15(l+hkZE9`{`LCe{AHTpcw75)W~9D0gh5zfS^T^L7HO&b{=95_ z@&0tnNI*cL%vVA-w-sNMpJTF+hgh{6StR{J*J0=Qd|)FF9yli1yxR|w``WIn3eD}r zf$8kh%N6xg-)8~IUV+V%B$}VC52KKazZT2_5_wP#Z2V~k*H>Gz?-{uX5nYQE14?cA zG9enjzM1S~`|;io%<-Z@(N-V`$YKVikS%Dm%ugIfx6#vyyE3PvYY}>tnjYGy{FxoV zUC5ote0q&+?ZBiFC*w;LSzPxi+}l2Da7E#E$b%2?D(a}9w1Iw#Ch^-?a>ogF-y7~D zmkZAI-U>SBPL|win-r}9X-2B?kn{M=6iT~%K$1-%^a#fg5?#(`3dbgKmoHuN4_x2>UgHfJO@Q8mbiNLS|Y@05|vJlg_#VbYGsMpoS;J*XhkDO#D(q4>va;%}+C zr!Lr292X?6UO9HYngOtC?pjpzQOQq}$EQBL0qAZzO{|It?fG~EtY*>JV52bg4ZJZE z$3+}qLo2hECs9(yl`LqEF=?s#J>T|Q(!f95oe#DB$+=Rl)R}FNVfX(%E^+-bY?Ru9 z-NLUlKx|ZU3u+%a*w&^2X$HIi{OQFp9;@v$hpUfm9_@zmt6fY&JYr@an zx@_=|n=Krim^oxlKUG7D12lu_U5q^~qgpk(vse08`3t>BYa|t`4kT-3^;EVYFE@t> z`B>*W;5 zhF7%A*&lOb@;XN*xXVZNLizL*=iug&n)Vk6TKiybgQe=)mwWk0{9*Tby@JqYb)_8k z1a8!n@oKle(l!y5;1(Fc_VIdVGrdr*BBkvPT4hd;|FJzQO(E8}U!R5n|Lc2B~fpK%_hi^TBKY zp;~V|XQ9SqvKCF|oYul{xi!HV=ug#CCa-$q8%LgjD!o4o?r=HNgogNyl^zUg}@S64`lFS#N?cdI^6{$tTf#Z+FLI=NL}V&w2-E_XbASFmU42y3o510fe8L z)0F4iVZ}<3S)9khrZ>OGe~opcSmJqiUtdXYCMlGfu?v}x=(J3FIxa)+de<I)}4 zePxH$KkJc@!KgrWRZMtDVM_ulCbBkGv^Qe3(Tn$*=uO%~W8{TSU^)~^)bVUqiEiXd zp|gPPqGM39sgxWvq8q$2W9*$3ZdwV?zu%ZmMtWAQ!O;xXQj27)W#=ht+W~!O5U6av z{{70SRTK%&9{=XYkfI42;&IY=N>WO4cWS$^2&l5!0emu+H(Qq#oX#_$!H;b_M7}>9 z10|cv;GdS8_v2FK^~3UlWL-ltef&`OGZo#bMlg%`C01x~(}pL>@m1mgHIYJl!7&@D ziL^8dFrqKQt;5iDO3-I+(WrtTTnPvWyA)7gM1fg6qTvTD5l*Ev!ESwzF5rh~xer|z z32gF#Qk<*2yY;yy`py-s%h+qlyb>DOcLGc5xtS)QdnmkkA{AWYM#iGdGQPQ+&IPR{ zSLM`S*QLO~A6xf!?nfzjFO+Y2b3rK}$?Z++^)tqu{#2x_1X(T{6lU@Mr66X0GF`%g z;-WB;upiYREVEpGEgV(spsF$A0=e?u8Kq+!y0eS`%B#oL%mZk31x@}QP^A!=VdHXj zzy~I47*#8%#Fz7+4`<|RoG0WcpzS-!%^s)Sqj^OvG7T`RzN*&tMwfh%hCOH2)JN_N zX=T1f3=qPlaC8QrkMi_NJwiq;J_NFck?)%$z87wL1EY-<%3Z^1+~UM30z5rm*t_}wu3`6VG9f#dV4!{5Bso>qWDWN1S zSyZ`#$HLS`egV07e0(0Dm%|3~f!EEQ=6XJ*j@fQ6lvtI7CNx=|nUr}~3^Dv%88-l{ z?A-t5m#G-|b>2V?b-wQ=(ZwBFg*RhnP5 ze3V)i&l^^hlnWpJ(`dpb3Cp)U*Fsn+|l+Othy40 z#%!^6<^>^+-Gh+u59;Gl)28_~ml+H_bDx~-HQ~tka&NHumf%v+vMj|G7x58!lRgR< zB$T^W$7mGU`kpSMqN``sMMEymTFozp{vURJ>U=~c*eWeDBl$ndCXxt8%hY!k>FzBPV!NFX{& z38WZJ#)U3vQR_~JC)y#BRZklu_DTcxL`7q|ZCxwVVVEp_{e=W>4fewYQbNWHw|=(} zzByEG0uKY;@h*YYw-o;B57-5X`0_E+n8b|{8N`{3HequcDxH{u{Sr17wujE@nzlXI zmDI{(#zs14-r!9jg64w$}8{a4A!$i-+cu?N0{iAh!zeEn9Z{T9SOW(K&iHFmxARzW@wquzzDsx_4)Sr ztkFWq))re1vh|n$!`4romS?tR4w{$Uz;$>RKbBoNYPVmDE~Ag(zVvV(w~PpUt@IPr z>FRqalkP(Lb6Zbb@d4M?hgx_0NLSXV7TBJp63TfnwTa}QY(U|&gI0{rs_U!6z?2Ve zE|D2sYnfCqRi%lYWw8FnwEezCL_v&tq-VK8MPVpcWZMcBxs~+s00K?jGfa){?KJ(D z@Gf4!%1HT)p2@j~2KSYc6Gj?c*mBO7V%Ewqj_lqzQ#iOGd;Oeg7S+N{9~^aW%BW3C zPm%|_1EB;h|30ccqvCZ=fEIaCMTp^9NC@oWh0BS`IwSLDQ7)NdSg^$PmUg@iC zqbDWWxmlz~+hGW(uxvd`B*X0B{OK`32tA_VsxL~$X@bq$@aHE%@1!8_l3S3O)gF|b zA6nGPS1~as-77LT)@go_kakTjj}Bdy_URbDwNAJQ@8yNkP4__ttkrf^Y9u#0ULu-M zvqjimsf|g5Ru}_TZCaT6I}Q_Y5n;$I2LWE0&7|_h8fk7s^!nYLhmBuy0E9^i?&;V3K~i zWVYB`VK=-oHsiuW2f-7hdkXpTLoxDdG@1m)TVOTho?I!-O1iz~=>=WOots79l^x&_ z0dr-xDRV3S%0Adey#-NJQ>!{sr9~DEcPWy~6$^ zTjCk6fbI7#7vse=yngWmO0v35 z#fi_4kU64Zl0zZ1X?eRGh2BQU5r4l}cyvHL6X-{(bK+m~ft!}pSma|y?eI*%PGRu= z`W{U!hL`jT=Gqd@N@IZj$Q-*Pceh#-ra+e5zy|f2Uc8b1;KV58&fU1=vA0AtEM9J< z&JzjT%-*McvcGT2IOfgqmUEbi1n~7V8I&982?;rw2w%~r$Xa@!5VP83yEw#)2=<06 zVO}6goCmY=p2!Iof=W%-muw+;+#TU#`ura@+%kfX>8H=?uLFNFjiMA^#Kc zon1U_%$hiGG*XU=aHDvmbM~PWBr$A%KMwwlsmO) z8>%;&X{#wbylj?vEF;D4Gy_?v=}nu3c}FvQ9SuinA1<08wMrh1dCLSQ@INP?l`UEN zSn^nVk<+CxT2zs%$?v*UO}w3dF+;=02CP%Gw2HIUEFGU2#0gpcxa$vE@|Kev8U&c8bw@o;1PK&GkABkPNM#w`RSsBiVYzPGIqd%I zm<78MgYq!i!Tn(7Ngv%IRBI2V{~DIcee30TkfeErZvlD&7tePQX`1t0BJoLw`&PcJ zmCAY4YXk7M;x$Hsyf+R0`{%FyHllFVJ#{X`qoO{SU25?TdOBvP8OiU4ka(&^l`YM5 z$TzPIMQa&12iLAapqWXa2}5=2D#Msb5SLsCUDkB_NT9vY7YzB3T+?0B{{~KDEu;qQ z^EnQ%f#Ix~cJ)&8n<*aFVpq;b5@|Rr4A|+M*M3cB07zyQPQPSikHL6TNWDy4mD$to z5dhR>47WKv4A?X|3O^>d3MIr;jtXQ6e}Qud!kV=pcp_C0P`cwB8+yJl(9Xf|2i4%& z7bvsJ1G!d?lCiy zu^g5CqZ^^~LcUEebGQDSCPyjQ7i&7>OvfDU7aVfJjM?llV;8e%4BKZ^{fu39({=LB zcQWS)vHOkA)#mO9m>1wzWnHNhvSPY(j{a*oANyy2f>?Kcz4ok9*@S)cc}s z3ZOH6`@#oxS*;HfH}FQ2*aq-c(yMt6ss+u;Gt}M8Urh7Pl%Fn6GrBDLjtkHZa?HCd zj!z#rFR^QPwUmXTBn(+fRDMO4K2oM%FtMK#za{x_i0tr64{T-t{+pxv!R2^t0Da1sNVse1 zOr(gU@O5+b=3p;ov)a<1o`q|y0S)h%&5#AjJ^brsNz2H)bz^(3xJlfRhf`LIQJ@WI zfHUY(A*BT}9=Dhp*mRFrCrY<<#jI9avqPv-jqZXp`3L&FzP@%=NL@DxxkCdJ*Pi0g z?1jR2lyMjEjm)nbOYc~%QeMj56b_SaX+_+t5)AkBea(7VvLN)Q??>zb4Q@cLumlHc z^8e!!|G58uJH`_ghNttDm(6!2qyusOT^7=do}qIycGUX1~CK*R6zMz8b?` zApI0!QE~@bhR|{on$>-+PqN=D<$63XxZOy7s^_mgH9N=cOnkeR=aOB;{w^EBJ~FZt zZGv)uwAo_!{)j^@gP8a+es}N--H+7>>rjDvbR;eurb4uOue5DlpBo>^M z)~@_Jyo95Y^jEdC<~i#Az!7n0@Em9WBUIQ2`D#qk!DLzhsV>X7tUqvA+!{Ow8DI+) zCf`ZV8f)zJ*%rRV*29qie%RK-HSN8dd!AIJBSaJ%tao*>l?P72u~47mwVOe&7tAGB z)#Eb~b*^_&%YsPsD^&ej_t6uxw{tPKb1_o)bTD@|_(i1Q4^N%>5TpF>j5*mhrm)~# z3wB&gmk>Jp6NNlW#~KlCc=`$K4O}@@LB8eU|-i+>{cc+C=F58_yEJaHTKF0 z2&+=?sxJIDv<4bQ5VBefNJ(b9ko_3eV640gVVBX`04_Yvl{*uE#qEz21tWoH{c4B~ ztt)N}wyrBxXi%zBC=FF+hmlHfhuw0tN*p^Ve)VH6Y$D@~Np;t^>Fzf>fk>v{4H3|r zyx1{m+QO2R{)@d3PB@7DJ`AMSr1){bqiO!sA&$qHg^Q(z?eZ0l!&JPY0~BGGBk>rkpF*;?z!~yHMW0b!NB~%EB;&hf0o*wi$7oV`Yk>T`ue}D zeLV+wKIs2nfB+N_{XhVJ9s55=c|NlKjS>O>SCpr+>N(2uN$hWwYmj6Ai6n`PXxl=fj!bDD|LV_m?Mn8r3{Uc|HmFjS>sm zeEbW_(_G*=%JZJ_Zmailto [[RFC6068]],tel [[RFC3966]],https [[RFC9112]]).", - "from_schema": "td", - "slot_uri": "https://www.w3.org/2019/wot/td#supportContact", - "alias": "supportContact", - "owner": "Thing", - "domain_of": [ - "Thing" - ], - "range": "anyUri", - "@type": "SlotDefinition" - }, - { - "name": "thing__base", - "description": "Define the base URI that is used for all relative URI references throughout a TD document.", - "from_schema": "td", - "slot_uri": "https://www.w3.org/2019/wot/td#base", - "alias": "base", - "owner": "Thing", - "domain_of": [ - "Thing" - ], - "range": "anyUri", - "@type": "SlotDefinition" - }, - { - "name": "thing__version", - "from_schema": "td", - "slot_uri": "https://www.w3.org/2019/wot/td#version", - "alias": "version", - "owner": "Thing", - "domain_of": [ - "Thing" - ], - "range": "VersionInfo", - "inlined": true, - "@type": "SlotDefinition" - }, - { - "name": "thing__forms", - "description": "Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings.", - "from_schema": "td", - "slot_uri": "https://www.w3.org/2019/wot/td#forms", - "multivalued": true, - "alias": "forms", - "owner": "Thing", - "domain_of": [ - "Thing" - ], - "range": "Form", - "inlined": true, - "@type": "SlotDefinition" - }, - { - "name": "thing__links", - "description": "Provides Web links to arbitrary resources that relate to the specified Thing Description.", - "from_schema": "td", - "slot_uri": "https://www.w3.org/2019/wot/td#links", - "multivalued": true, - "alias": "links", - "owner": "Thing", - "domain_of": [ - "Thing" - ], - "range": "Link", - "inlined": true, - "@type": "SlotDefinition" - }, - { - "name": "thing__properties", - "description": "All Property-based interaction affordances of the Thing.", - "from_schema": "td", - "slot_uri": "https://www.w3.org/2019/wot/td#properties", - "multivalued": true, - "alias": "properties", - "owner": "Thing", - "domain_of": [ - "Thing" - ], - "range": "PropertyAffordance", - "inlined": true, - "@type": "SlotDefinition" - }, - { - "name": "thing__actions", - "description": "All Action-based interaction affordances of the Thing.", - "from_schema": "td", - "slot_uri": "https://www.w3.org/2019/wot/td#actions", - "multivalued": true, - "alias": "actions", - "owner": "Thing", - "domain_of": [ - "Thing" - ], - "range": "ActionAffordance", - "inlined": true, - "@type": "SlotDefinition" - }, - { - "name": "thing__events", - "description": "All Event-based interaction affordances of the Thing.", - "from_schema": "td", - "slot_uri": "https://www.w3.org/2019/wot/td#events", - "multivalued": true, - "alias": "events", - "owner": "Thing", - "domain_of": [ - "Thing" - ], - "range": "EventAffordance", - "inlined": true, - "@type": "SlotDefinition" - } - ], - "classes": [ - { - "name": "VersionInfo", - "definition_uri": "https://www.w3.org/2019/wot/td#VersionInfo", - "description": "Provides version information.", - "from_schema": "td", - "mappings": [ - "schema:version" - ], - "slots": [ - "versionInfo__instance", - "versionInfo__model" - ], - "slot_usage": {}, - "attributes": [ - { - "name": "instance", - "required": true, - "@type": "SlotDefinition" - }, - { - "name": "model", - "@type": "SlotDefinition" - } - ], - "class_uri": "http://schema.org/version", - "@type": "ClassDefinition" - }, - { - "name": "MultiLanguage", - "definition_uri": "https://www.w3.org/2019/wot/td#MultiLanguage", - "from_schema": "td", - "slots": [ - "multiLanguage__key" - ], - "slot_usage": {}, - "attributes": [ - { - "name": "key", - "identifier": true, - "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", - "@type": "SlotDefinition" - } - ], - "class_uri": "https://www.w3.org/2019/wot/td#MultiLanguage", - "@type": "ClassDefinition" - }, - { - "name": "Link", - "definition_uri": "https://www.w3.org/2019/wot/td#Link", - "description": "A link can be viewed as a statement of the form link context that has a relation type resource at link target\", where the optional target attributes may further describe the resource.", - "from_schema": "td", - "mappings": [ - "hctl:Link" - ], - "slots": [ - "target", - "link__hintsAtMediaType", - "link__type", - "link__relation", - "link__anchor", - "link__sizes", - "link__hreflang" - ], - "slot_usage": {}, - "attributes": [ - { - "name": "hintsAtMediaType", - "description": "Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be.", - "from_schema": "hctl", - "@type": "SlotDefinition" - }, - { - "name": "type", - "@type": "SlotDefinition" - }, - { - "name": "relation", - "description": "A link relation type identifies the semantics of a link.", - "from_schema": "hctl", - "@type": "SlotDefinition" - }, - { - "name": "anchor", - "description": "By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI.", - "from_schema": "hctl", - "range": "anyUri", - "@type": "SlotDefinition" - }, - { - "name": "sizes", - "description": "Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \\\"16x16\\\", \\\"16x16 32x32\\\").", - "from_schema": "hctl", - "@type": "SlotDefinition" - }, - { - "name": "hreflang", - "description": "The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]].", - "from_schema": "hctl", - "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", - "@type": "SlotDefinition" - } - ], - "class_uri": "https://www.w3.org/2019/wot/hypermedia#Link", - "@type": "ClassDefinition" - }, - { - "name": "ExpectedResponse", - "definition_uri": "https://www.w3.org/2019/wot/td#ExpectedResponse", - "description": "Communication metadata describing the expected response message for the primary response.", - "from_schema": "td", - "mappings": [ - "hctl:ExpectedResponse" - ], - "slots": [ - "expectedResponse__contentType" - ], - "slot_usage": {}, - "attributes": [ - { - "name": "contentType", - "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", - "required": true, - "@type": "SlotDefinition" - } - ], - "class_uri": "https://www.w3.org/2019/wot/hypermedia#ExpectedResponse", - "@type": "ClassDefinition" - }, - { - "name": "AdditionalExpectedResponse", - "definition_uri": "https://www.w3.org/2019/wot/td#AdditionalExpectedResponse", - "description": "Communication metadata describing the expected response message for additional responses.", - "from_schema": "td", - "mappings": [ - "hctl:AdditionalExpectedResponse" - ], - "is_a": "ExpectedResponse", - "slots": [ - "expectedResponse__contentType", - "additionalExpectedResponse__additionalOutputSchema", - "additionalExpectedResponse__success", - "additionalExpectedResponse__schema" - ], - "slot_usage": {}, - "attributes": [ - { - "name": "additionalOutputSchema", - "description": "This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used.", - "@type": "SlotDefinition" - }, - { - "name": "success", - "description": "Signals if the additional response should not be considered an error.", - "range": "boolean", - "@type": "SlotDefinition" - }, - { - "name": "schema", - "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", - "@type": "SlotDefinition" - } - ], - "class_uri": "https://www.w3.org/2019/wot/hypermedia#AdditionalExpectedResponse", - "@type": "ClassDefinition" - }, - { - "name": "Form", - "definition_uri": "https://www.w3.org/2019/wot/td#Form", - "description": "A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions.", - "from_schema": "td", - "mappings": [ - "hctl:Form" - ], - "slots": [ - "target", - "form__href", - "form__contentType", - "form__contentCoding", - "form__securityDefinitions", - "form__scopes", - "form__returns", - "form__additionalReturns", - "form__subprotocol", - "form__operationType" - ], - "slot_usage": {}, - "attributes": [ - { - "name": "href", - "range": "anyUri", - "required": true, - "@type": "SlotDefinition" - }, - { - "name": "contentType", - "description": "Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type.", - "from_schema": "hctl", - "@type": "SlotDefinition" - }, - { - "name": "contentCoding", - "description": "Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \\\"gzip\\\", \\\"deflate\\\", etc.", - "from_schema": "hctl", - "@type": "SlotDefinition" - }, - { - "name": "securityDefinitions", - "description": "A security schema applied to a (set of) affordance(s).", - "from_schema": "td:hasSecurityConfiguration", - "@type": "SlotDefinition" - }, - { - "name": "scopes", - "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", - "@type": "SlotDefinition" - }, - { - "name": "returns", - "description": "This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages.", - "range": "ExpectedResponse", - "@type": "SlotDefinition" - }, - { - "name": "additionalReturns", - "description": "This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema.", - "from_schema": "hctl", - "multivalued": true, - "range": "AdditionalExpectedResponse", - "@type": "SlotDefinition" - }, - { - "name": "subprotocol", - "description": "Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options.", - "from_schema": "hctl", - "@type": "SlotDefinition" - }, - { - "name": "operationType", - "description": "Indicates the semantic intention of performing the operation(s) described by the form.", - "from_schema": "hctl", - "multivalued": true, - "range": "OperationTypes", - "@type": "SlotDefinition" - } - ], - "class_uri": "https://www.w3.org/2019/wot/hypermedia#Form", - "@type": "ClassDefinition" - }, - { - "name": "SecurityScheme", - "definition_uri": "https://www.w3.org/2019/wot/td#SecurityScheme", - "from_schema": "td", - "slots": [ - "@type", - "descriptions", - "securityScheme__description", - "securityScheme__proxy", - "securityScheme__scheme" - ], - "slot_usage": {}, - "attributes": [ - { - "name": "description", - "@type": "SlotDefinition" - }, - { - "name": "proxy", - "description": "URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint.", - "range": "anyUri", - "@type": "SlotDefinition" - }, - { - "name": "scheme", - "range": "SecuritySchemeType", - "required": true, - "@type": "SlotDefinition" - } - ], - "class_uri": "https://www.w3.org/2019/wot/td#SecurityScheme", - "@type": "ClassDefinition" - }, - { - "name": "DataSchema", - "definition_uri": "https://www.w3.org/2019/wot/td#DataSchema", - "description": "Metadata that describes the data format used. It can be used for validation.", - "from_schema": "td", - "mappings": [ - "jsonschema:DataSchema" - ], - "slots": [ - "description", - "title", - "titleInLanguage", - "descriptionInLanguage", - "dataSchema__propertyName", - "dataSchema__writeOnly", - "dataSchema__readonly" - ], - "slot_usage": {}, - "attributes": [ - { - "name": "propertyName", - "description": "Used to store the indexing name in the parent object when this schema appears as a property of an object schema.", - "@type": "SlotDefinition" - }, - { - "name": "writeOnly", - "description": "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false).", - "@type": "SlotDefinition" - }, - { - "name": "readonly", - "description": "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false).", - "@type": "SlotDefinition" - } - ], - "class_uri": "https://www.w3.org/2019/wot/json-schema#DataSchema", - "@type": "ClassDefinition" - }, - { - "name": "InteractionAffordance", - "definition_uri": "https://www.w3.org/2019/wot/td#InteractionAffordance", - "description": "TOOD", - "from_schema": "td", - "mappings": [ - "td:InteractionAffordance" - ], - "slots": [ - "titles", - "descriptions", - "title", - "description", - "titleInLanguage", - "descriptionInLanguage", - "interactionAffordance__name", - "interactionAffordance__uriVariables", - "interactionAffordance__forms" - ], - "slot_usage": {}, - "attributes": [ - { - "name": "name", - "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", - "identifier": true, - "@type": "SlotDefinition" - }, - { - "name": "uriVariables", - "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", - "from_schema": "td:hasUriTemplateSchema", - "multivalued": true, - "range": "DataSchema", - "@type": "SlotDefinition" - }, - { - "name": "forms", - "description": "Set of form hypermedia controls that describe how an operation can be performed.", - "from_schema": "td:hasForm", - "multivalued": true, - "range": "Form", - "@type": "SlotDefinition" - } - ], - "class_uri": "https://www.w3.org/2019/wot/td#InteractionAffordance", - "@type": "ClassDefinition" - }, - { - "name": "PropertyAffordance", - "definition_uri": "https://www.w3.org/2019/wot/td#PropertyAffordance", - "description": "An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated.", - "from_schema": "td", - "mappings": [ - "td:PropertyAffordance" - ], - "is_a": "InteractionAffordance", - "mixins": [ - "DataSchema" - ], - "slots": [ - "titles", - "descriptions", - "title", - "description", - "titleInLanguage", - "descriptionInLanguage", - "interactionAffordance__name", - "interactionAffordance__uriVariables", - "interactionAffordance__forms", - "propertyAffordance__observable", - "dataSchema__propertyName", - "dataSchema__writeOnly", - "dataSchema__readonly" - ], - "slot_usage": {}, - "attributes": [ - { - "name": "observable", - "description": "A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property.", - "range": "boolean", - "@type": "SlotDefinition" - } - ], - "class_uri": "https://www.w3.org/2019/wot/td#PropertyAffordance", - "@type": "ClassDefinition" - }, - { - "name": "ActionAffordance", - "definition_uri": "https://www.w3.org/2019/wot/td#ActionAffordance", - "description": "An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time).", - "from_schema": "td", - "mappings": [ - "td:ActionAffordance" - ], - "is_a": "InteractionAffordance", - "slots": [ - "titles", - "descriptions", - "title", - "description", - "titleInLanguage", - "descriptionInLanguage", - "interactionAffordance__name", - "interactionAffordance__uriVariables", - "interactionAffordance__forms", - "actionAffordance__safe", - "actionAffordance__synchronous", - "actionAffordance__idempotent", - "actionAffordance__input", - "actionAffordance__output" - ], - "slot_usage": {}, - "attributes": [ - { - "name": "safe", - "description": "Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action.", - "from_schema": "td:isSafe", - "range": "boolean", - "@type": "SlotDefinition" - }, - { - "name": "synchronous", - "description": "Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made.", - "from_schema": "td:isSynchronous", - "range": "boolean", - "@type": "SlotDefinition" - }, - { - "name": "idempotent", - "description": "Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input.", - "from_schema": "td:isIdempotent", - "range": "boolean", - "@type": "SlotDefinition" - }, - { - "name": "input", - "description": "Used to define the input data schema of the action.", - "from_schema": "td:hasInputSchema", - "range": "DataSchema", - "@type": "SlotDefinition" - }, - { - "name": "output", - "description": "Used to define the output data schema of the action.", - "from_schema": "td:hasOutputSchema", - "range": "DataSchema", - "@type": "SlotDefinition" - } - ], - "class_uri": "https://www.w3.org/2019/wot/td#ActionAffordance", - "@type": "ClassDefinition" - }, - { - "name": "EventAffordance", - "definition_uri": "https://www.w3.org/2019/wot/td#EventAffordance", - "description": "An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts).", - "from_schema": "td", - "mappings": [ - "td:EventAffordance" - ], - "is_a": "InteractionAffordance", - "slots": [ - "titles", - "descriptions", - "title", - "description", - "titleInLanguage", - "descriptionInLanguage", - "interactionAffordance__name", - "interactionAffordance__uriVariables", - "interactionAffordance__forms", - "eventAffordance__subscription", - "eventAffordance__cancellation", - "eventAffordance__notification", - "eventAffordance__notificationResponse" - ], - "slot_usage": {}, - "attributes": [ - { - "name": "subscription", - "description": "Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks.", - "from_schema": "td:hasSubscriptionSchema", - "range": "DataSchema", - "@type": "SlotDefinition" - }, - { - "name": "cancellation", - "description": "Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook.", - "from_schema": "td:hasCancellationSchema", - "range": "DataSchema", - "@type": "SlotDefinition" - }, - { - "name": "notification", - "description": "Defines the data schema of the Event instance messages pushed by the Thing.", - "from_schema": "td:hasNotificationSchema", - "range": "DataSchema", - "@type": "SlotDefinition" - }, - { - "name": "notificationResponse", - "description": "Defines the data schema of the Event response messages sent by the consumer in a response to a data message.", - "from_schema": "td:hasNotificationResponseSchema", - "range": "DataSchema", - "@type": "SlotDefinition" - } - ], - "class_uri": "https://www.w3.org/2019/wot/td#EventAffordance", - "@type": "ClassDefinition" - }, - { - "name": "Thing", - "definition_uri": "https://www.w3.org/2019/wot/td#Thing", - "description": "An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things.", - "from_schema": "td", - "mappings": [ - "td:Thing" - ], - "slots": [ - "id", - "title", - "description", - "titles", - "descriptions", - "@type", - "titleInLanguage", - "descriptionInLanguage", - "thing__securityDefinitions", - "thing__security", - "thing__schemaDefinitions", - "thing__profile", - "thing__instance", - "thing__created", - "thing__modified", - "thing__supportContact", - "thing__base", - "thing__version", - "thing__forms", - "thing__links", - "thing__properties", - "thing__actions", - "thing__events" - ], - "slot_usage": {}, - "attributes": [ - { - "name": "securityDefinitions", - "description": "A security scheme applied to a (set of) affordance(s). TODO check", - "from_schema": "td:hasSecurityConfiguration", - "multivalued": true, - "any_of": [ - { - "range": "string", - "@type": "AnonymousSlotExpression" - }, - { - "range": "SecuritySchemeType", - "@type": "AnonymousSlotExpression" - } - ], - "@type": "SlotDefinition" - }, - { - "name": "security", - "description": "A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check", - "from_schema": "td:definesSecurityScheme", - "multivalued": true, - "@type": "SlotDefinition" - }, - { - "name": "schemaDefinitions", - "description": "TODO CHECK", - "multivalued": true, - "range": "DataSchema", - "@type": "SlotDefinition" - }, - { - "name": "profile", - "description": "Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation.", - "from_schema": "td:followsProfile", - "multivalued": true, - "range": "anyUri", - "@type": "SlotDefinition" - }, - { - "name": "instance", - "description": "Provides a version identicator of this TD instance.", - "@type": "SlotDefinition" - }, - { - "name": "created", - "description": "Provides information when the TD instance was created.", - "from_schema": "dcterms", - "range": "datetime", - "@type": "SlotDefinition" - }, - { - "name": "modified", - "description": "Provides information when the TD instance was last modified.", - "from_schema": "dcterms", - "range": "datetime", - "@type": "SlotDefinition" - }, - { - "name": "supportContact", - "description": "Provides information about the TD maintainer as URI scheme (e.g., mailto [[RFC6068]],tel [[RFC3966]],https [[RFC9112]]).", - "from_schema": "schema:contactPoint", - "range": "anyUri", - "@type": "SlotDefinition" - }, - { - "name": "base", - "description": "Define the base URI that is used for all relative URI references throughout a TD document.", - "from_schema": "td:baseURI", - "range": "anyUri", - "@type": "SlotDefinition" - }, - { - "name": "version", - "range": "VersionInfo", - "@type": "SlotDefinition" - }, - { - "name": "forms", - "description": "Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings.", - "from_schema": "td:hasForm", - "multivalued": true, - "range": "Form", - "@type": "SlotDefinition" - }, - { - "name": "links", - "description": "Provides Web links to arbitrary resources that relate to the specified Thing Description.", - "from_schema": "td:hasLink", - "multivalued": true, - "range": "Link", - "@type": "SlotDefinition" - }, - { - "name": "properties", - "description": "All Property-based interaction affordances of the Thing.", - "from_schema": "td:hasPropertyAffordance", - "multivalued": true, - "range": "PropertyAffordance", - "inlined": true, - "@type": "SlotDefinition" - }, - { - "name": "actions", - "description": "All Action-based interaction affordances of the Thing.", - "from_schema": "td:hasActionAffordance", - "multivalued": true, - "range": "ActionAffordance", - "inlined": true, - "@type": "SlotDefinition" - }, - { - "name": "events", - "description": "All Event-based interaction affordances of the Thing.", - "from_schema": "td:hasEventAffordance", - "multivalued": true, - "range": "EventAffordance", - "inlined": true, - "@type": "SlotDefinition" - } - ], - "class_uri": "https://www.w3.org/2019/wot/td#Thing", - "@type": "ClassDefinition" - } - ], - "metamodel_version": "1.7.0", - "source_file": "thing_description_schema.yaml", - "source_file_date": "2024-04-17T16:50:22", - "source_file_size": 24228, - "generation_date": "2024-05-21T15:16:14", - "@type": "SchemaDefinition", - "@context": [ - "resources/gens/jsonld/thing_description_schema.context.jsonld", - "https://w3id.org/linkml/types.context.jsonld", - { - "@base": "https://www.w3.org/2019/wot/td#" - } - ] -} diff --git a/resources/gens/jsonschema/thing_description_schema.schema.json b/resources/gens/jsonschema/thing_description_schema.schema.json deleted file mode 100644 index debbbce..0000000 --- a/resources/gens/jsonschema/thing_description_schema.schema.json +++ /dev/null @@ -1,1086 +0,0 @@ -{ - "$defs": { - "ActionAffordance": { - "additionalProperties": false, - "description": "An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time).", - "properties": { - "description": { - "type": "string" - }, - "descriptionInLanguage": { - "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "descriptions": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "description": "TODO, check, according to the description a description should not contain a lang tag.", - "type": "object" - }, - "forms": { - "description": "Set of form hypermedia controls that describe how an operation can be performed.", - "items": { - "$ref": "#/$defs/Form" - }, - "type": "array" - }, - "idempotent": { - "description": "Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input.", - "type": "boolean" - }, - "input": { - "$ref": "#/$defs/DataSchema", - "description": "Used to define the input data schema of the action." - }, - "name": { - "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", - "type": "string" - }, - "output": { - "$ref": "#/$defs/DataSchema", - "description": "Used to define the output data schema of the action." - }, - "safe": { - "description": "Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action.", - "type": "boolean" - }, - "synchronous": { - "description": "Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made.", - "type": "boolean" - }, - "title": { - "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", - "type": "string" - }, - "titleInLanguage": { - "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "titles": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "type": "object" - }, - "uriVariables": { - "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", - "items": { - "$ref": "#/$defs/DataSchema" - }, - "type": "array" - } - }, - "required": [ - "name" - ], - "title": "ActionAffordance", - "type": "object" - }, - "ActionAffordance__identifier_optional": { - "additionalProperties": false, - "description": "An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time).", - "properties": { - "description": { - "type": "string" - }, - "descriptionInLanguage": { - "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "descriptions": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "description": "TODO, check, according to the description a description should not contain a lang tag.", - "type": "object" - }, - "forms": { - "description": "Set of form hypermedia controls that describe how an operation can be performed.", - "items": { - "$ref": "#/$defs/Form" - }, - "type": "array" - }, - "idempotent": { - "description": "Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input.", - "type": "boolean" - }, - "input": { - "$ref": "#/$defs/DataSchema", - "description": "Used to define the input data schema of the action." - }, - "name": { - "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", - "type": "string" - }, - "output": { - "$ref": "#/$defs/DataSchema", - "description": "Used to define the output data schema of the action." - }, - "safe": { - "description": "Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action.", - "type": "boolean" - }, - "synchronous": { - "description": "Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made.", - "type": "boolean" - }, - "title": { - "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", - "type": "string" - }, - "titleInLanguage": { - "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "titles": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "type": "object" - }, - "uriVariables": { - "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", - "items": { - "$ref": "#/$defs/DataSchema" - }, - "type": "array" - } - }, - "required": [], - "title": "ActionAffordance", - "type": "object" - }, - "AdditionalExpectedResponse": { - "additionalProperties": false, - "description": "Communication metadata describing the expected response message for additional responses.", - "properties": { - "additionalOutputSchema": { - "description": "This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used.", - "type": "string" - }, - "contentType": { - "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", - "type": "string" - }, - "schema": { - "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", - "type": "string" - }, - "success": { - "description": "Signals if the additional response should not be considered an error.", - "type": "boolean" - } - }, - "required": [ - "contentType" - ], - "title": "AdditionalExpectedResponse", - "type": "object" - }, - "DataSchema": { - "additionalProperties": false, - "description": "Metadata that describes the data format used. It can be used for validation.", - "properties": { - "description": { - "type": "string" - }, - "descriptionInLanguage": { - "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "propertyName": { - "description": "Used to store the indexing name in the parent object when this schema appears as a property of an object schema.", - "type": "string" - }, - "readonly": { - "description": "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false).", - "type": "string" - }, - "title": { - "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", - "type": "string" - }, - "titleInLanguage": { - "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "writeOnly": { - "description": "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false).", - "type": "string" - } - }, - "title": "DataSchema", - "type": "object" - }, - "EventAffordance": { - "additionalProperties": false, - "description": "An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts).", - "properties": { - "cancellation": { - "$ref": "#/$defs/DataSchema", - "description": "Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook." - }, - "description": { - "type": "string" - }, - "descriptionInLanguage": { - "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "descriptions": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "description": "TODO, check, according to the description a description should not contain a lang tag.", - "type": "object" - }, - "forms": { - "description": "Set of form hypermedia controls that describe how an operation can be performed.", - "items": { - "$ref": "#/$defs/Form" - }, - "type": "array" - }, - "name": { - "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", - "type": "string" - }, - "notification": { - "$ref": "#/$defs/DataSchema", - "description": "Defines the data schema of the Event instance messages pushed by the Thing." - }, - "notificationResponse": { - "$ref": "#/$defs/DataSchema", - "description": "Defines the data schema of the Event response messages sent by the consumer in a response to a data message." - }, - "subscription": { - "$ref": "#/$defs/DataSchema", - "description": "Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks." - }, - "title": { - "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", - "type": "string" - }, - "titleInLanguage": { - "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "titles": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "type": "object" - }, - "uriVariables": { - "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", - "items": { - "$ref": "#/$defs/DataSchema" - }, - "type": "array" - } - }, - "required": [ - "name" - ], - "title": "EventAffordance", - "type": "object" - }, - "EventAffordance__identifier_optional": { - "additionalProperties": false, - "description": "An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts).", - "properties": { - "cancellation": { - "$ref": "#/$defs/DataSchema", - "description": "Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook." - }, - "description": { - "type": "string" - }, - "descriptionInLanguage": { - "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "descriptions": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "description": "TODO, check, according to the description a description should not contain a lang tag.", - "type": "object" - }, - "forms": { - "description": "Set of form hypermedia controls that describe how an operation can be performed.", - "items": { - "$ref": "#/$defs/Form" - }, - "type": "array" - }, - "name": { - "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", - "type": "string" - }, - "notification": { - "$ref": "#/$defs/DataSchema", - "description": "Defines the data schema of the Event instance messages pushed by the Thing." - }, - "notificationResponse": { - "$ref": "#/$defs/DataSchema", - "description": "Defines the data schema of the Event response messages sent by the consumer in a response to a data message." - }, - "subscription": { - "$ref": "#/$defs/DataSchema", - "description": "Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks." - }, - "title": { - "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", - "type": "string" - }, - "titleInLanguage": { - "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "titles": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "type": "object" - }, - "uriVariables": { - "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", - "items": { - "$ref": "#/$defs/DataSchema" - }, - "type": "array" - } - }, - "required": [], - "title": "EventAffordance", - "type": "object" - }, - "ExpectedResponse": { - "additionalProperties": false, - "description": "Communication metadata describing the expected response message for the primary response.", - "properties": { - "contentType": { - "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", - "type": "string" - } - }, - "required": [ - "contentType" - ], - "title": "ExpectedResponse", - "type": "object" - }, - "Form": { - "additionalProperties": false, - "description": "A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions.", - "properties": { - "additionalReturns": { - "description": "This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema.", - "items": { - "$ref": "#/$defs/AdditionalExpectedResponse" - }, - "type": "array" - }, - "contentCoding": { - "description": "Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \\\"gzip\\\", \\\"deflate\\\", etc.", - "type": "string" - }, - "contentType": { - "description": "Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type.", - "type": "string" - }, - "href": { - "type": "string" - }, - "operationType": { - "description": "Indicates the semantic intention of performing the operation(s) described by the form.", - "items": { - "$ref": "#/$defs/OperationTypes" - }, - "type": "array" - }, - "returns": { - "$ref": "#/$defs/ExpectedResponse", - "description": "This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages." - }, - "scopes": { - "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", - "type": "string" - }, - "securityDefinitions": { - "description": "A security schema applied to a (set of) affordance(s).", - "type": "string" - }, - "subprotocol": { - "description": "Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options.", - "type": "string" - }, - "target": { - "description": "Target IRI of a link or submission target of a Form", - "type": "string" - } - }, - "required": [ - "target", - "href" - ], - "title": "Form", - "type": "object" - }, - "InteractionAffordance": { - "additionalProperties": false, - "description": "TOOD", - "properties": { - "description": { - "type": "string" - }, - "descriptionInLanguage": { - "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "descriptions": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "description": "TODO, check, according to the description a description should not contain a lang tag.", - "type": "object" - }, - "forms": { - "description": "Set of form hypermedia controls that describe how an operation can be performed.", - "items": { - "$ref": "#/$defs/Form" - }, - "type": "array" - }, - "name": { - "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", - "type": "string" - }, - "title": { - "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", - "type": "string" - }, - "titleInLanguage": { - "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "titles": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "type": "object" - }, - "uriVariables": { - "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", - "items": { - "$ref": "#/$defs/DataSchema" - }, - "type": "array" - } - }, - "required": [ - "name" - ], - "title": "InteractionAffordance", - "type": "object" - }, - "Link": { - "additionalProperties": false, - "description": "A link can be viewed as a statement of the form link context that has a relation type resource at link target\", where the optional target attributes may further describe the resource.", - "properties": { - "anchor": { - "description": "By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI.", - "type": "string" - }, - "hintsAtMediaType": { - "description": "Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be.", - "type": "string" - }, - "hreflang": { - "description": "The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]].", - "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", - "type": "string" - }, - "relation": { - "description": "A link relation type identifies the semantics of a link.", - "type": "string" - }, - "sizes": { - "description": "Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \\\"16x16\\\", \\\"16x16 32x32\\\").", - "type": "string" - }, - "target": { - "description": "Target IRI of a link or submission target of a Form", - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "target" - ], - "title": "Link", - "type": "object" - }, - "MultiLanguage": { - "additionalProperties": false, - "description": "", - "properties": { - "key": { - "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", - "type": "string" - } - }, - "required": [ - "key" - ], - "title": "MultiLanguage", - "type": "object" - }, - "MultiLanguage__identifier_optional": { - "additionalProperties": false, - "description": "", - "properties": { - "key": { - "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", - "type": "string" - } - }, - "required": [], - "title": "MultiLanguage", - "type": "object" - }, - "OperationTypes": { - "description": "Enumerations of well-known operation types necessary to implement the WoT interaction model.", - "enum": [ - "readproperty", - "writeproperty", - "observeproperty", - "unobserveproperty", - "invokeaction", - "queryaction", - "cancelaction", - "subscribeevent", - "unsubscribeevent", - "readallproperties", - "writeallproperties", - "readmultipleproperties", - "writemultipleproperties", - "observeallproperties", - "unobserveallproperties", - "subscribeallevents", - "unsubscribeallevents", - "queryallactions" - ], - "title": "OperationTypes", - "type": "string" - }, - "PropertyAffordance": { - "additionalProperties": false, - "description": "An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated.", - "properties": { - "description": { - "type": "string" - }, - "descriptionInLanguage": { - "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "descriptions": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "description": "TODO, check, according to the description a description should not contain a lang tag.", - "type": "object" - }, - "forms": { - "description": "Set of form hypermedia controls that describe how an operation can be performed.", - "items": { - "$ref": "#/$defs/Form" - }, - "type": "array" - }, - "name": { - "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", - "type": "string" - }, - "observable": { - "description": "A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property.", - "type": "boolean" - }, - "propertyName": { - "description": "Used to store the indexing name in the parent object when this schema appears as a property of an object schema.", - "type": "string" - }, - "readonly": { - "description": "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false).", - "type": "string" - }, - "title": { - "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", - "type": "string" - }, - "titleInLanguage": { - "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "titles": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "type": "object" - }, - "uriVariables": { - "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", - "items": { - "$ref": "#/$defs/DataSchema" - }, - "type": "array" - }, - "writeOnly": { - "description": "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false).", - "type": "string" - } - }, - "required": [ - "name" - ], - "title": "PropertyAffordance", - "type": "object" - }, - "PropertyAffordance__identifier_optional": { - "additionalProperties": false, - "description": "An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated.", - "properties": { - "description": { - "type": "string" - }, - "descriptionInLanguage": { - "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "descriptions": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "description": "TODO, check, according to the description a description should not contain a lang tag.", - "type": "object" - }, - "forms": { - "description": "Set of form hypermedia controls that describe how an operation can be performed.", - "items": { - "$ref": "#/$defs/Form" - }, - "type": "array" - }, - "name": { - "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", - "type": "string" - }, - "observable": { - "description": "A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property.", - "type": "boolean" - }, - "propertyName": { - "description": "Used to store the indexing name in the parent object when this schema appears as a property of an object schema.", - "type": "string" - }, - "readonly": { - "description": "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false).", - "type": "string" - }, - "title": { - "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", - "type": "string" - }, - "titleInLanguage": { - "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "titles": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "type": "object" - }, - "uriVariables": { - "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", - "items": { - "$ref": "#/$defs/DataSchema" - }, - "type": "array" - }, - "writeOnly": { - "description": "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false).", - "type": "string" - } - }, - "required": [], - "title": "PropertyAffordance", - "type": "object" - }, - "SecurityScheme": { - "additionalProperties": false, - "description": "", - "properties": { - "@type": { - "items": { - "type": "string" - }, - "type": "array" - }, - "description": { - "type": "string" - }, - "descriptions": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "description": "TODO, check, according to the description a description should not contain a lang tag.", - "type": "object" - }, - "proxy": { - "description": "URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint.", - "type": "string" - }, - "scheme": { - "$ref": "#/$defs/SecuritySchemeType" - } - }, - "required": [ - "scheme" - ], - "title": "SecurityScheme", - "type": "object" - }, - "SecuritySchemeType": { - "description": "", - "enum": [ - "nosec", - "combo", - "basic", - "digest", - "bearer", - "psk", - "oauth2", - "apikey", - "auto" - ], - "title": "SecuritySchemeType", - "type": "string" - }, - "Thing": { - "additionalProperties": false, - "description": "An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things.", - "properties": { - "@type": { - "items": { - "type": "string" - }, - "type": "array" - }, - "actions": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/ActionAffordance__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "description": "All Action-based interaction affordances of the Thing.", - "type": "object" - }, - "base": { - "description": "Define the base URI that is used for all relative URI references throughout a TD document.", - "type": "string" - }, - "created": { - "description": "Provides information when the TD instance was created.", - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "descriptionInLanguage": { - "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "descriptions": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "description": "TODO, check, according to the description a description should not contain a lang tag.", - "type": "object" - }, - "events": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/EventAffordance__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "description": "All Event-based interaction affordances of the Thing.", - "type": "object" - }, - "forms": { - "description": "Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings.", - "items": { - "$ref": "#/$defs/Form" - }, - "type": "array" - }, - "id": { - "description": "TODO", - "type": "string" - }, - "instance": { - "description": "Provides a version identicator of this TD instance.", - "type": "string" - }, - "links": { - "description": "Provides Web links to arbitrary resources that relate to the specified Thing Description.", - "items": { - "$ref": "#/$defs/Link" - }, - "type": "array" - }, - "modified": { - "description": "Provides information when the TD instance was last modified.", - "format": "date-time", - "type": "string" - }, - "profile": { - "description": "Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation.", - "items": { - "type": "string" - }, - "type": "array" - }, - "properties": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/PropertyAffordance__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "description": "All Property-based interaction affordances of the Thing.", - "type": "object" - }, - "schemaDefinitions": { - "description": "TODO CHECK", - "items": { - "$ref": "#/$defs/DataSchema" - }, - "type": "array" - }, - "security": { - "description": "A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check", - "items": { - "type": "string" - }, - "type": "array" - }, - "securityDefinitions": { - "description": "A security scheme applied to a (set of) affordance(s). TODO check", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "$ref": "#/$defs/SecuritySchemeType" - } - ], - "type": "string" - }, - "type": "array" - }, - "supportContact": { - "description": "Provides information about the TD maintainer as URI scheme (e.g., mailto [[RFC6068]],tel [[RFC3966]],https [[RFC9112]]).", - "type": "string" - }, - "title": { - "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", - "type": "string" - }, - "titleInLanguage": { - "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", - "type": "string" - }, - "titles": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/$defs/MultiLanguage__identifier_optional" - }, - { - "type": "null" - } - ] - }, - "type": "object" - }, - "version": { - "$ref": "#/$defs/VersionInfo" - } - }, - "required": [ - "id" - ], - "title": "Thing", - "type": "object" - }, - "VersionInfo": { - "additionalProperties": false, - "description": "Provides version information.", - "properties": { - "instance": { - "type": "string" - }, - "model": { - "type": "string" - } - }, - "required": [ - "instance" - ], - "title": "VersionInfo", - "type": "object" - } - }, - "$id": "td", - "$schema": "https://json-schema.org/draft/2019-09/schema", - "additionalProperties": true, - "metamodel_version": "1.7.0", - "title": "thing-description-schema", - "type": "object", - "version": null -} \ No newline at end of file diff --git a/resources/gens/owl/thing_description_schema.owl.ttl b/resources/gens/owl/thing_description_schema.owl.ttl deleted file mode 100644 index 9c3d9f6..0000000 --- a/resources/gens/owl/thing_description_schema.owl.ttl +++ /dev/null @@ -1,1287 +0,0 @@ -@prefix dct: . -@prefix hctl: . -@prefix jsonschema: . -@prefix linkml: . -@prefix owl: . -@prefix rdf: . -@prefix rdfs: . -@prefix schema1: . -@prefix skos: . -@prefix td: . -@prefix wotsec: . -@prefix xsd: . - -td:SecurityScheme a owl:Class, - linkml:ClassDefinition ; - rdfs:label "SecurityScheme" ; - rdfs:subClassOf [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:proxy ], - [ a owl:Restriction ; - owl:minCardinality 1 ; - owl:onProperty td:scheme ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:description ], - [ a owl:Restriction ; - owl:allValuesFrom td:SecuritySchemeType ; - owl:onProperty td:scheme ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:descriptions ], - [ a owl:Restriction ; - owl:allValuesFrom td:anyUri ; - owl:onProperty td:proxy ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:descriptions ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty ], - [ a owl:Restriction ; - owl:allValuesFrom owl:Thing ; - owl:onProperty td:description ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:proxy ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:description ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:scheme ] ; - skos:inScheme . - -linkml:topValue a owl:DatatypeProperty ; - rdfs:label "value" . - -td:AdditionalExpectedResponse a owl:Class, - linkml:ClassDefinition ; - rdfs:label "AdditionalExpectedResponse" ; - rdfs:subClassOf [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:additionalOutputSchema ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:schema ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:schema ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:success ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:additionalOutputSchema ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:additionalOutputSchema ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:schema ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:success ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:Boolean ; - owl:onProperty td:success ], - td:ExpectedResponse ; - skos:definition "Communication metadata describing the expected response message for additional responses." ; - skos:exactMatch hctl:AdditionalExpectedResponse ; - skos:inScheme . - -td:Link a owl:Class, - linkml:ClassDefinition ; - rdfs:label "Link" ; - rdfs:subClassOf [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:sizes ], - [ a owl:Restriction ; - owl:minCardinality 1 ; - owl:onProperty td:target ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:relation ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:type ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:type ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:relation ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:hreflang ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:hintsAtMediaType ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:target ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:type ], - [ a owl:Restriction ; - owl:allValuesFrom td:anyUri ; - owl:onProperty td:anchor ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:sizes ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:relation ], - [ a owl:Restriction ; - owl:allValuesFrom td:anyUri ; - owl:onProperty td:target ], - [ a owl:Restriction ; - owl:allValuesFrom [ a rdfs:Datatype ; - owl:onDatatype xsd:string ; - owl:withRestrictions ( [ xsd:pattern "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$" ] ) ] ; - owl:onProperty td:hreflang ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:hintsAtMediaType ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:sizes ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:hreflang ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:anchor ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:hintsAtMediaType ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:anchor ] ; - skos:definition "A link can be viewed as a statement of the form link context that has a relation type resource at link target\", where the optional target attributes may further describe the resource." ; - skos:exactMatch hctl:Link ; - skos:inScheme . - -td:Thing a owl:Class, - linkml:ClassDefinition ; - rdfs:label "Thing" ; - rdfs:subClassOf [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:titles ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:version ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:Datetime ; - owl:onProperty td:created ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:security ], - [ a owl:Restriction ; - owl:allValuesFrom td:Link ; - owl:onProperty td:links ], - [ a owl:Restriction ; - owl:allValuesFrom td:DataSchema ; - owl:onProperty td:schemaDefinitions ], - [ a owl:Restriction ; - owl:allValuesFrom [ a rdfs:Datatype ; - owl:unionOf ( linkml:String td:SecuritySchemeType ) ] ; - owl:onProperty td:securityDefinitions ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:events ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:security ], - [ a owl:Restriction ; - owl:allValuesFrom td:anyUri ; - owl:onProperty td:id ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:forms ], - [ a owl:Restriction ; - owl:allValuesFrom td:ActionAffordance ; - owl:onProperty td:actions ], - [ a owl:Restriction ; - owl:allValuesFrom td:EventAffordance ; - owl:onProperty td:events ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:description ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:created ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:instance ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:base ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty ], - [ a owl:Restriction ; - owl:allValuesFrom td:Form ; - owl:onProperty td:forms ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:instance ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:titleInLanguage ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:id ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:titles ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty ], - [ a owl:Restriction ; - owl:allValuesFrom td:anyUri ; - owl:onProperty td:supportContact ], - [ a owl:Restriction ; - owl:allValuesFrom td:PropertyAffordance ; - owl:onProperty td:properties ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:base ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:descriptions ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:supportContact ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:created ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:description ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:descriptionInLanguage ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:version ], - [ a owl:Restriction ; - owl:allValuesFrom td:anyUri ; - owl:onProperty td:base ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:properties ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:title ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:securityDefinitions ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:title ], - [ a owl:Restriction ; - owl:minCardinality 1 ; - owl:onProperty td:id ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:description ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:modified ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:title ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:titleInLanguage ], - [ a owl:Restriction ; - owl:allValuesFrom td:anyUri ; - owl:onProperty td:profile ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:profile ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:instance ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:links ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:descriptionInLanguage ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:Datetime ; - owl:onProperty td:modified ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:modified ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:supportContact ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:schemaDefinitions ], - [ a owl:Restriction ; - owl:allValuesFrom td:VersionInfo ; - owl:onProperty td:version ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:actions ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:descriptions ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:titleInLanguage ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:descriptionInLanguage ] ; - skos:definition "An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things." ; - skos:exactMatch td:Thing ; - skos:inScheme . - -td:VersionInfo a owl:Class, - linkml:ClassDefinition ; - rdfs:label "VersionInfo" ; - rdfs:subClassOf [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:instance ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:model ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:model ], - [ a owl:Restriction ; - owl:minCardinality 1 ; - owl:onProperty td:instance ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:instance ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:model ] ; - skos:definition "Provides version information." ; - skos:exactMatch schema1:version ; - skos:inScheme . - -wotsec:APIKeySecurityScheme a owl:Class, - td:SecuritySchemeType ; - rdfs:label "apikey" ; - rdfs:subClassOf td:SecuritySchemeType . - -wotsec:AutoSecurityScheme a owl:Class, - td:SecuritySchemeType ; - rdfs:label "auto" ; - rdfs:subClassOf td:SecuritySchemeType . - -wotsec:BasicSecurityScheme a owl:Class, - td:SecuritySchemeType ; - rdfs:label "basic" ; - rdfs:subClassOf td:SecuritySchemeType . - -wotsec:BearerSecurityScheme a owl:Class, - td:SecuritySchemeType ; - rdfs:label "bearer" ; - rdfs:subClassOf td:SecuritySchemeType . - -wotsec:ComboSecurityScheme a owl:Class, - td:SecuritySchemeType ; - rdfs:label "combo" ; - rdfs:subClassOf td:SecuritySchemeType . - -wotsec:DigestSecurityScheme a owl:Class, - td:SecuritySchemeType ; - rdfs:label "digest" ; - rdfs:subClassOf td:SecuritySchemeType . - -wotsec:NoSecurityScheme a owl:Class, - td:SecuritySchemeType ; - rdfs:label "nosec" ; - rdfs:subClassOf td:SecuritySchemeType . - -wotsec:OAuth2SecurityScheme a owl:Class, - td:SecuritySchemeType ; - rdfs:label "oauth2" ; - rdfs:subClassOf td:SecuritySchemeType . - -wotsec:PSKSecurityScheme a owl:Class, - td:SecuritySchemeType ; - rdfs:label "psk" ; - rdfs:subClassOf td:SecuritySchemeType . - -td:ActionAffordance a owl:Class, - linkml:ClassDefinition ; - rdfs:label "ActionAffordance" ; - rdfs:subClassOf [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:input ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:Boolean ; - owl:onProperty td:synchronous ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:synchronous ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:output ], - [ a owl:Restriction ; - owl:allValuesFrom td:DataSchema ; - owl:onProperty td:output ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:safe ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:safe ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:synchronous ], - [ a owl:Restriction ; - owl:allValuesFrom td:DataSchema ; - owl:onProperty td:input ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:idempotent ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:output ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:idempotent ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:Boolean ; - owl:onProperty td:idempotent ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:input ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:Boolean ; - owl:onProperty td:safe ], - td:InteractionAffordance ; - skos:definition "An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time)." ; - skos:exactMatch td:ActionAffordance ; - skos:inScheme . - -td:EventAffordance a owl:Class, - linkml:ClassDefinition ; - rdfs:label "EventAffordance" ; - rdfs:subClassOf [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:notification ], - [ a owl:Restriction ; - owl:allValuesFrom td:DataSchema ; - owl:onProperty td:cancellation ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:subscription ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:notification ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:notificationResponse ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:cancellation ], - [ a owl:Restriction ; - owl:allValuesFrom td:DataSchema ; - owl:onProperty td:subscription ], - [ a owl:Restriction ; - owl:allValuesFrom td:DataSchema ; - owl:onProperty td:notification ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:cancellation ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:notificationResponse ], - [ a owl:Restriction ; - owl:allValuesFrom td:DataSchema ; - owl:onProperty td:notificationResponse ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:subscription ], - td:InteractionAffordance ; - skos:definition "An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts)." ; - skos:exactMatch td:EventAffordance ; - skos:inScheme . - -td:ExpectedResponse a owl:Class, - linkml:ClassDefinition ; - rdfs:label "ExpectedResponse" ; - rdfs:subClassOf [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:contentType ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:contentType ], - [ a owl:Restriction ; - owl:minCardinality 1 ; - owl:onProperty td:contentType ] ; - skos:definition "Communication metadata describing the expected response message for the primary response." ; - skos:exactMatch hctl:ExpectedResponse ; - skos:inScheme . - -td:Form a owl:Class, - linkml:ClassDefinition ; - rdfs:label "Form" ; - rdfs:subClassOf [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:subprotocol ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:scopes ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:subprotocol ], - [ a owl:Restriction ; - owl:allValuesFrom td:OperationTypes ; - owl:onProperty td:operationType ], - [ a owl:Restriction ; - owl:allValuesFrom td:anyUri ; - owl:onProperty td:target ], - [ a owl:Restriction ; - owl:allValuesFrom td:ExpectedResponse ; - owl:onProperty td:returns ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:securityDefinitions ], - [ a owl:Restriction ; - owl:minCardinality 1 ; - owl:onProperty td:href ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:contentType ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:target ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:scopes ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:operationType ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:contentType ], - [ a owl:Restriction ; - owl:minCardinality 1 ; - owl:onProperty td:target ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:securityDefinitions ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:additionalReturns ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:returns ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:contentType ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:contentCoding ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:contentCoding ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:returns ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:scopes ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:securityDefinitions ], - [ a owl:Restriction ; - owl:allValuesFrom td:anyUri ; - owl:onProperty td:href ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:href ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:contentCoding ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:subprotocol ], - [ a owl:Restriction ; - owl:allValuesFrom td:AdditionalExpectedResponse ; - owl:onProperty td:additionalReturns ] ; - skos:definition "A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions." ; - skos:exactMatch hctl:Form ; - skos:inScheme . - -td:PropertyAffordance a owl:Class, - linkml:ClassDefinition ; - rdfs:label "PropertyAffordance" ; - rdfs:subClassOf [ a owl:Restriction ; - owl:allValuesFrom linkml:Boolean ; - owl:onProperty td:observable ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:observable ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:observable ], - td:DataSchema, - td:InteractionAffordance ; - skos:definition "An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated." ; - skos:exactMatch td:PropertyAffordance ; - skos:inScheme . - -td:actions a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "actions" ; - skos:definition "All Action-based interaction affordances of the Thing." ; - skos:inScheme . - -td:additionalReturns a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "additionalReturns" ; - skos:definition "This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema." ; - skos:inScheme . - -td:cancelAction a owl:Class, - td:OperationTypes ; - rdfs:label "cancelaction" ; - rdfs:subClassOf td:OperationTypes . - -td:events a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "events" ; - skos:definition "All Event-based interaction affordances of the Thing." ; - skos:inScheme . - -td:invokeAction a owl:Class, - td:OperationTypes ; - rdfs:label "invokeaction" ; - rdfs:subClassOf td:OperationTypes . - -td:links a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "links" ; - skos:definition "Provides Web links to arbitrary resources that relate to the specified Thing Description." ; - skos:inScheme . - -td:observeAllProperties a owl:Class, - td:OperationTypes ; - rdfs:label "observeallproperties" ; - rdfs:subClassOf td:OperationTypes . - -td:observeProperty a owl:Class, - td:OperationTypes ; - rdfs:label "observeproperty" ; - rdfs:subClassOf td:OperationTypes . - -td:operationType a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "operationType" ; - skos:definition "Indicates the semantic intention of performing the operation(s) described by the form." ; - skos:inScheme . - -td:profile a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "profile" ; - skos:definition "Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation." ; - skos:inScheme . - -td:properties a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "properties" ; - skos:definition "All Property-based interaction affordances of the Thing." ; - skos:inScheme . - -td:queryAction a owl:Class, - td:OperationTypes ; - rdfs:label "queryaction" ; - rdfs:subClassOf td:OperationTypes . - -td:queryAllActions a owl:Class, - td:OperationTypes ; - rdfs:label "queryallactions" ; - rdfs:subClassOf td:OperationTypes . - -td:readAllProperties a owl:Class, - td:OperationTypes ; - rdfs:label "readallproperties" ; - rdfs:subClassOf td:OperationTypes . - -td:readMultipleProperties a owl:Class, - td:OperationTypes ; - rdfs:label "readmultipleproperties" ; - rdfs:subClassOf td:OperationTypes . - -td:readProperty a owl:Class, - td:OperationTypes ; - rdfs:label "readproperty" ; - rdfs:subClassOf td:OperationTypes . - -td:schemaDefinitions a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "schemaDefinitions" ; - skos:definition "TODO CHECK" ; - skos:inScheme . - -td:security a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "security" ; - skos:definition "A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check" ; - skos:inScheme . - -td:subscribeAllEvents a owl:Class, - td:OperationTypes ; - rdfs:label "subscribeallevents" ; - rdfs:subClassOf td:OperationTypes . - -td:subscribeEvent a owl:Class, - td:OperationTypes ; - rdfs:label "subscribeevent" ; - rdfs:subClassOf td:OperationTypes . - -td:unobserveAllProperties a owl:Class, - td:OperationTypes ; - rdfs:label "unobserveallproperties" ; - rdfs:subClassOf td:OperationTypes . - -td:unobserveProperty a owl:Class, - td:OperationTypes ; - rdfs:label "unobserveproperty" ; - rdfs:subClassOf td:OperationTypes . - -td:unsubscribeAllEvents a owl:Class, - td:OperationTypes ; - rdfs:label "unsubscribeallevents" ; - rdfs:subClassOf td:OperationTypes . - -td:unsubscribeEvent a owl:Class, - td:OperationTypes ; - rdfs:label "unsubscribeevent" ; - rdfs:subClassOf td:OperationTypes . - -td:uriVariables a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "uriVariables" ; - skos:definition "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology." ; - skos:inScheme . - -td:writeMultipleProperties a owl:Class, - td:OperationTypes ; - rdfs:label "writemultipleproperties" ; - rdfs:subClassOf td:OperationTypes . - -td:writeProperty a owl:Class, - td:OperationTypes ; - rdfs:label "writeproperty" ; - rdfs:subClassOf td:OperationTypes . - - a owl:Class, - td:OperationTypes ; - rdfs:label "writeallproperties" ; - rdfs:subClassOf td:OperationTypes . - -td:additionalOutputSchema a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "additionalOutputSchema" ; - skos:definition "This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used." ; - skos:inScheme . - -td:anchor a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "anchor" ; - skos:definition "By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI." ; - skos:inScheme . - -td:base a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "base" ; - skos:definition "Define the base URI that is used for all relative URI references throughout a TD document." ; - skos:inScheme . - -td:cancellation a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "cancellation" ; - skos:definition "Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook." ; - skos:inScheme . - -td:contentCoding a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "contentCoding" ; - skos:definition "Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \\\"gzip\\\", \\\"deflate\\\", etc." ; - skos:inScheme . - -td:created a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "created" ; - skos:definition "Provides information when the TD instance was created." ; - skos:inScheme . - -td:hintsAtMediaType a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "hintsAtMediaType" ; - skos:definition "Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be." ; - skos:inScheme . - -td:href a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "href" ; - skos:inScheme . - -td:hreflang a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "hreflang" ; - skos:definition "The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]." ; - skos:inScheme . - -td:id a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "id" ; - rdfs:range td:anyUri ; - skos:definition "TODO" ; - skos:inScheme . - -td:idempotent a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "idempotent" ; - skos:definition "Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input." ; - skos:inScheme . - -td:input a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "input" ; - skos:definition "Used to define the input data schema of the action." ; - skos:inScheme . - -td:key a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "key" ; - skos:inScheme . - -td:model a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "model" ; - skos:inScheme . - -td:modified a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "modified" ; - skos:definition "Provides information when the TD instance was last modified." ; - skos:inScheme . - -td:name a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "name" ; - skos:definition "Indexing property to store entity names when serializing them in a JSON-LD @index container." ; - skos:inScheme . - -td:notification a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "notification" ; - skos:definition "Defines the data schema of the Event instance messages pushed by the Thing." ; - skos:inScheme . - -td:notificationResponse a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "notificationResponse" ; - skos:definition "Defines the data schema of the Event response messages sent by the consumer in a response to a data message." ; - skos:inScheme . - -td:observable a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "observable" ; - skos:definition "A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property." ; - skos:inScheme . - -td:output a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "output" ; - skos:definition "Used to define the output data schema of the action." ; - skos:inScheme . - -td:propertyName a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "propertyName" ; - skos:definition "Used to store the indexing name in the parent object when this schema appears as a property of an object schema." ; - skos:inScheme . - -td:proxy a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "proxy" ; - skos:definition "URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint." ; - skos:inScheme . - -td:readonly a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "readonly" ; - skos:definition "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false)." ; - skos:inScheme . - -td:relation a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "relation" ; - skos:definition "A link relation type identifies the semantics of a link." ; - skos:inScheme . - -td:returns a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "returns" ; - skos:definition "This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages." ; - skos:inScheme . - -td:safe a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "safe" ; - skos:definition "Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action." ; - skos:inScheme . - -td:schema a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "schema" ; - skos:definition "TODO Check, was not in hctl ontology, if not could be source of discrepancy" ; - skos:inScheme . - -td:scheme a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "scheme" ; - skos:inScheme . - -td:scopes a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "scopes" ; - skos:definition "TODO Check, was not in hctl ontology, if not could be source of discrepancy" ; - skos:inScheme . - -td:sizes a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "sizes" ; - skos:definition "Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \\\"16x16\\\", \\\"16x16 32x32\\\")." ; - skos:inScheme . - -td:subprotocol a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "subprotocol" ; - skos:definition "Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options." ; - skos:inScheme . - -td:subscription a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "subscription" ; - skos:definition "Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks." ; - skos:inScheme . - -td:success a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "success" ; - skos:definition "Signals if the additional response should not be considered an error." ; - skos:inScheme . - -td:supportContact a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "supportContact" ; - skos:definition "Provides information about the TD maintainer as URI scheme (e.g., mailto [[RFC6068]],tel [[RFC3966]],https [[RFC9112]])." ; - skos:inScheme . - -td:synchronous a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "synchronous" ; - skos:definition "Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made." ; - skos:inScheme . - -td:type a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "type" ; - skos:inScheme . - -td:version a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "version" ; - skos:inScheme . - -td:writeOnly a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "writeOnly" ; - skos:definition "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false)." ; - skos:inScheme . - - a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "@type" ; - skos:inScheme . - -td:InteractionAffordance a owl:Class, - linkml:ClassDefinition ; - rdfs:label "InteractionAffordance" ; - rdfs:subClassOf [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:descriptionInLanguage ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:uriVariables ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:title ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:forms ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:titles ], - [ a owl:Restriction ; - owl:allValuesFrom td:Form ; - owl:onProperty td:forms ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:descriptions ], - [ a owl:Restriction ; - owl:minCardinality 1 ; - owl:onProperty td:name ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:titleInLanguage ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:titles ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:descriptionInLanguage ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:descriptionInLanguage ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:description ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:title ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:name ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:title ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:description ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:titleInLanguage ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:name ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:description ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:titleInLanguage ], - [ a owl:Restriction ; - owl:allValuesFrom td:DataSchema ; - owl:onProperty td:uriVariables ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:descriptions ] ; - skos:definition "TOOD" ; - skos:exactMatch td:InteractionAffordance ; - skos:inScheme . - -td:forms a owl:ObjectProperty, - linkml:SlotDefinition . - -td:titles a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "titles" ; - rdfs:range td:MultiLanguage ; - skos:inScheme . - -td:securityDefinitions a owl:ObjectProperty, - linkml:SlotDefinition . - -td:contentType a owl:ObjectProperty, - linkml:SlotDefinition . - -td:descriptions a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "descriptions" ; - rdfs:range td:MultiLanguage ; - skos:definition "TODO, check, according to the description a description should not contain a lang tag." ; - skos:inScheme . - -td:instance a owl:ObjectProperty, - linkml:SlotDefinition . - -td:target a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "target" ; - rdfs:range td:anyUri ; - skos:definition "Target IRI of a link or submission target of a Form" ; - skos:inScheme . - -td:DataSchema a owl:Class, - linkml:ClassDefinition ; - rdfs:label "DataSchema" ; - rdfs:subClassOf [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:propertyName ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:writeOnly ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:propertyName ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:readonly ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:readonly ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:writeOnly ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:description ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:readonly ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:descriptionInLanguage ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:title ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:title ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:descriptionInLanguage ], - [ a owl:Restriction ; - owl:allValuesFrom linkml:String ; - owl:onProperty td:writeOnly ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:title ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:titleInLanguage ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:titleInLanguage ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:propertyName ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:description ], - [ a owl:Restriction ; - owl:minCardinality 0 ; - owl:onProperty td:titleInLanguage ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:descriptionInLanguage ], - [ a owl:Restriction ; - owl:allValuesFrom td:MultiLanguage ; - owl:onProperty td:description ] ; - skos:definition "Metadata that describes the data format used. It can be used for validation." ; - skos:exactMatch jsonschema:DataSchema ; - skos:inScheme . - -td:descriptionInLanguage a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "descriptionInLanguage" ; - rdfs:range td:MultiLanguage ; - skos:definition "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - skos:inScheme . - -td:title a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "title" ; - rdfs:range td:MultiLanguage ; - skos:definition "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; - skos:inScheme . - -td:titleInLanguage a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "titleInLanguage" ; - rdfs:range td:MultiLanguage ; - skos:definition "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - skos:inScheme . - -td:anyUri a owl:Class, - linkml:TypeDefinition ; - rdfs:subClassOf [ a owl:Restriction ; - owl:onDataRange td:anyUri ; - owl:onProperty linkml:topValue ; - owl:qualifiedCardinality 1 ] . - -td:description a owl:ObjectProperty, - linkml:SlotDefinition ; - rdfs:label "description" ; - rdfs:range td:MultiLanguage ; - skos:inScheme . - -td:SecuritySchemeType a owl:Class, - linkml:EnumDefinition ; - owl:unionOf ( wotsec:NoSecurityScheme wotsec:ComboSecurityScheme wotsec:BasicSecurityScheme wotsec:DigestSecurityScheme wotsec:BearerSecurityScheme wotsec:PSKSecurityScheme wotsec:OAuth2SecurityScheme wotsec:APIKeySecurityScheme wotsec:AutoSecurityScheme ) ; - linkml:permissible_values wotsec:APIKeySecurityScheme, - wotsec:AutoSecurityScheme, - wotsec:BasicSecurityScheme, - wotsec:BearerSecurityScheme, - wotsec:ComboSecurityScheme, - wotsec:DigestSecurityScheme, - wotsec:NoSecurityScheme, - wotsec:OAuth2SecurityScheme, - wotsec:PSKSecurityScheme . - -td:MultiLanguage a owl:Class, - linkml:ClassDefinition ; - rdfs:label "MultiLanguage" ; - rdfs:subClassOf [ a owl:Restriction ; - owl:minCardinality 1 ; - owl:onProperty td:key ], - [ a owl:Restriction ; - owl:allValuesFrom [ a rdfs:Datatype ; - owl:onDatatype xsd:string ; - owl:withRestrictions ( [ xsd:pattern "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$" ] ) ] ; - owl:onProperty td:key ], - [ a owl:Restriction ; - owl:maxCardinality 1 ; - owl:onProperty td:key ] ; - skos:inScheme . - -td:OperationTypes a owl:Class, - linkml:EnumDefinition ; - owl:unionOf ( td:readProperty td:writeProperty td:observeProperty td:unobserveProperty td:invokeAction td:queryAction td:cancelAction td:subscribeEvent td:unsubscribeEvent td:readAllProperties td:readMultipleProperties td:writeMultipleProperties td:observeAllProperties td:unobserveAllProperties td:subscribeAllEvents td:unsubscribeAllEvents td:queryAllActions ) ; - linkml:permissible_values td:cancelAction, - td:invokeAction, - td:observeAllProperties, - td:observeProperty, - td:queryAction, - td:queryAllActions, - td:readAllProperties, - td:readMultipleProperties, - td:readProperty, - td:subscribeAllEvents, - td:subscribeEvent, - td:unobserveAllProperties, - td:unobserveProperty, - td:unsubscribeAllEvents, - td:unsubscribeEvent, - td:writeMultipleProperties, - td:writeProperty, - . - - a owl:Ontology ; - rdfs:label "thing-description-schema" ; - dct:license "MIT" ; - dct:title "thing-description-schema" ; - rdfs:seeAlso ; - skos:definition """LinkML schema for modelling the Web of Things Thing Description information model. This schema is used to generate -JSON Schema, SHACL shapes, and RDF.""" . - diff --git a/resources/gens/prefixmap/thing_description_schema.yaml b/resources/gens/prefixmap/thing_description_schema.yaml deleted file mode 100644 index 4722b06..0000000 --- a/resources/gens/prefixmap/thing_description_schema.yaml +++ /dev/null @@ -1,33 +0,0 @@ -{ - "dct": "http://purl.org/dc/terms/", - "dcterms": "http://purl.org/dc/terms/", - "hctl": "https://www.w3.org/2019/wot/hypermedia#", - "htv": "http://www.w3.org/2011/http#", - "jsonschema": "https://www.w3.org/2019/wot/json-schema#", - "linkml": "https://w3id.org/linkml/", - "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#", - "rdfs": "http://www.w3.org/2000/01/rdf-schema#", - "schema": "http://schema.org/", - "td": "https://www.w3.org/2019/wot/td#", - "tm": "https://www.w3.org/2019/wot/tm#", - "wotsec": "https://www.w3.org/2019/wot/security#", - "xsd": "http://www.w3.org/2001/XMLSchema#", - "AdditionalExpectedResponse": { - "@id": "hctl:AdditionalExpectedResponse" - }, - "DataSchema": { - "@id": "jsonschema:DataSchema" - }, - "ExpectedResponse": { - "@id": "hctl:ExpectedResponse" - }, - "Form": { - "@id": "hctl:Form" - }, - "Link": { - "@id": "hctl:Link" - }, - "VersionInfo": { - "@id": "schema:version" - } -} diff --git a/resources/gens/protobuf/thing_description_schema.proto b/resources/gens/protobuf/thing_description_schema.proto deleted file mode 100644 index df5477f..0000000 --- a/resources/gens/protobuf/thing_description_schema.proto +++ /dev/null @@ -1,159 +0,0 @@ -// An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time). -message ActionAffordance - { - repeated multiLanguage titles = 0 - repeated multiLanguage descriptions = 0 - multiLanguage title = 0 - multiLanguage description = 0 - multiLanguage titleInLanguage = 0 - multiLanguage descriptionInLanguage = 0 - string name = 0 - repeated dataSchema uriVariables = 0 - repeated form forms = 0 - boolean safe = 0 - boolean synchronous = 0 - boolean idempotent = 0 - dataSchema input = 0 - dataSchema output = 0 - } -// Communication metadata describing the expected response message for additional responses. -message AdditionalExpectedResponse - { - string contentType = 0 - string additionalOutputSchema = 0 - boolean success = 0 - string schema = 0 - } -// Metadata that describes the data format used. It can be used for validation. -message DataSchema - { - multiLanguage description = 0 - multiLanguage title = 0 - multiLanguage titleInLanguage = 0 - multiLanguage descriptionInLanguage = 0 - string propertyName = 0 - string writeOnly = 0 - string readonly = 0 - } -// An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts). -message EventAffordance - { - repeated multiLanguage titles = 0 - repeated multiLanguage descriptions = 0 - multiLanguage title = 0 - multiLanguage description = 0 - multiLanguage titleInLanguage = 0 - multiLanguage descriptionInLanguage = 0 - string name = 0 - repeated dataSchema uriVariables = 0 - repeated form forms = 0 - dataSchema subscription = 0 - dataSchema cancellation = 0 - dataSchema notification = 0 - dataSchema notificationResponse = 0 - } -// Communication metadata describing the expected response message for the primary response. -message ExpectedResponse - { - string contentType = 0 - } -// A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions. -message Form - { - anyUri target = 0 - anyUri href = 0 - string contentType = 0 - string contentCoding = 0 - string securityDefinitions = 0 - string scopes = 0 - expectedResponse returns = 0 - repeated additionalExpectedResponse additionalReturns = 0 - string subprotocol = 0 - repeated operationTypes operationType = 0 - } -// TOOD -message InteractionAffordance - { - repeated multiLanguage titles = 0 - repeated multiLanguage descriptions = 0 - multiLanguage title = 0 - multiLanguage description = 0 - multiLanguage titleInLanguage = 0 - multiLanguage descriptionInLanguage = 0 - string name = 0 - repeated dataSchema uriVariables = 0 - repeated form forms = 0 - } -// A link can be viewed as a statement of the form link context that has a relation type resource at link target", where the optional target attributes may further describe the resource. -message Link - { - anyUri target = 0 - string hintsAtMediaType = 0 - string type = 0 - string relation = 0 - anyUri anchor = 0 - string sizes = 0 - string hreflang = 0 - } -message MultiLanguage - { - string key = 0 - } -// An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated. -message PropertyAffordance - { - repeated multiLanguage titles = 0 - repeated multiLanguage descriptions = 0 - multiLanguage title = 0 - multiLanguage description = 0 - multiLanguage titleInLanguage = 0 - multiLanguage descriptionInLanguage = 0 - string name = 0 - repeated dataSchema uriVariables = 0 - repeated form forms = 0 - boolean observable = 0 - string propertyName = 0 - string writeOnly = 0 - string readonly = 0 - } -message SecurityScheme - { - repeated string @type = 0 - repeated multiLanguage descriptions = 0 - string description = 0 - anyUri proxy = 0 - securitySchemeType scheme = 0 - } -// An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things. -message Thing - { - anyUri id = 0 - multiLanguage title = 0 - multiLanguage description = 0 - repeated multiLanguage titles = 0 - repeated multiLanguage descriptions = 0 - repeated string @type = 0 - multiLanguage titleInLanguage = 0 - multiLanguage descriptionInLanguage = 0 - repeated string securityDefinitions = 0 - repeated string security = 0 - repeated dataSchema schemaDefinitions = 0 - repeated anyUri profile = 0 - string instance = 0 - datetime created = 0 - datetime modified = 0 - anyUri supportContact = 0 - anyUri base = 0 - versionInfo version = 0 - repeated form forms = 0 - repeated link links = 0 - repeated propertyAffordance properties = 0 - repeated actionAffordance actions = 0 - repeated eventAffordance events = 0 - } -// Provides version information. -message VersionInfo - { - string instance = 0 - string model = 0 - } diff --git a/resources/gens/shacl/thing_description_schema.shacl.ttl b/resources/gens/shacl/thing_description_schema.shacl.ttl deleted file mode 100644 index 5bd0b4d..0000000 --- a/resources/gens/shacl/thing_description_schema.shacl.ttl +++ /dev/null @@ -1,638 +0,0 @@ -@prefix hctl: . -@prefix jsonschema: . -@prefix rdf: . -@prefix schema1: . -@prefix sh: . -@prefix td: . -@prefix wotsec: . -@prefix xsd: . - -td:InteractionAffordance a sh:NodeShape ; - sh:closed true ; - sh:description "TOOD" ; - sh:ignoredProperties ( rdf:type ) ; - sh:property [ sh:class td:MultiLanguage ; - sh:description "TODO, check, according to the description a description should not contain a lang tag." ; - sh:nodeKind sh:IRI ; - sh:order 1 ; - sh:path td:descriptions ], - [ sh:class td:MultiLanguage ; - sh:nodeKind sh:IRI ; - sh:order 0 ; - sh:path td:titles ], - [ sh:class jsonschema:DataSchema ; - sh:description "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology." ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 7 ; - sh:path td:uriVariables ], - [ sh:class td:MultiLanguage ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 3 ; - sh:path td:description ], - [ sh:datatype xsd:string ; - sh:description "Indexing property to store entity names when serializing them in a JSON-LD @index container." ; - sh:maxCount 1 ; - sh:order 6 ; - sh:path td:name ], - [ sh:class td:MultiLanguage ; - sh:description "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 4 ; - sh:path td:titleInLanguage ], - [ sh:class td:MultiLanguage ; - sh:description "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 2 ; - sh:path td:title ], - [ sh:class hctl:Form ; - sh:description "Set of form hypermedia controls that describe how an operation can be performed." ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 8 ; - sh:path td:forms ], - [ sh:class td:MultiLanguage ; - sh:description "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 5 ; - sh:path td:descriptionInLanguage ] ; - sh:targetClass td:InteractionAffordance . - -td:SecurityScheme a sh:NodeShape ; - sh:closed true ; - sh:ignoredProperties ( rdf:type ) ; - sh:property [ sh:in ( wotsec:NoSecurityScheme wotsec:ComboSecurityScheme wotsec:BasicSecurityScheme wotsec:DigestSecurityScheme wotsec:BearerSecurityScheme wotsec:PSKSecurityScheme wotsec:OAuth2SecurityScheme wotsec:APIKeySecurityScheme wotsec:AutoSecurityScheme ) ; - sh:maxCount 1 ; - sh:minCount 1 ; - sh:order 4 ; - sh:path td:scheme ], - [ sh:datatype xsd:string ; - sh:maxCount 1 ; - sh:order 2 ; - sh:path td:description ], - [ sh:class td:MultiLanguage ; - sh:description "TODO, check, according to the description a description should not contain a lang tag." ; - sh:nodeKind sh:IRI ; - sh:order 1 ; - sh:path td:descriptions ], - [ sh:datatype xsd:string ; - sh:order 0 ; - sh:path ], - [ sh:description "URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint." ; - sh:maxCount 1 ; - sh:order 3 ; - sh:path td:proxy ] ; - sh:targetClass td:SecurityScheme . - -td:Thing a sh:NodeShape ; - sh:closed true ; - sh:description "An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things." ; - sh:ignoredProperties ( rdf:type ) ; - sh:property [ sh:datatype xsd:string ; - sh:description "Provides a version identicator of this TD instance." ; - sh:maxCount 1 ; - sh:order 12 ; - sh:path td:instance ], - [ sh:class td:MultiLanguage ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 2 ; - sh:path td:description ], - [ sh:class td:PropertyAffordance ; - sh:description "All Property-based interaction affordances of the Thing." ; - sh:nodeKind sh:IRI ; - sh:order 20 ; - sh:path td:properties ], - [ sh:datatype xsd:string ; - sh:order 5 ; - sh:path ], - [ sh:datatype xsd:dateTime ; - sh:description "Provides information when the TD instance was created." ; - sh:maxCount 1 ; - sh:order 13 ; - sh:path td:created ], - [ sh:class td:MultiLanguage ; - sh:description "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 6 ; - sh:path td:titleInLanguage ], - [ sh:description "Define the base URI that is used for all relative URI references throughout a TD document." ; - sh:maxCount 1 ; - sh:order 16 ; - sh:path td:base ], - [ sh:class td:MultiLanguage ; - sh:description "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 1 ; - sh:path td:title ], - [ sh:class hctl:Link ; - sh:description "Provides Web links to arbitrary resources that relate to the specified Thing Description." ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 19 ; - sh:path td:links ], - [ sh:description "A security scheme applied to a (set of) affordance(s). TODO check" ; - sh:or ( [ sh:datatype xsd:string ] [ sh:in ( wotsec:NoSecurityScheme wotsec:ComboSecurityScheme wotsec:BasicSecurityScheme wotsec:DigestSecurityScheme wotsec:BearerSecurityScheme wotsec:PSKSecurityScheme wotsec:OAuth2SecurityScheme wotsec:APIKeySecurityScheme wotsec:AutoSecurityScheme ) ] ) ; - sh:order 8 ; - sh:path td:securityDefinitions ], - [ sh:class td:MultiLanguage ; - sh:description "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 7 ; - sh:path td:descriptionInLanguage ], - [ sh:description "Provides information about the TD maintainer as URI scheme (e.g., mailto [[RFC6068]],tel [[RFC3966]],https [[RFC9112]])." ; - sh:maxCount 1 ; - sh:order 15 ; - sh:path td:supportContact ], - [ sh:class td:MultiLanguage ; - sh:nodeKind sh:IRI ; - sh:order 3 ; - sh:path td:titles ], - [ sh:description "TODO" ; - sh:maxCount 1 ; - sh:order 0 ; - sh:path td:id ], - [ sh:class hctl:Form ; - sh:description "Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings." ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 18 ; - sh:path td:forms ], - [ sh:datatype xsd:string ; - sh:description "A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check" ; - sh:order 9 ; - sh:path td:security ], - [ sh:datatype xsd:dateTime ; - sh:description "Provides information when the TD instance was last modified." ; - sh:maxCount 1 ; - sh:order 14 ; - sh:path td:modified ], - [ sh:description "Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation." ; - sh:order 11 ; - sh:path td:profile ], - [ sh:class td:EventAffordance ; - sh:description "All Event-based interaction affordances of the Thing." ; - sh:nodeKind sh:IRI ; - sh:order 22 ; - sh:path td:events ], - [ sh:class jsonschema:DataSchema ; - sh:description "TODO CHECK" ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 10 ; - sh:path td:schemaDefinitions ], - [ sh:class td:ActionAffordance ; - sh:description "All Action-based interaction affordances of the Thing." ; - sh:nodeKind sh:IRI ; - sh:order 21 ; - sh:path td:actions ], - [ sh:class td:MultiLanguage ; - sh:description "TODO, check, according to the description a description should not contain a lang tag." ; - sh:nodeKind sh:IRI ; - sh:order 4 ; - sh:path td:descriptions ], - [ sh:class schema1:version ; - sh:maxCount 1 ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 17 ; - sh:path td:version ] ; - sh:targetClass td:Thing . - -schema1:version a sh:NodeShape ; - sh:closed true ; - sh:description "Provides version information." ; - sh:ignoredProperties ( rdf:type ) ; - sh:property [ sh:datatype xsd:string ; - sh:maxCount 1 ; - sh:order 1 ; - sh:path td:model ], - [ sh:datatype xsd:string ; - sh:maxCount 1 ; - sh:minCount 1 ; - sh:order 0 ; - sh:path td:instance ] ; - sh:targetClass schema1:version . - -hctl:AdditionalExpectedResponse a sh:NodeShape ; - sh:closed true ; - sh:description "Communication metadata describing the expected response message for additional responses." ; - sh:ignoredProperties ( rdf:type ) ; - sh:property [ sh:datatype xsd:string ; - sh:description "TODO Check, was not in hctl ontology, if not could be source of discrepancy" ; - sh:maxCount 1 ; - sh:minCount 1 ; - sh:order 3 ; - sh:path td:contentType ], - [ sh:datatype xsd:string ; - sh:description "TODO Check, was not in hctl ontology, if not could be source of discrepancy" ; - sh:maxCount 1 ; - sh:order 2 ; - sh:path td:schema ], - [ sh:datatype xsd:string ; - sh:description "This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used." ; - sh:maxCount 1 ; - sh:order 0 ; - sh:path td:additionalOutputSchema ], - [ sh:datatype xsd:boolean ; - sh:description "Signals if the additional response should not be considered an error." ; - sh:maxCount 1 ; - sh:order 1 ; - sh:path td:success ] ; - sh:targetClass hctl:AdditionalExpectedResponse . - -hctl:ExpectedResponse a sh:NodeShape ; - sh:closed true ; - sh:description "Communication metadata describing the expected response message for the primary response." ; - sh:ignoredProperties ( rdf:type ) ; - sh:property [ sh:datatype xsd:string ; - sh:description "TODO Check, was not in hctl ontology, if not could be source of discrepancy" ; - sh:maxCount 1 ; - sh:minCount 1 ; - sh:order 0 ; - sh:path td:contentType ] ; - sh:targetClass hctl:ExpectedResponse . - -hctl:Link a sh:NodeShape ; - sh:closed true ; - sh:description "A link can be viewed as a statement of the form link context that has a relation type resource at link target\", where the optional target attributes may further describe the resource." ; - sh:ignoredProperties ( rdf:type ) ; - sh:property [ sh:datatype xsd:string ; - sh:maxCount 1 ; - sh:order 2 ; - sh:path td:type ], - [ sh:datatype xsd:string ; - sh:description "The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]." ; - sh:maxCount 1 ; - sh:order 6 ; - sh:path td:hreflang ; - sh:pattern "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$" ], - [ sh:datatype xsd:string ; - sh:description "A link relation type identifies the semantics of a link." ; - sh:maxCount 1 ; - sh:order 3 ; - sh:path td:relation ], - [ sh:description "Target IRI of a link or submission target of a Form" ; - sh:maxCount 1 ; - sh:minCount 1 ; - sh:order 0 ; - sh:path hctl:target ], - [ sh:datatype xsd:string ; - sh:description "Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \\\"16x16\\\", \\\"16x16 32x32\\\")." ; - sh:maxCount 1 ; - sh:order 5 ; - sh:path td:sizes ], - [ sh:datatype xsd:string ; - sh:description "Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be." ; - sh:maxCount 1 ; - sh:order 1 ; - sh:path td:hintsAtMediaType ], - [ sh:description "By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI." ; - sh:maxCount 1 ; - sh:order 4 ; - sh:path td:anchor ] ; - sh:targetClass hctl:Link . - -td:ActionAffordance a sh:NodeShape ; - sh:closed true ; - sh:description "An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time)." ; - sh:ignoredProperties ( rdf:type ) ; - sh:property [ sh:class jsonschema:DataSchema ; - sh:description "Used to define the output data schema of the action." ; - sh:maxCount 1 ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 4 ; - sh:path td:output ], - [ sh:datatype xsd:boolean ; - sh:description "Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input." ; - sh:maxCount 1 ; - sh:order 2 ; - sh:path td:idempotent ], - [ sh:class td:MultiLanguage ; - sh:description "TODO, check, according to the description a description should not contain a lang tag." ; - sh:nodeKind sh:IRI ; - sh:order 6 ; - sh:path td:descriptions ], - [ sh:datatype xsd:string ; - sh:description "Indexing property to store entity names when serializing them in a JSON-LD @index container." ; - sh:maxCount 1 ; - sh:minCount 1 ; - sh:order 11 ; - sh:path td:name ], - [ sh:datatype xsd:boolean ; - sh:description "Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action." ; - sh:maxCount 1 ; - sh:order 0 ; - sh:path td:safe ], - [ sh:class td:MultiLanguage ; - sh:description "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 7 ; - sh:path td:title ], - [ sh:class td:MultiLanguage ; - sh:description "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 9 ; - sh:path td:titleInLanguage ], - [ sh:datatype xsd:boolean ; - sh:description "Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made." ; - sh:maxCount 1 ; - sh:order 1 ; - sh:path td:synchronous ], - [ sh:class td:MultiLanguage ; - sh:nodeKind sh:IRI ; - sh:order 5 ; - sh:path td:titles ], - [ sh:class jsonschema:DataSchema ; - sh:description "Used to define the input data schema of the action." ; - sh:maxCount 1 ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 3 ; - sh:path td:input ], - [ sh:class td:MultiLanguage ; - sh:description "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 10 ; - sh:path td:descriptionInLanguage ], - [ sh:class hctl:Form ; - sh:description "Set of form hypermedia controls that describe how an operation can be performed." ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 13 ; - sh:path td:forms ], - [ sh:class td:MultiLanguage ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 8 ; - sh:path td:description ], - [ sh:class jsonschema:DataSchema ; - sh:description "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology." ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 12 ; - sh:path td:uriVariables ] ; - sh:targetClass td:ActionAffordance . - -td:EventAffordance a sh:NodeShape ; - sh:closed true ; - sh:description "An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts)." ; - sh:ignoredProperties ( rdf:type ) ; - sh:property [ sh:class td:MultiLanguage ; - sh:description "TODO, check, according to the description a description should not contain a lang tag." ; - sh:nodeKind sh:IRI ; - sh:order 5 ; - sh:path td:descriptions ], - [ sh:class td:MultiLanguage ; - sh:description "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 9 ; - sh:path td:descriptionInLanguage ], - [ sh:class td:MultiLanguage ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 7 ; - sh:path td:description ], - [ sh:class jsonschema:DataSchema ; - sh:description "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology." ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 11 ; - sh:path td:uriVariables ], - [ sh:class jsonschema:DataSchema ; - sh:description "Defines the data schema of the Event instance messages pushed by the Thing." ; - sh:maxCount 1 ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 2 ; - sh:path td:notification ], - [ sh:class hctl:Form ; - sh:description "Set of form hypermedia controls that describe how an operation can be performed." ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 12 ; - sh:path td:forms ], - [ sh:class td:MultiLanguage ; - sh:description "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 6 ; - sh:path td:title ], - [ sh:class jsonschema:DataSchema ; - sh:description "Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks." ; - sh:maxCount 1 ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 0 ; - sh:path td:subscription ], - [ sh:class jsonschema:DataSchema ; - sh:description "Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook." ; - sh:maxCount 1 ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 1 ; - sh:path td:cancellation ], - [ sh:class jsonschema:DataSchema ; - sh:description "Defines the data schema of the Event response messages sent by the consumer in a response to a data message." ; - sh:maxCount 1 ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 3 ; - sh:path td:notificationResponse ], - [ sh:class td:MultiLanguage ; - sh:nodeKind sh:IRI ; - sh:order 4 ; - sh:path td:titles ], - [ sh:class td:MultiLanguage ; - sh:description "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 8 ; - sh:path td:titleInLanguage ], - [ sh:datatype xsd:string ; - sh:description "Indexing property to store entity names when serializing them in a JSON-LD @index container." ; - sh:maxCount 1 ; - sh:minCount 1 ; - sh:order 10 ; - sh:path td:name ] ; - sh:targetClass td:EventAffordance . - -td:PropertyAffordance a sh:NodeShape ; - sh:closed true ; - sh:description "An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated." ; - sh:ignoredProperties ( rdf:type ) ; - sh:property [ sh:datatype xsd:string ; - sh:description "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false)." ; - sh:maxCount 1 ; - sh:order 6 ; - sh:path td:writeOnly ], - [ sh:class td:MultiLanguage ; - sh:nodeKind sh:IRI ; - sh:order 8 ; - sh:path td:titles ], - [ sh:class hctl:Form ; - sh:description "Set of form hypermedia controls that describe how an operation can be performed." ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 12 ; - sh:path td:forms ], - [ sh:datatype xsd:string ; - sh:description "Used to store the indexing name in the parent object when this schema appears as a property of an object schema." ; - sh:maxCount 1 ; - sh:order 5 ; - sh:path td:propertyName ], - [ sh:class jsonschema:DataSchema ; - sh:description "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology." ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 11 ; - sh:path td:uriVariables ], - [ sh:class td:MultiLanguage ; - sh:description "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 3 ; - sh:path td:titleInLanguage ], - [ sh:datatype xsd:boolean ; - sh:description "A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property." ; - sh:maxCount 1 ; - sh:order 0 ; - sh:path td:observable ], - [ sh:class td:MultiLanguage ; - sh:description "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 4 ; - sh:path td:descriptionInLanguage ], - [ sh:class td:MultiLanguage ; - sh:description "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 2 ; - sh:path td:title ], - [ sh:datatype xsd:string ; - sh:description "Indexing property to store entity names when serializing them in a JSON-LD @index container." ; - sh:maxCount 1 ; - sh:minCount 1 ; - sh:order 10 ; - sh:path td:name ], - [ sh:datatype xsd:string ; - sh:description "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false)." ; - sh:maxCount 1 ; - sh:order 7 ; - sh:path td:readonly ], - [ sh:class td:MultiLanguage ; - sh:description "TODO, check, according to the description a description should not contain a lang tag." ; - sh:nodeKind sh:IRI ; - sh:order 9 ; - sh:path td:descriptions ], - [ sh:class td:MultiLanguage ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 1 ; - sh:path td:description ] ; - sh:targetClass td:PropertyAffordance . - -hctl:Form a sh:NodeShape ; - sh:closed true ; - sh:description "A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions." ; - sh:ignoredProperties ( rdf:type ) ; - sh:property [ sh:datatype xsd:string ; - sh:description "Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \\\"gzip\\\", \\\"deflate\\\", etc." ; - sh:maxCount 1 ; - sh:order 3 ; - sh:path td:contentCoding ], - [ sh:datatype xsd:string ; - sh:description "Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type." ; - sh:maxCount 1 ; - sh:order 2 ; - sh:path td:contentType ], - [ sh:datatype xsd:string ; - sh:description "A security schema applied to a (set of) affordance(s)." ; - sh:maxCount 1 ; - sh:order 4 ; - sh:path td:securityDefinitions ], - [ sh:description "Indicates the semantic intention of performing the operation(s) described by the form." ; - sh:in ( td:readProperty td:writeProperty td:observeProperty td:unobserveProperty td:invokeAction td:queryAction td:cancelAction td:subscribeEvent td:unsubscribeEvent td:readAllProperties td:readMultipleProperties td:writeMultipleProperties td:observeAllProperties td:unobserveAllProperties td:subscribeAllEvents td:unsubscribeAllEvents td:queryAllActions ) ; - sh:order 9 ; - sh:path td:operationType ], - [ sh:maxCount 1 ; - sh:minCount 1 ; - sh:order 1 ; - sh:path td:href ], - [ sh:description "Target IRI of a link or submission target of a Form" ; - sh:maxCount 1 ; - sh:minCount 1 ; - sh:order 0 ; - sh:path hctl:target ], - [ sh:datatype xsd:string ; - sh:description "TODO Check, was not in hctl ontology, if not could be source of discrepancy" ; - sh:maxCount 1 ; - sh:order 5 ; - sh:path td:scopes ], - [ sh:class hctl:AdditionalExpectedResponse ; - sh:description "This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema." ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 7 ; - sh:path td:additionalReturns ], - [ sh:class hctl:ExpectedResponse ; - sh:description "This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages." ; - sh:maxCount 1 ; - sh:nodeKind sh:BlankNodeOrIRI ; - sh:order 6 ; - sh:path td:returns ], - [ sh:datatype xsd:string ; - sh:description "Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options." ; - sh:maxCount 1 ; - sh:order 8 ; - sh:path td:subprotocol ] ; - sh:targetClass hctl:Form . - -jsonschema:DataSchema a sh:NodeShape ; - sh:closed true ; - sh:description "Metadata that describes the data format used. It can be used for validation." ; - sh:ignoredProperties ( rdf:type ) ; - sh:property [ sh:datatype xsd:string ; - sh:description "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false)." ; - sh:maxCount 1 ; - sh:order 6 ; - sh:path td:readonly ], - [ sh:class td:MultiLanguage ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 0 ; - sh:path td:description ], - [ sh:class td:MultiLanguage ; - sh:description "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 2 ; - sh:path td:titleInLanguage ], - [ sh:class td:MultiLanguage ; - sh:description "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 1 ; - sh:path td:title ], - [ sh:datatype xsd:string ; - sh:description "Used to store the indexing name in the parent object when this schema appears as a property of an object schema." ; - sh:maxCount 1 ; - sh:order 4 ; - sh:path td:propertyName ], - [ sh:class td:MultiLanguage ; - sh:description "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; - sh:maxCount 1 ; - sh:nodeKind sh:IRI ; - sh:order 3 ; - sh:path td:descriptionInLanguage ], - [ sh:datatype xsd:string ; - sh:description "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false)." ; - sh:maxCount 1 ; - sh:order 5 ; - sh:path td:writeOnly ] ; - sh:targetClass jsonschema:DataSchema . - -td:MultiLanguage a sh:NodeShape ; - sh:closed true ; - sh:ignoredProperties ( rdf:type ) ; - sh:property [ sh:datatype xsd:string ; - sh:maxCount 1 ; - sh:order 0 ; - sh:path td:key ; - sh:pattern "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$" ] ; - sh:targetClass td:MultiLanguage . - diff --git a/resources/gens/shex/thing_description_schema.shex b/resources/gens/shex/thing_description_schema.shex deleted file mode 100644 index 7eb68f7..0000000 --- a/resources/gens/shex/thing_description_schema.shex +++ /dev/null @@ -1,225 +0,0 @@ -BASE -PREFIX rdf: -PREFIX xsd: -PREFIX linkml: -PREFIX jsonschema: -PREFIX wotsec: -PREFIX hctl: -PREFIX schema1: - - - IRI - -linkml:String xsd:string - -linkml:Integer xsd:integer - -linkml:Boolean xsd:boolean - -linkml:Float xsd:float - -linkml:Double xsd:double - -linkml:Decimal xsd:decimal - -linkml:Time xsd:time - -linkml:Date xsd:date - -linkml:Datetime xsd:dateTime - -linkml:DateOrDatetime linkml:DateOrDatetime - -linkml:Uriorcurie IRI - -linkml:Curie xsd:string - -linkml:Uri IRI - -linkml:Ncname xsd:string - -linkml:Objectidentifier IRI - -linkml:Nodeidentifier NONLITERAL - -linkml:Jsonpointer xsd:string - -linkml:Jsonpath xsd:string - -linkml:Sparqlpath xsd:string - - CLOSED { - ( $ ( & ; - rdf:type [ ] ? ; - @linkml:Boolean ? ; - @linkml:Boolean ? ; - @linkml:Boolean ? ; - @ ? ; - @ ? - ) ; - rdf:type [ ] - ) -} - - CLOSED { - ( $ ( & ; - rdf:type [ hctl:ExpectedResponse ] ? ; - @linkml:String ? ; - @linkml:Boolean ? ; - @linkml:String ? - ) ; - rdf:type [ hctl:AdditionalExpectedResponse ] ? - ) -} - - CLOSED { - ( $ ( @ ? ; - @<MultiLanguage> ? ; - <titleInLanguage> @<MultiLanguage> ? ; - <descriptionInLanguage> @<MultiLanguage> ? ; - <propertyName> @linkml:String ? ; - <writeOnly> @linkml:String ? ; - <readonly> @linkml:String ? - ) ; - rdf:type [ jsonschema:DataSchema ] ? - ) -} - -<EventAffordance> CLOSED { - ( $<EventAffordance_tes> ( &<InteractionAffordance_tes> ; - rdf:type [ <InteractionAffordance> ] ? ; - <subscription> @<DataSchema> ? ; - <cancellation> @<DataSchema> ? ; - <notification> @<DataSchema> ? ; - <notificationResponse> @<DataSchema> ? - ) ; - rdf:type [ <EventAffordance> ] - ) -} - -<ExpectedResponse> ( - CLOSED { - ( $<ExpectedResponse_tes> <contentType> @linkml:String ; - rdf:type [ hctl:ExpectedResponse ] ? - ) - } OR @<AdditionalExpectedResponse> -) - -<Form> CLOSED { - ( $<Form_tes> ( hctl:target @<AnyUri> ; - <href> @<AnyUri> ; - <contentType> @linkml:String ? ; - <contentCoding> @linkml:String ? ; - <securityDefinitions> @linkml:String ? ; - <scopes> @linkml:String ? ; - <returns> @<ExpectedResponse> ? ; - <additionalReturns> @<AdditionalExpectedResponse> * ; - <subprotocol> @linkml:String ? ; - <operationType> [ <readProperty> <writeProperty> <observeProperty> <unobserveProperty> <invokeAction> <queryAction> - <cancelAction> <subscribeEvent> <unsubscribeEvent> <readAllProperties> <writeAllProperties> <readMultipleProperties> - <writeMultipleProperties> <observeAllProperties> <unobserveAllProperties> <subscribeAllEvents> <unsubscribeAllEvents> - <queryAllActions> ] * - ) ; - rdf:type [ hctl:Form ] ? - ) -} - -<InteractionAffordance> ( - CLOSED { - ( $<InteractionAffordance_tes> ( <titles> @<MultiLanguage> * ; - <descriptions> @<MultiLanguage> * ; - <title> @<MultiLanguage> ? ; - <description> @<MultiLanguage> ? ; - <titleInLanguage> @<MultiLanguage> ? ; - <descriptionInLanguage> @<MultiLanguage> ? ; - <uriVariables> @<DataSchema> * ; - <forms> @<Form> * - ) ; - rdf:type [ <InteractionAffordance> ] - ) - } OR @<ActionAffordance> OR @<EventAffordance> OR @<PropertyAffordance> -) - -<Link> CLOSED { - ( $<Link_tes> ( hctl:target @<AnyUri> ; - <hintsAtMediaType> @linkml:String ? ; - <type> @linkml:String ? ; - <relation> @linkml:String ? ; - <anchor> @<AnyUri> ? ; - <sizes> @linkml:String ? ; - <hreflang> @linkml:String ? - ) ; - rdf:type [ hctl:Link ] ? - ) -} - -<MultiLanguage> CLOSED { - ( $<MultiLanguage_tes> rdf:type . * ; - rdf:type [ <MultiLanguage> ] - ) -} - -<PropertyAffordance> CLOSED { - ( $<PropertyAffordance_tes> ( &<InteractionAffordance_tes> ; - rdf:type [ <InteractionAffordance> ] ? ; - &<DataSchema_tes> ; - rdf:type [ jsonschema:DataSchema ] ? ; - <observable> @linkml:Boolean ? ; - <propertyName> @linkml:String ? ; - <writeOnly> @linkml:String ? ; - <readonly> @linkml:String ? - ) ; - rdf:type [ <PropertyAffordance> ] - ) -} - -<SecurityScheme> CLOSED { - ( $<SecurityScheme_tes> ( <@type> @linkml:String * ; - <descriptions> @<MultiLanguage> * ; - <description> @linkml:String ? ; - <proxy> @<AnyUri> ? ; - <scheme> [ wotsec:NoSecurityScheme wotsec:ComboSecurityScheme wotsec:BasicSecurityScheme wotsec:DigestSecurityScheme - wotsec:BearerSecurityScheme wotsec:PSKSecurityScheme wotsec:OAuth2SecurityScheme wotsec:APIKeySecurityScheme - wotsec:AutoSecurityScheme ] - ) ; - rdf:type [ <SecurityScheme> ] ? - ) -} - -<Thing> CLOSED { - ( $<Thing_tes> ( <title> @<MultiLanguage> ? ; - <description> @<MultiLanguage> ? ; - <titles> @<MultiLanguage> * ; - <descriptions> @<MultiLanguage> * ; - <@type> @linkml:String * ; - <titleInLanguage> @<MultiLanguage> ? ; - <descriptionInLanguage> @<MultiLanguage> ? ; - <securityDefinitions> @linkml:String * ; - <security> @linkml:String * ; - <schemaDefinitions> @<DataSchema> * ; - <profile> @<AnyUri> * ; - <instance> @linkml:String ? ; - <created> @linkml:Datetime ? ; - <modified> @linkml:Datetime ? ; - <supportContact> @<AnyUri> ? ; - <base> @<AnyUri> ? ; - <version> @<VersionInfo> ? ; - <forms> @<Form> * ; - <links> @<Link> * ; - <properties> @<PropertyAffordance> * ; - <actions> @<ActionAffordance> * ; - <events> @<EventAffordance> * - ) ; - rdf:type [ <Thing> ] - ) -} - -<VersionInfo> CLOSED { - ( $<VersionInfo_tes> ( <instance> @linkml:String ; - <model> @linkml:String ? - ) ; - rdf:type [ schema1:version ] ? - ) -} - - diff --git a/resources/gens/sqlschema/thing_description_schema.sql b/resources/gens/sqlschema/thing_description_schema.sql deleted file mode 100644 index a41ee88..0000000 --- a/resources/gens/sqlschema/thing_description_schema.sql +++ /dev/null @@ -1,454 +0,0 @@ --- # Class: "VersionInfo" Description: "Provides version information." --- * Slot: id Description: --- * Slot: instance Description: --- * Slot: model Description: --- # Class: "MultiLanguage" Description: "" --- * Slot: key Description: --- * Slot: SecurityScheme_id Description: Autocreated FK slot --- * Slot: InteractionAffordance_name Description: Autocreated FK slot --- * Slot: PropertyAffordance_name Description: Autocreated FK slot --- * Slot: ActionAffordance_name Description: Autocreated FK slot --- * Slot: EventAffordance_name Description: Autocreated FK slot --- * Slot: Thing_id Description: Autocreated FK slot --- # Class: "Link" Description: "A link can be viewed as a statement of the form link context that has a relation type resource at link target", where the optional target attributes may further describe the resource." --- * Slot: id Description: --- * Slot: target Description: Target IRI of a link or submission target of a Form --- * Slot: hintsAtMediaType Description: Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. --- * Slot: type Description: --- * Slot: relation Description: A link relation type identifies the semantics of a link. --- * Slot: anchor Description: By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI. --- * Slot: sizes Description: Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \"16x16\", \"16x16 32x32\"). --- * Slot: hreflang Description: The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]. --- # Class: "ExpectedResponse" Description: "Communication metadata describing the expected response message for the primary response." --- * Slot: id Description: --- * Slot: contentType Description: TODO Check, was not in hctl ontology, if not could be source of discrepancy --- # Class: "AdditionalExpectedResponse" Description: "Communication metadata describing the expected response message for additional responses." --- * Slot: id Description: --- * Slot: additionalOutputSchema Description: This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used. --- * Slot: success Description: Signals if the additional response should not be considered an error. --- * Slot: schema Description: TODO Check, was not in hctl ontology, if not could be source of discrepancy --- * Slot: contentType Description: TODO Check, was not in hctl ontology, if not could be source of discrepancy --- # Class: "Form" Description: "A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions." --- * Slot: id Description: --- * Slot: target Description: Target IRI of a link or submission target of a Form --- * Slot: href Description: --- * Slot: contentType Description: Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type. --- * Slot: contentCoding Description: Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \"gzip\", \"deflate\", etc. --- * Slot: securityDefinitions Description: A security schema applied to a (set of) affordance(s). --- * Slot: scopes Description: TODO Check, was not in hctl ontology, if not could be source of discrepancy --- * Slot: subprotocol Description: Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options. --- * Slot: returns_id Description: This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages. --- # Class: "SecurityScheme" Description: "" --- * Slot: id Description: --- * Slot: description Description: --- * Slot: proxy Description: URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint. --- * Slot: scheme Description: --- # Class: "DataSchema" Description: "Metadata that describes the data format used. It can be used for validation." --- * Slot: id Description: --- * Slot: description Description: --- * Slot: title Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. --- * Slot: titleInLanguage Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. --- * Slot: descriptionInLanguage Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. --- * Slot: propertyName Description: Used to store the indexing name in the parent object when this schema appears as a property of an object schema. --- * Slot: writeOnly Description: Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false). --- * Slot: readonly Description: Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false). --- # Class: "InteractionAffordance" Description: "TOOD" --- * Slot: title Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. --- * Slot: description Description: --- * Slot: titleInLanguage Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. --- * Slot: descriptionInLanguage Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. --- * Slot: name Description: Indexing property to store entity names when serializing them in a JSON-LD @index container. --- # Class: "PropertyAffordance" Description: "An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated." --- * Slot: observable Description: A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property. --- * Slot: description Description: --- * Slot: title Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. --- * Slot: titleInLanguage Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. --- * Slot: descriptionInLanguage Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. --- * Slot: propertyName Description: Used to store the indexing name in the parent object when this schema appears as a property of an object schema. --- * Slot: writeOnly Description: Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false). --- * Slot: readonly Description: Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false). --- * Slot: name Description: Indexing property to store entity names when serializing them in a JSON-LD @index container. --- * Slot: Thing_id Description: Autocreated FK slot --- # Class: "ActionAffordance" Description: "An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time)." --- * Slot: safe Description: Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action. --- * Slot: synchronous Description: Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made. --- * Slot: idempotent Description: Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input. --- * Slot: title Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. --- * Slot: description Description: --- * Slot: titleInLanguage Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. --- * Slot: descriptionInLanguage Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. --- * Slot: name Description: Indexing property to store entity names when serializing them in a JSON-LD @index container. --- * Slot: Thing_id Description: Autocreated FK slot --- * Slot: input_id Description: Used to define the input data schema of the action. --- * Slot: output_id Description: Used to define the output data schema of the action. --- # Class: "EventAffordance" Description: "An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts)." --- * Slot: title Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. --- * Slot: description Description: --- * Slot: titleInLanguage Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. --- * Slot: descriptionInLanguage Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. --- * Slot: name Description: Indexing property to store entity names when serializing them in a JSON-LD @index container. --- * Slot: Thing_id Description: Autocreated FK slot --- * Slot: subscription_id Description: Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks. --- * Slot: cancellation_id Description: Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook. --- * Slot: notification_id Description: Defines the data schema of the Event instance messages pushed by the Thing. --- * Slot: notificationResponse_id Description: Defines the data schema of the Event response messages sent by the consumer in a response to a data message. --- # Class: "Thing" Description: "An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things." --- * Slot: id Description: TODO --- * Slot: title Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. --- * Slot: description Description: --- * Slot: titleInLanguage Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. --- * Slot: descriptionInLanguage Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. --- * Slot: instance Description: Provides a version identicator of this TD instance. --- * Slot: created Description: Provides information when the TD instance was created. --- * Slot: modified Description: Provides information when the TD instance was last modified. --- * Slot: supportContact Description: Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]). --- * Slot: base Description: Define the base URI that is used for all relative URI references throughout a TD document. --- * Slot: version_id Description: --- # Class: "Form_additionalReturns" Description: "" --- * Slot: Form_id Description: Autocreated FK slot --- * Slot: additionalReturns_id Description: This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema. --- # Class: "Form_operationType" Description: "" --- * Slot: Form_id Description: Autocreated FK slot --- * Slot: operationType Description: Indicates the semantic intention of performing the operation(s) described by the form. --- # Class: "SecurityScheme_@type" Description: "" --- * Slot: SecurityScheme_id Description: Autocreated FK slot --- * Slot: @type Description: --- # Class: "InteractionAffordance_uriVariables" Description: "" --- * Slot: InteractionAffordance_name Description: Autocreated FK slot --- * Slot: uriVariables_id Description: Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. --- # Class: "InteractionAffordance_forms" Description: "" --- * Slot: InteractionAffordance_name Description: Autocreated FK slot --- * Slot: forms_id Description: Set of form hypermedia controls that describe how an operation can be performed. --- # Class: "PropertyAffordance_uriVariables" Description: "" --- * Slot: PropertyAffordance_name Description: Autocreated FK slot --- * Slot: uriVariables_id Description: Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. --- # Class: "PropertyAffordance_forms" Description: "" --- * Slot: PropertyAffordance_name Description: Autocreated FK slot --- * Slot: forms_id Description: Set of form hypermedia controls that describe how an operation can be performed. --- # Class: "ActionAffordance_uriVariables" Description: "" --- * Slot: ActionAffordance_name Description: Autocreated FK slot --- * Slot: uriVariables_id Description: Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. --- # Class: "ActionAffordance_forms" Description: "" --- * Slot: ActionAffordance_name Description: Autocreated FK slot --- * Slot: forms_id Description: Set of form hypermedia controls that describe how an operation can be performed. --- # Class: "EventAffordance_uriVariables" Description: "" --- * Slot: EventAffordance_name Description: Autocreated FK slot --- * Slot: uriVariables_id Description: Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. --- # Class: "EventAffordance_forms" Description: "" --- * Slot: EventAffordance_name Description: Autocreated FK slot --- * Slot: forms_id Description: Set of form hypermedia controls that describe how an operation can be performed. --- # Class: "Thing_@type" Description: "" --- * Slot: Thing_id Description: Autocreated FK slot --- * Slot: @type Description: --- # Class: "Thing_securityDefinitions" Description: "" --- * Slot: Thing_id Description: Autocreated FK slot --- * Slot: securityDefinitions Description: A security scheme applied to a (set of) affordance(s). TODO check --- # Class: "Thing_security" Description: "" --- * Slot: Thing_id Description: Autocreated FK slot --- * Slot: security Description: A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check --- # Class: "Thing_schemaDefinitions" Description: "" --- * Slot: Thing_id Description: Autocreated FK slot --- * Slot: schemaDefinitions_id Description: TODO CHECK --- # Class: "Thing_profile" Description: "" --- * Slot: Thing_id Description: Autocreated FK slot --- * Slot: profile Description: Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation. --- # Class: "Thing_forms" Description: "" --- * Slot: Thing_id Description: Autocreated FK slot --- * Slot: forms_id Description: Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings. --- # Class: "Thing_links" Description: "" --- * Slot: Thing_id Description: Autocreated FK slot --- * Slot: links_id Description: Provides Web links to arbitrary resources that relate to the specified Thing Description. - -CREATE TABLE "VersionInfo" ( - id INTEGER NOT NULL, - instance TEXT NOT NULL, - model TEXT, - PRIMARY KEY (id) -); -CREATE TABLE "MultiLanguage" ( - "key" TEXT NOT NULL, - "SecurityScheme_id" INTEGER, - "InteractionAffordance_name" TEXT, - "PropertyAffordance_name" TEXT, - "ActionAffordance_name" TEXT, - "EventAffordance_name" TEXT, - "Thing_id" TEXT, - PRIMARY KEY ("key"), - FOREIGN KEY("SecurityScheme_id") REFERENCES "SecurityScheme" (id), - FOREIGN KEY("InteractionAffordance_name") REFERENCES "InteractionAffordance" (name), - FOREIGN KEY("PropertyAffordance_name") REFERENCES "PropertyAffordance" (name), - FOREIGN KEY("ActionAffordance_name") REFERENCES "ActionAffordance" (name), - FOREIGN KEY("EventAffordance_name") REFERENCES "EventAffordance" (name), - FOREIGN KEY("Thing_id") REFERENCES "Thing" (id) -); -CREATE TABLE "Link" ( - id INTEGER NOT NULL, - target TEXT NOT NULL, - "hintsAtMediaType" TEXT, - type TEXT, - relation TEXT, - anchor TEXT, - sizes TEXT, - hreflang TEXT, - PRIMARY KEY (id) -); -CREATE TABLE "ExpectedResponse" ( - id INTEGER NOT NULL, - "contentType" TEXT NOT NULL, - PRIMARY KEY (id) -); -CREATE TABLE "AdditionalExpectedResponse" ( - id INTEGER NOT NULL, - "additionalOutputSchema" TEXT, - success BOOLEAN, - schema TEXT, - "contentType" TEXT NOT NULL, - PRIMARY KEY (id) -); -CREATE TABLE "SecurityScheme" ( - id INTEGER NOT NULL, - description TEXT, - proxy TEXT, - scheme VARCHAR(6) NOT NULL, - PRIMARY KEY (id) -); -CREATE TABLE "DataSchema" ( - id INTEGER NOT NULL, - description TEXT, - title TEXT, - "titleInLanguage" TEXT, - "descriptionInLanguage" TEXT, - "propertyName" TEXT, - "writeOnly" TEXT, - readonly TEXT, - PRIMARY KEY (id), - FOREIGN KEY(description) REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY(title) REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("titleInLanguage") REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("descriptionInLanguage") REFERENCES "MultiLanguage" ("key") -); -CREATE TABLE "InteractionAffordance" ( - title TEXT, - description TEXT, - "titleInLanguage" TEXT, - "descriptionInLanguage" TEXT, - name TEXT NOT NULL, - PRIMARY KEY (name), - FOREIGN KEY(title) REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY(description) REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("titleInLanguage") REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("descriptionInLanguage") REFERENCES "MultiLanguage" ("key") -); -CREATE TABLE "PropertyAffordance" ( - observable BOOLEAN, - description TEXT, - title TEXT, - "titleInLanguage" TEXT, - "descriptionInLanguage" TEXT, - "propertyName" TEXT, - "writeOnly" TEXT, - readonly TEXT, - name TEXT NOT NULL, - "Thing_id" TEXT, - PRIMARY KEY (name), - FOREIGN KEY(description) REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY(title) REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("titleInLanguage") REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("descriptionInLanguage") REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("Thing_id") REFERENCES "Thing" (id) -); -CREATE TABLE "ActionAffordance" ( - safe BOOLEAN, - synchronous BOOLEAN, - idempotent BOOLEAN, - title TEXT, - description TEXT, - "titleInLanguage" TEXT, - "descriptionInLanguage" TEXT, - name TEXT NOT NULL, - "Thing_id" TEXT, - input_id INTEGER, - output_id INTEGER, - PRIMARY KEY (name), - FOREIGN KEY(title) REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY(description) REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("titleInLanguage") REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("descriptionInLanguage") REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("Thing_id") REFERENCES "Thing" (id), - FOREIGN KEY(input_id) REFERENCES "DataSchema" (id), - FOREIGN KEY(output_id) REFERENCES "DataSchema" (id) -); -CREATE TABLE "EventAffordance" ( - title TEXT, - description TEXT, - "titleInLanguage" TEXT, - "descriptionInLanguage" TEXT, - name TEXT NOT NULL, - "Thing_id" TEXT, - subscription_id INTEGER, - cancellation_id INTEGER, - notification_id INTEGER, - "notificationResponse_id" INTEGER, - PRIMARY KEY (name), - FOREIGN KEY(title) REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY(description) REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("titleInLanguage") REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("descriptionInLanguage") REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("Thing_id") REFERENCES "Thing" (id), - FOREIGN KEY(subscription_id) REFERENCES "DataSchema" (id), - FOREIGN KEY(cancellation_id) REFERENCES "DataSchema" (id), - FOREIGN KEY(notification_id) REFERENCES "DataSchema" (id), - FOREIGN KEY("notificationResponse_id") REFERENCES "DataSchema" (id) -); -CREATE TABLE "Thing" ( - id TEXT NOT NULL, - title TEXT, - description TEXT, - "titleInLanguage" TEXT, - "descriptionInLanguage" TEXT, - instance TEXT, - created DATETIME, - modified DATETIME, - "supportContact" TEXT, - base TEXT, - version_id INTEGER, - PRIMARY KEY (id), - FOREIGN KEY(title) REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY(description) REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("titleInLanguage") REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY("descriptionInLanguage") REFERENCES "MultiLanguage" ("key"), - FOREIGN KEY(version_id) REFERENCES "VersionInfo" (id) -); -CREATE TABLE "Form" ( - id INTEGER NOT NULL, - target TEXT NOT NULL, - href TEXT NOT NULL, - "contentType" TEXT, - "contentCoding" TEXT, - "securityDefinitions" TEXT, - scopes TEXT, - subprotocol TEXT, - returns_id INTEGER, - PRIMARY KEY (id), - FOREIGN KEY(returns_id) REFERENCES "ExpectedResponse" (id) -); -CREATE TABLE "SecurityScheme_@type" ( - "SecurityScheme_id" INTEGER, - "@type" TEXT, - PRIMARY KEY ("SecurityScheme_id", "@type"), - FOREIGN KEY("SecurityScheme_id") REFERENCES "SecurityScheme" (id) -); -CREATE TABLE "InteractionAffordance_uriVariables" ( - "InteractionAffordance_name" TEXT, - "uriVariables_id" INTEGER, - PRIMARY KEY ("InteractionAffordance_name", "uriVariables_id"), - FOREIGN KEY("InteractionAffordance_name") REFERENCES "InteractionAffordance" (name), - FOREIGN KEY("uriVariables_id") REFERENCES "DataSchema" (id) -); -CREATE TABLE "PropertyAffordance_uriVariables" ( - "PropertyAffordance_name" TEXT, - "uriVariables_id" INTEGER, - PRIMARY KEY ("PropertyAffordance_name", "uriVariables_id"), - FOREIGN KEY("PropertyAffordance_name") REFERENCES "PropertyAffordance" (name), - FOREIGN KEY("uriVariables_id") REFERENCES "DataSchema" (id) -); -CREATE TABLE "ActionAffordance_uriVariables" ( - "ActionAffordance_name" TEXT, - "uriVariables_id" INTEGER, - PRIMARY KEY ("ActionAffordance_name", "uriVariables_id"), - FOREIGN KEY("ActionAffordance_name") REFERENCES "ActionAffordance" (name), - FOREIGN KEY("uriVariables_id") REFERENCES "DataSchema" (id) -); -CREATE TABLE "EventAffordance_uriVariables" ( - "EventAffordance_name" TEXT, - "uriVariables_id" INTEGER, - PRIMARY KEY ("EventAffordance_name", "uriVariables_id"), - FOREIGN KEY("EventAffordance_name") REFERENCES "EventAffordance" (name), - FOREIGN KEY("uriVariables_id") REFERENCES "DataSchema" (id) -); -CREATE TABLE "Thing_@type" ( - "Thing_id" TEXT, - "@type" TEXT, - PRIMARY KEY ("Thing_id", "@type"), - FOREIGN KEY("Thing_id") REFERENCES "Thing" (id) -); -CREATE TABLE "Thing_securityDefinitions" ( - "Thing_id" TEXT, - "securityDefinitions" TEXT, - PRIMARY KEY ("Thing_id", "securityDefinitions"), - FOREIGN KEY("Thing_id") REFERENCES "Thing" (id) -); -CREATE TABLE "Thing_security" ( - "Thing_id" TEXT, - security TEXT, - PRIMARY KEY ("Thing_id", security), - FOREIGN KEY("Thing_id") REFERENCES "Thing" (id) -); -CREATE TABLE "Thing_schemaDefinitions" ( - "Thing_id" TEXT, - "schemaDefinitions_id" INTEGER, - PRIMARY KEY ("Thing_id", "schemaDefinitions_id"), - FOREIGN KEY("Thing_id") REFERENCES "Thing" (id), - FOREIGN KEY("schemaDefinitions_id") REFERENCES "DataSchema" (id) -); -CREATE TABLE "Thing_profile" ( - "Thing_id" TEXT, - profile TEXT, - PRIMARY KEY ("Thing_id", profile), - FOREIGN KEY("Thing_id") REFERENCES "Thing" (id) -); -CREATE TABLE "Thing_links" ( - "Thing_id" TEXT, - links_id INTEGER, - PRIMARY KEY ("Thing_id", links_id), - FOREIGN KEY("Thing_id") REFERENCES "Thing" (id), - FOREIGN KEY(links_id) REFERENCES "Link" (id) -); -CREATE TABLE "Form_additionalReturns" ( - "Form_id" INTEGER, - "additionalReturns_id" INTEGER, - PRIMARY KEY ("Form_id", "additionalReturns_id"), - FOREIGN KEY("Form_id") REFERENCES "Form" (id), - FOREIGN KEY("additionalReturns_id") REFERENCES "AdditionalExpectedResponse" (id) -); -CREATE TABLE "Form_operationType" ( - "Form_id" INTEGER, - "operationType" VARCHAR(23), - PRIMARY KEY ("Form_id", "operationType"), - FOREIGN KEY("Form_id") REFERENCES "Form" (id) -); -CREATE TABLE "InteractionAffordance_forms" ( - "InteractionAffordance_name" TEXT, - forms_id INTEGER, - PRIMARY KEY ("InteractionAffordance_name", forms_id), - FOREIGN KEY("InteractionAffordance_name") REFERENCES "InteractionAffordance" (name), - FOREIGN KEY(forms_id) REFERENCES "Form" (id) -); -CREATE TABLE "PropertyAffordance_forms" ( - "PropertyAffordance_name" TEXT, - forms_id INTEGER, - PRIMARY KEY ("PropertyAffordance_name", forms_id), - FOREIGN KEY("PropertyAffordance_name") REFERENCES "PropertyAffordance" (name), - FOREIGN KEY(forms_id) REFERENCES "Form" (id) -); -CREATE TABLE "ActionAffordance_forms" ( - "ActionAffordance_name" TEXT, - forms_id INTEGER, - PRIMARY KEY ("ActionAffordance_name", forms_id), - FOREIGN KEY("ActionAffordance_name") REFERENCES "ActionAffordance" (name), - FOREIGN KEY(forms_id) REFERENCES "Form" (id) -); -CREATE TABLE "EventAffordance_forms" ( - "EventAffordance_name" TEXT, - forms_id INTEGER, - PRIMARY KEY ("EventAffordance_name", forms_id), - FOREIGN KEY("EventAffordance_name") REFERENCES "EventAffordance" (name), - FOREIGN KEY(forms_id) REFERENCES "Form" (id) -); -CREATE TABLE "Thing_forms" ( - "Thing_id" TEXT, - forms_id INTEGER, - PRIMARY KEY ("Thing_id", forms_id), - FOREIGN KEY("Thing_id") REFERENCES "Thing" (id), - FOREIGN KEY(forms_id) REFERENCES "Form" (id) -); \ No newline at end of file From 123432bb9fadd2719635ac28f52e75e33bd8fd3d Mon Sep 17 00:00:00 2001 From: mahdanoura <mahda.noura@siemens.com> Date: Wed, 22 May 2024 22:19:28 +0200 Subject: [PATCH 04/10] unrequired WoT resources removed --- resources/gens/docs/@type.md | 69 -- resources/gens/docs/ActionAffordance.md | 403 ------------ .../gens/docs/AdditionalExpectedResponse.md | 197 ------ resources/gens/docs/AnyUri.md | 38 -- resources/gens/docs/Boolean.md | 39 -- resources/gens/docs/Curie.md | 44 -- resources/gens/docs/DataSchema.md | 262 -------- resources/gens/docs/Date.md | 39 -- resources/gens/docs/DateOrDatetime.md | 39 -- resources/gens/docs/Datetime.md | 39 -- resources/gens/docs/Decimal.md | 38 -- resources/gens/docs/Double.md | 38 -- resources/gens/docs/EventAffordance.md | 378 ----------- resources/gens/docs/ExpectedResponse.md | 137 ---- resources/gens/docs/Float.md | 38 -- resources/gens/docs/Form.md | 359 ---------- resources/gens/docs/Integer.md | 38 -- resources/gens/docs/InteractionAffordance.md | 310 --------- resources/gens/docs/Jsonpath.md | 39 -- resources/gens/docs/Jsonpointer.md | 39 -- resources/gens/docs/Link.md | 260 -------- resources/gens/docs/MultiLanguage.md | 154 ----- resources/gens/docs/Ncname.md | 39 -- resources/gens/docs/Nodeidentifier.md | 39 -- resources/gens/docs/Objectidentifier.md | 43 -- resources/gens/docs/OperationTypes.md | 167 ----- resources/gens/docs/PropertyAffordance.md | 350 ---------- resources/gens/docs/SecurityScheme.md | 194 ------ resources/gens/docs/SecuritySchemeType.md | 106 --- resources/gens/docs/Sparqlpath.md | 39 -- resources/gens/docs/String.md | 38 -- resources/gens/docs/Thing.md | 620 ------------------ resources/gens/docs/Time.md | 39 -- resources/gens/docs/Uri.md | 43 -- resources/gens/docs/Uriorcurie.md | 39 -- resources/gens/docs/VersionInfo.md | 145 ---- resources/gens/docs/about.md | 3 - .../gens/docs/actionAffordance__idempotent.md | 22 - .../gens/docs/actionAffordance__input.md | 22 - .../gens/docs/actionAffordance__output.md | 22 - resources/gens/docs/actionAffordance__safe.md | 22 - .../docs/actionAffordance__synchronous.md | 22 - resources/gens/docs/actions.md | 75 --- ...xpectedResponse__additionalOutputSchema.md | 22 - .../additionalExpectedResponse__schema.md | 22 - .../additionalExpectedResponse__success.md | 22 - resources/gens/docs/additionalOutputSchema.md | 74 --- resources/gens/docs/additionalReturns.md | 77 --- resources/gens/docs/anchor.md | 73 --- resources/gens/docs/base.md | 72 -- resources/gens/docs/cancellation.md | 72 -- resources/gens/docs/contentCoding.md | 75 --- resources/gens/docs/contentType.md | 58 -- resources/gens/docs/created.md | 71 -- .../gens/docs/dataSchema__propertyName.md | 23 - resources/gens/docs/dataSchema__readonly.md | 23 - resources/gens/docs/dataSchema__writeOnly.md | 23 - resources/gens/docs/description.md | 73 --- resources/gens/docs/descriptionInLanguage.md | 79 --- resources/gens/docs/descriptions.md | 82 --- .../docs/eventAffordance__cancellation.md | 22 - .../docs/eventAffordance__notification.md | 22 - .../eventAffordance__notificationResponse.md | 22 - .../docs/eventAffordance__subscription.md | 22 - resources/gens/docs/events.md | 75 --- .../docs/expectedResponse__contentType.md | 23 - .../gens/docs/form__additionalReturns.md | 22 - resources/gens/docs/form__contentCoding.md | 22 - resources/gens/docs/form__contentType.md | 22 - resources/gens/docs/form__href.md | 22 - resources/gens/docs/form__operationType.md | 22 - resources/gens/docs/form__returns.md | 22 - resources/gens/docs/form__scopes.md | 22 - .../gens/docs/form__securityDefinitions.md | 22 - resources/gens/docs/form__subprotocol.md | 22 - resources/gens/docs/forms.md | 60 -- resources/gens/docs/hintsAtMediaType.md | 72 -- resources/gens/docs/href.md | 68 -- resources/gens/docs/hreflang.md | 75 --- resources/gens/docs/id.md | 75 --- resources/gens/docs/idempotent.md | 73 --- resources/gens/docs/index.md | 135 ---- resources/gens/docs/input.md | 71 -- resources/gens/docs/instance.md | 57 -- .../gens/docs/interactionAffordance__forms.md | 25 - .../gens/docs/interactionAffordance__name.md | 25 - .../interactionAffordance__uriVariables.md | 25 - resources/gens/docs/key.md | 72 -- resources/gens/docs/link__anchor.md | 22 - resources/gens/docs/link__hintsAtMediaType.md | 22 - resources/gens/docs/link__hreflang.md | 22 - resources/gens/docs/link__relation.md | 22 - resources/gens/docs/link__sizes.md | 22 - resources/gens/docs/link__type.md | 22 - resources/gens/docs/links.md | 75 --- resources/gens/docs/model.md | 65 -- resources/gens/docs/modified.md | 71 -- resources/gens/docs/multiLanguage__key.md | 22 - resources/gens/docs/name.md | 79 --- resources/gens/docs/notification.md | 72 -- resources/gens/docs/notificationResponse.md | 72 -- resources/gens/docs/observable.md | 73 --- resources/gens/docs/operationType.md | 75 --- resources/gens/docs/output.md | 71 -- resources/gens/docs/profile.md | 75 --- resources/gens/docs/properties.md | 75 --- .../docs/propertyAffordance__observable.md | 22 - resources/gens/docs/propertyName.md | 73 --- resources/gens/docs/proxy.md | 72 -- resources/gens/docs/readonly.md | 73 --- resources/gens/docs/relation.md | 71 -- resources/gens/docs/returns.md | 73 --- resources/gens/docs/safe.md | 72 -- resources/gens/docs/schema.md | 71 -- resources/gens/docs/schemaDefinitions.md | 74 --- resources/gens/docs/scheme.md | 68 -- resources/gens/docs/scopes.md | 71 -- resources/gens/docs/security.md | 75 --- resources/gens/docs/securityDefinitions.md | 57 -- .../gens/docs/securityScheme__description.md | 22 - resources/gens/docs/securityScheme__proxy.md | 22 - resources/gens/docs/securityScheme__scheme.md | 22 - resources/gens/docs/sizes.md | 73 --- resources/gens/docs/subprotocol.md | 72 -- resources/gens/docs/subscription.md | 72 -- resources/gens/docs/success.md | 71 -- resources/gens/docs/supportContact.md | 72 -- resources/gens/docs/synchronous.md | 75 --- resources/gens/docs/target.md | 76 --- .../gens/docs/thing-description-schema.md | 7 - resources/gens/docs/thing__actions.md | 22 - resources/gens/docs/thing__base.md | 22 - resources/gens/docs/thing__created.md | 22 - resources/gens/docs/thing__events.md | 22 - resources/gens/docs/thing__forms.md | 22 - resources/gens/docs/thing__instance.md | 22 - resources/gens/docs/thing__links.md | 22 - resources/gens/docs/thing__modified.md | 22 - resources/gens/docs/thing__profile.md | 22 - resources/gens/docs/thing__properties.md | 22 - .../gens/docs/thing__schemaDefinitions.md | 22 - resources/gens/docs/thing__security.md | 22 - .../gens/docs/thing__securityDefinitions.md | 22 - resources/gens/docs/thing__supportContact.md | 22 - resources/gens/docs/thing__version.md | 22 - .../gens/docs/thing_description_schema.md | 150 ----- resources/gens/docs/title.md | 79 --- resources/gens/docs/titleInLanguage.md | 79 --- resources/gens/docs/titles.md | 73 --- resources/gens/docs/type.md | 65 -- resources/gens/docs/types/AnyUri.md | 11 - resources/gens/docs/types/Boolean.md | 19 - resources/gens/docs/types/Curie.md | 20 - resources/gens/docs/types/Date.md | 19 - resources/gens/docs/types/DateOrDatetime.md | 12 - resources/gens/docs/types/Datetime.md | 19 - resources/gens/docs/types/Decimal.md | 18 - resources/gens/docs/types/Double.md | 18 - resources/gens/docs/types/Float.md | 18 - resources/gens/docs/types/Integer.md | 18 - resources/gens/docs/types/Jsonpath.md | 12 - resources/gens/docs/types/Jsonpointer.md | 12 - resources/gens/docs/types/Ncname.md | 12 - resources/gens/docs/types/Nodeidentifier.md | 12 - resources/gens/docs/types/Objectidentifier.md | 19 - resources/gens/docs/types/Sparqlpath.md | 12 - resources/gens/docs/types/String.md | 18 - resources/gens/docs/types/Time.md | 19 - resources/gens/docs/types/Uri.md | 20 - resources/gens/docs/types/Uriorcurie.md | 12 - resources/gens/docs/uriVariables.md | 79 --- resources/gens/docs/version.md | 65 -- resources/gens/docs/versionInfo__instance.md | 22 - resources/gens/docs/versionInfo__model.md | 22 - resources/gens/docs/writeOnly.md | 73 --- src/linkml/config.yaml | 6 +- 176 files changed, 2 insertions(+), 11018 deletions(-) delete mode 100644 resources/gens/docs/@type.md delete mode 100644 resources/gens/docs/ActionAffordance.md delete mode 100644 resources/gens/docs/AdditionalExpectedResponse.md delete mode 100644 resources/gens/docs/AnyUri.md delete mode 100644 resources/gens/docs/Boolean.md delete mode 100644 resources/gens/docs/Curie.md delete mode 100644 resources/gens/docs/DataSchema.md delete mode 100644 resources/gens/docs/Date.md delete mode 100644 resources/gens/docs/DateOrDatetime.md delete mode 100644 resources/gens/docs/Datetime.md delete mode 100644 resources/gens/docs/Decimal.md delete mode 100644 resources/gens/docs/Double.md delete mode 100644 resources/gens/docs/EventAffordance.md delete mode 100644 resources/gens/docs/ExpectedResponse.md delete mode 100644 resources/gens/docs/Float.md delete mode 100644 resources/gens/docs/Form.md delete mode 100644 resources/gens/docs/Integer.md delete mode 100644 resources/gens/docs/InteractionAffordance.md delete mode 100644 resources/gens/docs/Jsonpath.md delete mode 100644 resources/gens/docs/Jsonpointer.md delete mode 100644 resources/gens/docs/Link.md delete mode 100644 resources/gens/docs/MultiLanguage.md delete mode 100644 resources/gens/docs/Ncname.md delete mode 100644 resources/gens/docs/Nodeidentifier.md delete mode 100644 resources/gens/docs/Objectidentifier.md delete mode 100644 resources/gens/docs/OperationTypes.md delete mode 100644 resources/gens/docs/PropertyAffordance.md delete mode 100644 resources/gens/docs/SecurityScheme.md delete mode 100644 resources/gens/docs/SecuritySchemeType.md delete mode 100644 resources/gens/docs/Sparqlpath.md delete mode 100644 resources/gens/docs/String.md delete mode 100644 resources/gens/docs/Thing.md delete mode 100644 resources/gens/docs/Time.md delete mode 100644 resources/gens/docs/Uri.md delete mode 100644 resources/gens/docs/Uriorcurie.md delete mode 100644 resources/gens/docs/VersionInfo.md delete mode 100644 resources/gens/docs/about.md delete mode 100644 resources/gens/docs/actionAffordance__idempotent.md delete mode 100644 resources/gens/docs/actionAffordance__input.md delete mode 100644 resources/gens/docs/actionAffordance__output.md delete mode 100644 resources/gens/docs/actionAffordance__safe.md delete mode 100644 resources/gens/docs/actionAffordance__synchronous.md delete mode 100644 resources/gens/docs/actions.md delete mode 100644 resources/gens/docs/additionalExpectedResponse__additionalOutputSchema.md delete mode 100644 resources/gens/docs/additionalExpectedResponse__schema.md delete mode 100644 resources/gens/docs/additionalExpectedResponse__success.md delete mode 100644 resources/gens/docs/additionalOutputSchema.md delete mode 100644 resources/gens/docs/additionalReturns.md delete mode 100644 resources/gens/docs/anchor.md delete mode 100644 resources/gens/docs/base.md delete mode 100644 resources/gens/docs/cancellation.md delete mode 100644 resources/gens/docs/contentCoding.md delete mode 100644 resources/gens/docs/contentType.md delete mode 100644 resources/gens/docs/created.md delete mode 100644 resources/gens/docs/dataSchema__propertyName.md delete mode 100644 resources/gens/docs/dataSchema__readonly.md delete mode 100644 resources/gens/docs/dataSchema__writeOnly.md delete mode 100644 resources/gens/docs/description.md delete mode 100644 resources/gens/docs/descriptionInLanguage.md delete mode 100644 resources/gens/docs/descriptions.md delete mode 100644 resources/gens/docs/eventAffordance__cancellation.md delete mode 100644 resources/gens/docs/eventAffordance__notification.md delete mode 100644 resources/gens/docs/eventAffordance__notificationResponse.md delete mode 100644 resources/gens/docs/eventAffordance__subscription.md delete mode 100644 resources/gens/docs/events.md delete mode 100644 resources/gens/docs/expectedResponse__contentType.md delete mode 100644 resources/gens/docs/form__additionalReturns.md delete mode 100644 resources/gens/docs/form__contentCoding.md delete mode 100644 resources/gens/docs/form__contentType.md delete mode 100644 resources/gens/docs/form__href.md delete mode 100644 resources/gens/docs/form__operationType.md delete mode 100644 resources/gens/docs/form__returns.md delete mode 100644 resources/gens/docs/form__scopes.md delete mode 100644 resources/gens/docs/form__securityDefinitions.md delete mode 100644 resources/gens/docs/form__subprotocol.md delete mode 100644 resources/gens/docs/forms.md delete mode 100644 resources/gens/docs/hintsAtMediaType.md delete mode 100644 resources/gens/docs/href.md delete mode 100644 resources/gens/docs/hreflang.md delete mode 100644 resources/gens/docs/id.md delete mode 100644 resources/gens/docs/idempotent.md delete mode 100644 resources/gens/docs/index.md delete mode 100644 resources/gens/docs/input.md delete mode 100644 resources/gens/docs/instance.md delete mode 100644 resources/gens/docs/interactionAffordance__forms.md delete mode 100644 resources/gens/docs/interactionAffordance__name.md delete mode 100644 resources/gens/docs/interactionAffordance__uriVariables.md delete mode 100644 resources/gens/docs/key.md delete mode 100644 resources/gens/docs/link__anchor.md delete mode 100644 resources/gens/docs/link__hintsAtMediaType.md delete mode 100644 resources/gens/docs/link__hreflang.md delete mode 100644 resources/gens/docs/link__relation.md delete mode 100644 resources/gens/docs/link__sizes.md delete mode 100644 resources/gens/docs/link__type.md delete mode 100644 resources/gens/docs/links.md delete mode 100644 resources/gens/docs/model.md delete mode 100644 resources/gens/docs/modified.md delete mode 100644 resources/gens/docs/multiLanguage__key.md delete mode 100644 resources/gens/docs/name.md delete mode 100644 resources/gens/docs/notification.md delete mode 100644 resources/gens/docs/notificationResponse.md delete mode 100644 resources/gens/docs/observable.md delete mode 100644 resources/gens/docs/operationType.md delete mode 100644 resources/gens/docs/output.md delete mode 100644 resources/gens/docs/profile.md delete mode 100644 resources/gens/docs/properties.md delete mode 100644 resources/gens/docs/propertyAffordance__observable.md delete mode 100644 resources/gens/docs/propertyName.md delete mode 100644 resources/gens/docs/proxy.md delete mode 100644 resources/gens/docs/readonly.md delete mode 100644 resources/gens/docs/relation.md delete mode 100644 resources/gens/docs/returns.md delete mode 100644 resources/gens/docs/safe.md delete mode 100644 resources/gens/docs/schema.md delete mode 100644 resources/gens/docs/schemaDefinitions.md delete mode 100644 resources/gens/docs/scheme.md delete mode 100644 resources/gens/docs/scopes.md delete mode 100644 resources/gens/docs/security.md delete mode 100644 resources/gens/docs/securityDefinitions.md delete mode 100644 resources/gens/docs/securityScheme__description.md delete mode 100644 resources/gens/docs/securityScheme__proxy.md delete mode 100644 resources/gens/docs/securityScheme__scheme.md delete mode 100644 resources/gens/docs/sizes.md delete mode 100644 resources/gens/docs/subprotocol.md delete mode 100644 resources/gens/docs/subscription.md delete mode 100644 resources/gens/docs/success.md delete mode 100644 resources/gens/docs/supportContact.md delete mode 100644 resources/gens/docs/synchronous.md delete mode 100644 resources/gens/docs/target.md delete mode 100644 resources/gens/docs/thing-description-schema.md delete mode 100644 resources/gens/docs/thing__actions.md delete mode 100644 resources/gens/docs/thing__base.md delete mode 100644 resources/gens/docs/thing__created.md delete mode 100644 resources/gens/docs/thing__events.md delete mode 100644 resources/gens/docs/thing__forms.md delete mode 100644 resources/gens/docs/thing__instance.md delete mode 100644 resources/gens/docs/thing__links.md delete mode 100644 resources/gens/docs/thing__modified.md delete mode 100644 resources/gens/docs/thing__profile.md delete mode 100644 resources/gens/docs/thing__properties.md delete mode 100644 resources/gens/docs/thing__schemaDefinitions.md delete mode 100644 resources/gens/docs/thing__security.md delete mode 100644 resources/gens/docs/thing__securityDefinitions.md delete mode 100644 resources/gens/docs/thing__supportContact.md delete mode 100644 resources/gens/docs/thing__version.md delete mode 100644 resources/gens/docs/thing_description_schema.md delete mode 100644 resources/gens/docs/title.md delete mode 100644 resources/gens/docs/titleInLanguage.md delete mode 100644 resources/gens/docs/titles.md delete mode 100644 resources/gens/docs/type.md delete mode 100644 resources/gens/docs/types/AnyUri.md delete mode 100644 resources/gens/docs/types/Boolean.md delete mode 100644 resources/gens/docs/types/Curie.md delete mode 100644 resources/gens/docs/types/Date.md delete mode 100644 resources/gens/docs/types/DateOrDatetime.md delete mode 100644 resources/gens/docs/types/Datetime.md delete mode 100644 resources/gens/docs/types/Decimal.md delete mode 100644 resources/gens/docs/types/Double.md delete mode 100644 resources/gens/docs/types/Float.md delete mode 100644 resources/gens/docs/types/Integer.md delete mode 100644 resources/gens/docs/types/Jsonpath.md delete mode 100644 resources/gens/docs/types/Jsonpointer.md delete mode 100644 resources/gens/docs/types/Ncname.md delete mode 100644 resources/gens/docs/types/Nodeidentifier.md delete mode 100644 resources/gens/docs/types/Objectidentifier.md delete mode 100644 resources/gens/docs/types/Sparqlpath.md delete mode 100644 resources/gens/docs/types/String.md delete mode 100644 resources/gens/docs/types/Time.md delete mode 100644 resources/gens/docs/types/Uri.md delete mode 100644 resources/gens/docs/types/Uriorcurie.md delete mode 100644 resources/gens/docs/uriVariables.md delete mode 100644 resources/gens/docs/version.md delete mode 100644 resources/gens/docs/versionInfo__instance.md delete mode 100644 resources/gens/docs/versionInfo__model.md delete mode 100644 resources/gens/docs/writeOnly.md diff --git a/resources/gens/docs/@type.md b/resources/gens/docs/@type.md deleted file mode 100644 index 8c36b3e..0000000 --- a/resources/gens/docs/@type.md +++ /dev/null @@ -1,69 +0,0 @@ - - -# Slot: @type - -URI: [td:@type](https://www.w3.org/2019/wot/td#@type) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [SecurityScheme](SecurityScheme.md) | | no | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - -* Multivalued: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: '@type' -from_schema: td -rank: 1000 -multivalued: true -alias: '@type' -domain_of: -- SecurityScheme -- Thing -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/ActionAffordance.md b/resources/gens/docs/ActionAffordance.md deleted file mode 100644 index 37d321f..0000000 --- a/resources/gens/docs/ActionAffordance.md +++ /dev/null @@ -1,403 +0,0 @@ - - -# Class: ActionAffordance - - -_An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time)._ - - - - - -URI: [td:ActionAffordance](https://www.w3.org/2019/wot/td#ActionAffordance) - - - - -```mermaid - classDiagram - class ActionAffordance - InteractionAffordance <|-- ActionAffordance - - ActionAffordance : description - - ActionAffordance --> MultiLanguage : description - - ActionAffordance : descriptionInLanguage - - ActionAffordance --> MultiLanguage : descriptionInLanguage - - ActionAffordance : descriptions - - ActionAffordance --> MultiLanguage : descriptions - - ActionAffordance : forms - - ActionAffordance --> Form : forms - - ActionAffordance : idempotent - - ActionAffordance : input - - ActionAffordance --> DataSchema : input - - ActionAffordance : name - - ActionAffordance : output - - ActionAffordance --> DataSchema : output - - ActionAffordance : safe - - ActionAffordance : synchronous - - ActionAffordance : title - - ActionAffordance --> MultiLanguage : title - - ActionAffordance : titleInLanguage - - ActionAffordance --> MultiLanguage : titleInLanguage - - ActionAffordance : titles - - ActionAffordance --> MultiLanguage : titles - - ActionAffordance : uriVariables - - ActionAffordance --> DataSchema : uriVariables - - -``` - - - - - -## Inheritance -* [InteractionAffordance](InteractionAffordance.md) - * **ActionAffordance** - - - -## Slots - -| Name | Cardinality and Range | Description | Inheritance | -| --- | --- | --- | --- | -| [safe](safe.md) | 0..1 <br/> [Boolean](Boolean.md) | Signals if the action is safe (=true) or not | direct | -| [synchronous](synchronous.md) | 0..1 <br/> [Boolean](Boolean.md) | Indicates whether the action is synchronous (=true) or not | direct | -| [idempotent](idempotent.md) | 0..1 <br/> [Boolean](Boolean.md) | Indicates whether the action is idempotent (=true) or not | direct | -| [input](input.md) | 0..1 <br/> [DataSchema](DataSchema.md) | Used to define the input data schema of the action | direct | -| [output](output.md) | 0..1 <br/> [DataSchema](DataSchema.md) | Used to define the output data schema of the action | direct | -| [titles](titles.md) | 0..* <br/> [MultiLanguage](MultiLanguage.md) | | [InteractionAffordance](InteractionAffordance.md) | -| [descriptions](descriptions.md) | 0..* <br/> [MultiLanguage](MultiLanguage.md) | TODO, check, according to the description a description should not contain a ... | [InteractionAffordance](InteractionAffordance.md) | -| [title](title.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | Provides a human-readable title (e | [InteractionAffordance](InteractionAffordance.md) | -| [description](description.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | | [InteractionAffordance](InteractionAffordance.md) | -| [titleInLanguage](titleInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | [InteractionAffordance](InteractionAffordance.md) | -| [descriptionInLanguage](descriptionInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | [InteractionAffordance](InteractionAffordance.md) | -| [name](name.md) | 1..1 <br/> [String](String.md) | Indexing property to store entity names when serializing them in a JSON-LD @i... | [InteractionAffordance](InteractionAffordance.md) | -| [uriVariables](uriVariables.md) | 0..* <br/> [DataSchema](DataSchema.md) | Define URI template variables according to RFC6570 as collection based on sch... | [InteractionAffordance](InteractionAffordance.md) | -| [forms](forms.md) | 0..* <br/> [Form](Form.md) | Set of form hypermedia controls that describe how an operation can be perform... | [InteractionAffordance](InteractionAffordance.md) | - - - - - -## Usages - -| used by | used in | type | used | -| --- | --- | --- | --- | -| [Thing](Thing.md) | [actions](actions.md) | range | [ActionAffordance](ActionAffordance.md) | - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - - -## Mappings - -| Mapping Type | Mapped Value | -| --- | --- | -| self | td:ActionAffordance | -| native | td:ActionAffordance | - - - - - -## LinkML Source - -<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> - -### Direct - -<details> -```yaml -name: ActionAffordance -description: An Interaction Affordance that allows to invoke a function of the Thing, - which manipulates state (e.g., toggling a lamp on or off) or triggers a process - on the Thing (e.g., dim a lamp over time). -from_schema: td -is_a: InteractionAffordance -attributes: - safe: - name: safe - description: Signals if the action is safe (=true) or not. Used to signal if there - is no internal state (cf. resource state) is changed when invoking an Action. - from_schema: td - rank: 1000 - domain_of: - - ActionAffordance - range: boolean - synchronous: - name: synchronous - description: Indicates whether the action is synchronous (=true) or not. A synchronous - action means that the response of action contains all the information about - the result of the action and no further querying about the status of the action - is needed. Lack of this keyword means that no claim on the synchronicity of - the action can be made. - from_schema: td - rank: 1000 - domain_of: - - ActionAffordance - range: boolean - idempotent: - name: idempotent - description: Indicates whether the action is idempotent (=true) or not. Informs - whether the action can be called repeatedly with the same results, if present, - based on the same input. - from_schema: td - rank: 1000 - domain_of: - - ActionAffordance - range: boolean - input: - name: input - description: Used to define the input data schema of the action. - from_schema: td - rank: 1000 - domain_of: - - ActionAffordance - range: DataSchema - output: - name: output - description: Used to define the output data schema of the action. - from_schema: td - rank: 1000 - domain_of: - - ActionAffordance - range: DataSchema -class_uri: td:ActionAffordance - -``` -</details> - -### Induced - -<details> -```yaml -name: ActionAffordance -description: An Interaction Affordance that allows to invoke a function of the Thing, - which manipulates state (e.g., toggling a lamp on or off) or triggers a process - on the Thing (e.g., dim a lamp over time). -from_schema: td -is_a: InteractionAffordance -attributes: - safe: - name: safe - description: Signals if the action is safe (=true) or not. Used to signal if there - is no internal state (cf. resource state) is changed when invoking an Action. - from_schema: td - rank: 1000 - alias: safe - owner: ActionAffordance - domain_of: - - ActionAffordance - range: boolean - synchronous: - name: synchronous - description: Indicates whether the action is synchronous (=true) or not. A synchronous - action means that the response of action contains all the information about - the result of the action and no further querying about the status of the action - is needed. Lack of this keyword means that no claim on the synchronicity of - the action can be made. - from_schema: td - rank: 1000 - alias: synchronous - owner: ActionAffordance - domain_of: - - ActionAffordance - range: boolean - idempotent: - name: idempotent - description: Indicates whether the action is idempotent (=true) or not. Informs - whether the action can be called repeatedly with the same results, if present, - based on the same input. - from_schema: td - rank: 1000 - alias: idempotent - owner: ActionAffordance - domain_of: - - ActionAffordance - range: boolean - input: - name: input - description: Used to define the input data schema of the action. - from_schema: td - rank: 1000 - alias: input - owner: ActionAffordance - domain_of: - - ActionAffordance - range: DataSchema - output: - name: output - description: Used to define the output data schema of the action. - from_schema: td - rank: 1000 - alias: output - owner: ActionAffordance - domain_of: - - ActionAffordance - range: DataSchema - titles: - name: titles - from_schema: td - rank: 1000 - multivalued: true - alias: titles - owner: ActionAffordance - domain_of: - - InteractionAffordance - - Thing - range: MultiLanguage - inlined: true - descriptions: - name: descriptions - description: TODO, check, according to the description a description should not - contain a lang tag. - from_schema: td - rank: 1000 - multivalued: true - alias: descriptions - owner: ActionAffordance - domain_of: - - SecurityScheme - - InteractionAffordance - - Thing - range: MultiLanguage - inlined: true - title: - name: title - description: Provides a human-readable title (e.g., display a text for UI representation) - based on a default language. - from_schema: td - rank: 1000 - slot_uri: td:title - alias: title - owner: ActionAffordance - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - description: - name: description - from_schema: td - rank: 1000 - alias: description - owner: ActionAffordance - domain_of: - - SecurityScheme - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - titleInLanguage: - name: titleInLanguage - description: title of the TD element (Thing, interaction affordance, security - scheme or data scheme) with language tag. By convention, a language tag must - be added to the object of descriptionInLanguage. Otherwise use description. - from_schema: td - rank: 1000 - alias: titleInLanguage - owner: ActionAffordance - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - descriptionInLanguage: - name: descriptionInLanguage - description: description of the TD element (Thing, interaction affordance, security - scheme or data scheme) with language tag. By convention, a language tag must - be added to the object of descriptionInLanguage. Otherwise use description. - from_schema: td - rank: 1000 - alias: descriptionInLanguage - owner: ActionAffordance - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - name: - name: name - description: Indexing property to store entity names when serializing them in - a JSON-LD @index container. - from_schema: td - rank: 1000 - identifier: true - alias: name - owner: ActionAffordance - domain_of: - - InteractionAffordance - range: string - required: true - uriVariables: - name: uriVariables - description: 'Define URI template variables according to RFC6570 as collection - based on schema specifications. The individual variables DataSchema cannot be - an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.' - from_schema: td - rank: 1000 - multivalued: true - alias: uriVariables - owner: ActionAffordance - domain_of: - - InteractionAffordance - range: DataSchema - forms: - name: forms - description: Set of form hypermedia controls that describe how an operation can - be performed. - from_schema: td - rank: 1000 - multivalued: true - alias: forms - owner: ActionAffordance - domain_of: - - InteractionAffordance - - Thing - range: Form -class_uri: td:ActionAffordance - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/AdditionalExpectedResponse.md b/resources/gens/docs/AdditionalExpectedResponse.md deleted file mode 100644 index c533d5d..0000000 --- a/resources/gens/docs/AdditionalExpectedResponse.md +++ /dev/null @@ -1,197 +0,0 @@ - - -# Class: AdditionalExpectedResponse - - -_Communication metadata describing the expected response message for additional responses._ - - - - - -URI: [hctl:AdditionalExpectedResponse](https://www.w3.org/2019/wot/hypermedia#AdditionalExpectedResponse) - - - - -```mermaid - classDiagram - class AdditionalExpectedResponse - ExpectedResponse <|-- AdditionalExpectedResponse - - AdditionalExpectedResponse : additionalOutputSchema - - AdditionalExpectedResponse : contentType - - AdditionalExpectedResponse : schema - - AdditionalExpectedResponse : success - - -``` - - - - - -## Inheritance -* [ExpectedResponse](ExpectedResponse.md) - * **AdditionalExpectedResponse** - - - -## Slots - -| Name | Cardinality and Range | Description | Inheritance | -| --- | --- | --- | --- | -| [additionalOutputSchema](additionalOutputSchema.md) | 0..1 <br/> [String](String.md) | This optional term can be used to define a data schema for an additional resp... | direct | -| [success](success.md) | 0..1 <br/> [Boolean](Boolean.md) | Signals if the additional response should not be considered an error | direct | -| [schema](schema.md) | 0..1 <br/> [String](String.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | direct | -| [contentType](contentType.md) | 1..1 <br/> [String](String.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | [ExpectedResponse](ExpectedResponse.md) | - - - - - -## Usages - -| used by | used in | type | used | -| --- | --- | --- | --- | -| [Form](Form.md) | [additionalReturns](additionalReturns.md) | range | [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - - -## Mappings - -| Mapping Type | Mapped Value | -| --- | --- | -| self | hctl:AdditionalExpectedResponse | -| native | td:AdditionalExpectedResponse | - - - - - -## LinkML Source - -<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> - -### Direct - -<details> -```yaml -name: AdditionalExpectedResponse -description: Communication metadata describing the expected response message for additional - responses. -from_schema: td -is_a: ExpectedResponse -attributes: - additionalOutputSchema: - name: additionalOutputSchema - description: This optional term can be used to define a data schema for an additional - response if it differs from the default output data schema. Rather than a DataSchema - object, the name of a previous definition given in a SchemaDefinitions map must - be used. - from_schema: td - rank: 1000 - domain_of: - - AdditionalExpectedResponse - success: - name: success - description: Signals if the additional response should not be considered an error. - from_schema: td - rank: 1000 - domain_of: - - AdditionalExpectedResponse - range: boolean - schema: - name: schema - description: TODO Check, was not in hctl ontology, if not could be source of discrepancy - from_schema: td - rank: 1000 - domain_of: - - AdditionalExpectedResponse -class_uri: hctl:AdditionalExpectedResponse - -``` -</details> - -### Induced - -<details> -```yaml -name: AdditionalExpectedResponse -description: Communication metadata describing the expected response message for additional - responses. -from_schema: td -is_a: ExpectedResponse -attributes: - additionalOutputSchema: - name: additionalOutputSchema - description: This optional term can be used to define a data schema for an additional - response if it differs from the default output data schema. Rather than a DataSchema - object, the name of a previous definition given in a SchemaDefinitions map must - be used. - from_schema: td - rank: 1000 - alias: additionalOutputSchema - owner: AdditionalExpectedResponse - domain_of: - - AdditionalExpectedResponse - range: string - success: - name: success - description: Signals if the additional response should not be considered an error. - from_schema: td - rank: 1000 - alias: success - owner: AdditionalExpectedResponse - domain_of: - - AdditionalExpectedResponse - range: boolean - schema: - name: schema - description: TODO Check, was not in hctl ontology, if not could be source of discrepancy - from_schema: td - rank: 1000 - alias: schema - owner: AdditionalExpectedResponse - domain_of: - - AdditionalExpectedResponse - range: string - contentType: - name: contentType - description: TODO Check, was not in hctl ontology, if not could be source of discrepancy - from_schema: td - rank: 1000 - alias: contentType - owner: AdditionalExpectedResponse - domain_of: - - ExpectedResponse - - Form - range: string - required: true -class_uri: hctl:AdditionalExpectedResponse - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/AnyUri.md b/resources/gens/docs/AnyUri.md deleted file mode 100644 index e0c2eed..0000000 --- a/resources/gens/docs/AnyUri.md +++ /dev/null @@ -1,38 +0,0 @@ -# Type: AnyUri - - - - -_a complete URI_ - - - -URI: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI) - -* [base](https://w3id.org/linkml/base): URI - -* [uri](https://w3id.org/linkml/uri): xsd:anyURI - - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/Boolean.md b/resources/gens/docs/Boolean.md deleted file mode 100644 index 8753cd0..0000000 --- a/resources/gens/docs/Boolean.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type: Boolean - - - - -_A binary (true or false) value_ - - - -URI: [xsd:boolean](http://www.w3.org/2001/XMLSchema#boolean) - -* [base](https://w3id.org/linkml/base): Bool - -* [uri](https://w3id.org/linkml/uri): xsd:boolean - -* [repr](https://w3id.org/linkml/repr): bool - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/Curie.md b/resources/gens/docs/Curie.md deleted file mode 100644 index a09ae77..0000000 --- a/resources/gens/docs/Curie.md +++ /dev/null @@ -1,44 +0,0 @@ -# Type: Curie - - - - -_a compact URI_ - - - -URI: [xsd:string](http://www.w3.org/2001/XMLSchema#string) - -* [base](https://w3id.org/linkml/base): Curie - -* [uri](https://w3id.org/linkml/uri): xsd:string - -* [repr](https://w3id.org/linkml/repr): str - - - - - - - - -## Comments - -* in RDF serializations this MUST be expanded to a URI -* in non-RDF serializations MAY be serialized as the compact representation - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/DataSchema.md b/resources/gens/docs/DataSchema.md deleted file mode 100644 index b7f09ed..0000000 --- a/resources/gens/docs/DataSchema.md +++ /dev/null @@ -1,262 +0,0 @@ - - -# Class: DataSchema - - -_Metadata that describes the data format used. It can be used for validation._ - - - - - -URI: [jsonschema:DataSchema](https://www.w3.org/2019/wot/json-schema#DataSchema) - - - - -```mermaid - classDiagram - class DataSchema - DataSchema <|-- PropertyAffordance - - DataSchema : description - - DataSchema --> MultiLanguage : description - - DataSchema : descriptionInLanguage - - DataSchema --> MultiLanguage : descriptionInLanguage - - DataSchema : propertyName - - DataSchema : readonly - - DataSchema : title - - DataSchema --> MultiLanguage : title - - DataSchema : titleInLanguage - - DataSchema --> MultiLanguage : titleInLanguage - - DataSchema : writeOnly - - -``` - - - - -<!-- no inheritance hierarchy --> - - -## Slots - -| Name | Cardinality and Range | Description | Inheritance | -| --- | --- | --- | --- | -| [description](description.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | | direct | -| [title](title.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | Provides a human-readable title (e | direct | -| [titleInLanguage](titleInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | direct | -| [descriptionInLanguage](descriptionInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | direct | -| [propertyName](propertyName.md) | 0..1 <br/> [String](String.md) | Used to store the indexing name in the parent object when this schema appears... | direct | -| [writeOnly](writeOnly.md) | 0..1 <br/> [String](String.md) | Boolean value that is a hint to indicate whether a property interaction/value... | direct | -| [readonly](readonly.md) | 0..1 <br/> [String](String.md) | Boolean value that is a hint to indicate whether a property interaction/value... | direct | - - - - - -## Usages - -| used by | used in | type | used | -| --- | --- | --- | --- | -| [InteractionAffordance](InteractionAffordance.md) | [uriVariables](uriVariables.md) | range | [DataSchema](DataSchema.md) | -| [PropertyAffordance](PropertyAffordance.md) | [uriVariables](uriVariables.md) | range | [DataSchema](DataSchema.md) | -| [ActionAffordance](ActionAffordance.md) | [input](input.md) | range | [DataSchema](DataSchema.md) | -| [ActionAffordance](ActionAffordance.md) | [output](output.md) | range | [DataSchema](DataSchema.md) | -| [ActionAffordance](ActionAffordance.md) | [uriVariables](uriVariables.md) | range | [DataSchema](DataSchema.md) | -| [EventAffordance](EventAffordance.md) | [subscription](subscription.md) | range | [DataSchema](DataSchema.md) | -| [EventAffordance](EventAffordance.md) | [cancellation](cancellation.md) | range | [DataSchema](DataSchema.md) | -| [EventAffordance](EventAffordance.md) | [notification](notification.md) | range | [DataSchema](DataSchema.md) | -| [EventAffordance](EventAffordance.md) | [notificationResponse](notificationResponse.md) | range | [DataSchema](DataSchema.md) | -| [EventAffordance](EventAffordance.md) | [uriVariables](uriVariables.md) | range | [DataSchema](DataSchema.md) | -| [Thing](Thing.md) | [schemaDefinitions](schemaDefinitions.md) | range | [DataSchema](DataSchema.md) | - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - - -## Mappings - -| Mapping Type | Mapped Value | -| --- | --- | -| self | jsonschema:DataSchema | -| native | td:DataSchema | - - - - - -## LinkML Source - -<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> - -### Direct - -<details> -```yaml -name: DataSchema -description: Metadata that describes the data format used. It can be used for validation. -from_schema: td -slots: -- description -- title -- titleInLanguage -- descriptionInLanguage -attributes: - propertyName: - name: propertyName - description: Used to store the indexing name in the parent object when this schema - appears as a property of an object schema. - from_schema: td - rank: 1000 - domain_of: - - DataSchema - writeOnly: - name: writeOnly - description: Boolean value that is a hint to indicate whether a property interaction/value - is write only (=true) or not (=false). - from_schema: td - rank: 1000 - domain_of: - - DataSchema - readonly: - name: readonly - description: Boolean value that is a hint to indicate whether a property interaction/value - is read only (=true) or not (=false). - from_schema: td - rank: 1000 - domain_of: - - DataSchema -class_uri: jsonschema:DataSchema - -``` -</details> - -### Induced - -<details> -```yaml -name: DataSchema -description: Metadata that describes the data format used. It can be used for validation. -from_schema: td -attributes: - propertyName: - name: propertyName - description: Used to store the indexing name in the parent object when this schema - appears as a property of an object schema. - from_schema: td - rank: 1000 - alias: propertyName - owner: DataSchema - domain_of: - - DataSchema - range: string - writeOnly: - name: writeOnly - description: Boolean value that is a hint to indicate whether a property interaction/value - is write only (=true) or not (=false). - from_schema: td - rank: 1000 - alias: writeOnly - owner: DataSchema - domain_of: - - DataSchema - range: string - readonly: - name: readonly - description: Boolean value that is a hint to indicate whether a property interaction/value - is read only (=true) or not (=false). - from_schema: td - rank: 1000 - alias: readonly - owner: DataSchema - domain_of: - - DataSchema - range: string - description: - name: description - from_schema: td - rank: 1000 - alias: description - owner: DataSchema - domain_of: - - SecurityScheme - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - title: - name: title - description: Provides a human-readable title (e.g., display a text for UI representation) - based on a default language. - from_schema: td - rank: 1000 - slot_uri: td:title - alias: title - owner: DataSchema - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - titleInLanguage: - name: titleInLanguage - description: title of the TD element (Thing, interaction affordance, security - scheme or data scheme) with language tag. By convention, a language tag must - be added to the object of descriptionInLanguage. Otherwise use description. - from_schema: td - rank: 1000 - alias: titleInLanguage - owner: DataSchema - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - descriptionInLanguage: - name: descriptionInLanguage - description: description of the TD element (Thing, interaction affordance, security - scheme or data scheme) with language tag. By convention, a language tag must - be added to the object of descriptionInLanguage. Otherwise use description. - from_schema: td - rank: 1000 - alias: descriptionInLanguage - owner: DataSchema - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage -class_uri: jsonschema:DataSchema - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/Date.md b/resources/gens/docs/Date.md deleted file mode 100644 index d9a40e8..0000000 --- a/resources/gens/docs/Date.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type: Date - - - - -_a date (year, month and day) in an idealized calendar_ - - - -URI: [xsd:date](http://www.w3.org/2001/XMLSchema#date) - -* [base](https://w3id.org/linkml/base): XSDDate - -* [uri](https://w3id.org/linkml/uri): xsd:date - -* [repr](https://w3id.org/linkml/repr): str - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/DateOrDatetime.md b/resources/gens/docs/DateOrDatetime.md deleted file mode 100644 index c72f04c..0000000 --- a/resources/gens/docs/DateOrDatetime.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type: DateOrDatetime - - - - -_Either a date or a datetime_ - - - -URI: [linkml:DateOrDatetime](https://w3id.org/linkml/DateOrDatetime) - -* [base](https://w3id.org/linkml/base): str - -* [uri](https://w3id.org/linkml/uri): linkml:DateOrDatetime - -* [repr](https://w3id.org/linkml/repr): str - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/Datetime.md b/resources/gens/docs/Datetime.md deleted file mode 100644 index ff9343d..0000000 --- a/resources/gens/docs/Datetime.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type: Datetime - - - - -_The combination of a date and time_ - - - -URI: [xsd:dateTime](http://www.w3.org/2001/XMLSchema#dateTime) - -* [base](https://w3id.org/linkml/base): XSDDateTime - -* [uri](https://w3id.org/linkml/uri): xsd:dateTime - -* [repr](https://w3id.org/linkml/repr): str - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/Decimal.md b/resources/gens/docs/Decimal.md deleted file mode 100644 index b28e415..0000000 --- a/resources/gens/docs/Decimal.md +++ /dev/null @@ -1,38 +0,0 @@ -# Type: Decimal - - - - -_A real number with arbitrary precision that conforms to the xsd:decimal specification_ - - - -URI: [xsd:decimal](http://www.w3.org/2001/XMLSchema#decimal) - -* [base](https://w3id.org/linkml/base): Decimal - -* [uri](https://w3id.org/linkml/uri): xsd:decimal - - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/Double.md b/resources/gens/docs/Double.md deleted file mode 100644 index 17cc6bf..0000000 --- a/resources/gens/docs/Double.md +++ /dev/null @@ -1,38 +0,0 @@ -# Type: Double - - - - -_A real number that conforms to the xsd:double specification_ - - - -URI: [xsd:double](http://www.w3.org/2001/XMLSchema#double) - -* [base](https://w3id.org/linkml/base): float - -* [uri](https://w3id.org/linkml/uri): xsd:double - - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/EventAffordance.md b/resources/gens/docs/EventAffordance.md deleted file mode 100644 index 4d4a3c2..0000000 --- a/resources/gens/docs/EventAffordance.md +++ /dev/null @@ -1,378 +0,0 @@ - - -# Class: EventAffordance - - -_An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts)._ - - - - - -URI: [td:EventAffordance](https://www.w3.org/2019/wot/td#EventAffordance) - - - - -```mermaid - classDiagram - class EventAffordance - InteractionAffordance <|-- EventAffordance - - EventAffordance : cancellation - - EventAffordance --> DataSchema : cancellation - - EventAffordance : description - - EventAffordance --> MultiLanguage : description - - EventAffordance : descriptionInLanguage - - EventAffordance --> MultiLanguage : descriptionInLanguage - - EventAffordance : descriptions - - EventAffordance --> MultiLanguage : descriptions - - EventAffordance : forms - - EventAffordance --> Form : forms - - EventAffordance : name - - EventAffordance : notification - - EventAffordance --> DataSchema : notification - - EventAffordance : notificationResponse - - EventAffordance --> DataSchema : notificationResponse - - EventAffordance : subscription - - EventAffordance --> DataSchema : subscription - - EventAffordance : title - - EventAffordance --> MultiLanguage : title - - EventAffordance : titleInLanguage - - EventAffordance --> MultiLanguage : titleInLanguage - - EventAffordance : titles - - EventAffordance --> MultiLanguage : titles - - EventAffordance : uriVariables - - EventAffordance --> DataSchema : uriVariables - - -``` - - - - - -## Inheritance -* [InteractionAffordance](InteractionAffordance.md) - * **EventAffordance** - - - -## Slots - -| Name | Cardinality and Range | Description | Inheritance | -| --- | --- | --- | --- | -| [subscription](subscription.md) | 0..1 <br/> [DataSchema](DataSchema.md) | Defines data that needs to be passed upon subscription, e | direct | -| [cancellation](cancellation.md) | 0..1 <br/> [DataSchema](DataSchema.md) | Defines any data that needs to be passed to cancel a subscription, e | direct | -| [notification](notification.md) | 0..1 <br/> [DataSchema](DataSchema.md) | Defines the data schema of the Event instance messages pushed by the Thing | direct | -| [notificationResponse](notificationResponse.md) | 0..1 <br/> [DataSchema](DataSchema.md) | Defines the data schema of the Event response messages sent by the consumer i... | direct | -| [titles](titles.md) | 0..* <br/> [MultiLanguage](MultiLanguage.md) | | [InteractionAffordance](InteractionAffordance.md) | -| [descriptions](descriptions.md) | 0..* <br/> [MultiLanguage](MultiLanguage.md) | TODO, check, according to the description a description should not contain a ... | [InteractionAffordance](InteractionAffordance.md) | -| [title](title.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | Provides a human-readable title (e | [InteractionAffordance](InteractionAffordance.md) | -| [description](description.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | | [InteractionAffordance](InteractionAffordance.md) | -| [titleInLanguage](titleInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | [InteractionAffordance](InteractionAffordance.md) | -| [descriptionInLanguage](descriptionInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | [InteractionAffordance](InteractionAffordance.md) | -| [name](name.md) | 1..1 <br/> [String](String.md) | Indexing property to store entity names when serializing them in a JSON-LD @i... | [InteractionAffordance](InteractionAffordance.md) | -| [uriVariables](uriVariables.md) | 0..* <br/> [DataSchema](DataSchema.md) | Define URI template variables according to RFC6570 as collection based on sch... | [InteractionAffordance](InteractionAffordance.md) | -| [forms](forms.md) | 0..* <br/> [Form](Form.md) | Set of form hypermedia controls that describe how an operation can be perform... | [InteractionAffordance](InteractionAffordance.md) | - - - - - -## Usages - -| used by | used in | type | used | -| --- | --- | --- | --- | -| [Thing](Thing.md) | [events](events.md) | range | [EventAffordance](EventAffordance.md) | - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - - -## Mappings - -| Mapping Type | Mapped Value | -| --- | --- | -| self | td:EventAffordance | -| native | td:EventAffordance | - - - - - -## LinkML Source - -<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> - -### Direct - -<details> -```yaml -name: EventAffordance -description: An Interaction Affordance that describes an event source, which asynchronously - pushes event data to Consumers (e.g., overhearing alerts). -from_schema: td -is_a: InteractionAffordance -attributes: - subscription: - name: subscription - description: Defines data that needs to be passed upon subscription, e.g., filters - or message format for setting up Webhooks. - from_schema: td - rank: 1000 - domain_of: - - EventAffordance - range: DataSchema - cancellation: - name: cancellation - description: Defines any data that needs to be passed to cancel a subscription, - e.g., a specific message to remove a Webhook. - from_schema: td - rank: 1000 - domain_of: - - EventAffordance - range: DataSchema - notification: - name: notification - description: Defines the data schema of the Event instance messages pushed by - the Thing. - from_schema: td - rank: 1000 - domain_of: - - EventAffordance - range: DataSchema - notificationResponse: - name: notificationResponse - description: Defines the data schema of the Event response messages sent by the - consumer in a response to a data message. - from_schema: td - rank: 1000 - domain_of: - - EventAffordance - range: DataSchema -class_uri: td:EventAffordance - -``` -</details> - -### Induced - -<details> -```yaml -name: EventAffordance -description: An Interaction Affordance that describes an event source, which asynchronously - pushes event data to Consumers (e.g., overhearing alerts). -from_schema: td -is_a: InteractionAffordance -attributes: - subscription: - name: subscription - description: Defines data that needs to be passed upon subscription, e.g., filters - or message format for setting up Webhooks. - from_schema: td - rank: 1000 - alias: subscription - owner: EventAffordance - domain_of: - - EventAffordance - range: DataSchema - cancellation: - name: cancellation - description: Defines any data that needs to be passed to cancel a subscription, - e.g., a specific message to remove a Webhook. - from_schema: td - rank: 1000 - alias: cancellation - owner: EventAffordance - domain_of: - - EventAffordance - range: DataSchema - notification: - name: notification - description: Defines the data schema of the Event instance messages pushed by - the Thing. - from_schema: td - rank: 1000 - alias: notification - owner: EventAffordance - domain_of: - - EventAffordance - range: DataSchema - notificationResponse: - name: notificationResponse - description: Defines the data schema of the Event response messages sent by the - consumer in a response to a data message. - from_schema: td - rank: 1000 - alias: notificationResponse - owner: EventAffordance - domain_of: - - EventAffordance - range: DataSchema - titles: - name: titles - from_schema: td - rank: 1000 - multivalued: true - alias: titles - owner: EventAffordance - domain_of: - - InteractionAffordance - - Thing - range: MultiLanguage - inlined: true - descriptions: - name: descriptions - description: TODO, check, according to the description a description should not - contain a lang tag. - from_schema: td - rank: 1000 - multivalued: true - alias: descriptions - owner: EventAffordance - domain_of: - - SecurityScheme - - InteractionAffordance - - Thing - range: MultiLanguage - inlined: true - title: - name: title - description: Provides a human-readable title (e.g., display a text for UI representation) - based on a default language. - from_schema: td - rank: 1000 - slot_uri: td:title - alias: title - owner: EventAffordance - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - description: - name: description - from_schema: td - rank: 1000 - alias: description - owner: EventAffordance - domain_of: - - SecurityScheme - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - titleInLanguage: - name: titleInLanguage - description: title of the TD element (Thing, interaction affordance, security - scheme or data scheme) with language tag. By convention, a language tag must - be added to the object of descriptionInLanguage. Otherwise use description. - from_schema: td - rank: 1000 - alias: titleInLanguage - owner: EventAffordance - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - descriptionInLanguage: - name: descriptionInLanguage - description: description of the TD element (Thing, interaction affordance, security - scheme or data scheme) with language tag. By convention, a language tag must - be added to the object of descriptionInLanguage. Otherwise use description. - from_schema: td - rank: 1000 - alias: descriptionInLanguage - owner: EventAffordance - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - name: - name: name - description: Indexing property to store entity names when serializing them in - a JSON-LD @index container. - from_schema: td - rank: 1000 - identifier: true - alias: name - owner: EventAffordance - domain_of: - - InteractionAffordance - range: string - required: true - uriVariables: - name: uriVariables - description: 'Define URI template variables according to RFC6570 as collection - based on schema specifications. The individual variables DataSchema cannot be - an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.' - from_schema: td - rank: 1000 - multivalued: true - alias: uriVariables - owner: EventAffordance - domain_of: - - InteractionAffordance - range: DataSchema - forms: - name: forms - description: Set of form hypermedia controls that describe how an operation can - be performed. - from_schema: td - rank: 1000 - multivalued: true - alias: forms - owner: EventAffordance - domain_of: - - InteractionAffordance - - Thing - range: Form -class_uri: td:EventAffordance - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/ExpectedResponse.md b/resources/gens/docs/ExpectedResponse.md deleted file mode 100644 index 30a11e8..0000000 --- a/resources/gens/docs/ExpectedResponse.md +++ /dev/null @@ -1,137 +0,0 @@ - - -# Class: ExpectedResponse - - -_Communication metadata describing the expected response message for the primary response._ - - - - - -URI: [hctl:ExpectedResponse](https://www.w3.org/2019/wot/hypermedia#ExpectedResponse) - - - - -```mermaid - classDiagram - class ExpectedResponse - ExpectedResponse <|-- AdditionalExpectedResponse - - ExpectedResponse : contentType - - -``` - - - - - -## Inheritance -* **ExpectedResponse** - * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) - - - -## Slots - -| Name | Cardinality and Range | Description | Inheritance | -| --- | --- | --- | --- | -| [contentType](contentType.md) | 1..1 <br/> [String](String.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | direct | - - - - - -## Usages - -| used by | used in | type | used | -| --- | --- | --- | --- | -| [Form](Form.md) | [returns](returns.md) | range | [ExpectedResponse](ExpectedResponse.md) | - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - - -## Mappings - -| Mapping Type | Mapped Value | -| --- | --- | -| self | hctl:ExpectedResponse | -| native | td:ExpectedResponse | - - - - - -## LinkML Source - -<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> - -### Direct - -<details> -```yaml -name: ExpectedResponse -description: Communication metadata describing the expected response message for the - primary response. -from_schema: td -attributes: - contentType: - name: contentType - description: TODO Check, was not in hctl ontology, if not could be source of discrepancy - from_schema: td - rank: 1000 - domain_of: - - ExpectedResponse - - Form - required: true -class_uri: hctl:ExpectedResponse - -``` -</details> - -### Induced - -<details> -```yaml -name: ExpectedResponse -description: Communication metadata describing the expected response message for the - primary response. -from_schema: td -attributes: - contentType: - name: contentType - description: TODO Check, was not in hctl ontology, if not could be source of discrepancy - from_schema: td - rank: 1000 - alias: contentType - owner: ExpectedResponse - domain_of: - - ExpectedResponse - - Form - range: string - required: true -class_uri: hctl:ExpectedResponse - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/Float.md b/resources/gens/docs/Float.md deleted file mode 100644 index 86a2288..0000000 --- a/resources/gens/docs/Float.md +++ /dev/null @@ -1,38 +0,0 @@ -# Type: Float - - - - -_A real number that conforms to the xsd:float specification_ - - - -URI: [xsd:float](http://www.w3.org/2001/XMLSchema#float) - -* [base](https://w3id.org/linkml/base): float - -* [uri](https://w3id.org/linkml/uri): xsd:float - - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/Form.md b/resources/gens/docs/Form.md deleted file mode 100644 index 3d618db..0000000 --- a/resources/gens/docs/Form.md +++ /dev/null @@ -1,359 +0,0 @@ - - -# Class: Form - - -_A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions._ - - - - - -URI: [hctl:Form](https://www.w3.org/2019/wot/hypermedia#Form) - - - - -```mermaid - classDiagram - class Form - Form : additionalReturns - - Form --> AdditionalExpectedResponse : additionalReturns - - Form : contentCoding - - Form : contentType - - Form : href - - Form : operationType - - Form --> OperationTypes : operationType - - Form : returns - - Form --> ExpectedResponse : returns - - Form : scopes - - Form : securityDefinitions - - Form : subprotocol - - Form : target - - -``` - - - - -<!-- no inheritance hierarchy --> - - -## Slots - -| Name | Cardinality and Range | Description | Inheritance | -| --- | --- | --- | --- | -| [target](target.md) | 1..1 <br/> [AnyUri](AnyUri.md) | Target IRI of a link or submission target of a Form | direct | -| [href](href.md) | 1..1 <br/> [AnyUri](AnyUri.md) | | direct | -| [contentType](contentType.md) | 0..1 <br/> [String](String.md) | Assign a content type based on a media type IANA-MEDIA-TYPES (e | direct | -| [contentCoding](contentCoding.md) | 0..1 <br/> [String](String.md) | Content coding values indicate an encoding transformation that has been or ca... | direct | -| [securityDefinitions](securityDefinitions.md) | 0..1 <br/> [String](String.md) | A security schema applied to a (set of) affordance(s) | direct | -| [scopes](scopes.md) | 0..1 <br/> [String](String.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | direct | -| [returns](returns.md) | 0..1 <br/> [ExpectedResponse](ExpectedResponse.md) | This optional term can be used if, e | direct | -| [additionalReturns](additionalReturns.md) | 0..* <br/> [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | This optional term can be used if additional expected responses are possible,... | direct | -| [subprotocol](subprotocol.md) | 0..1 <br/> [String](String.md) | Indicates the exact mechanism by which an interaction will be accomplished fo... | direct | -| [operationType](operationType.md) | 0..* <br/> [OperationTypes](OperationTypes.md) | Indicates the semantic intention of performing the operation(s) described by ... | direct | - - - - - -## Usages - -| used by | used in | type | used | -| --- | --- | --- | --- | -| [InteractionAffordance](InteractionAffordance.md) | [forms](forms.md) | range | [Form](Form.md) | -| [PropertyAffordance](PropertyAffordance.md) | [forms](forms.md) | range | [Form](Form.md) | -| [ActionAffordance](ActionAffordance.md) | [forms](forms.md) | range | [Form](Form.md) | -| [EventAffordance](EventAffordance.md) | [forms](forms.md) | range | [Form](Form.md) | -| [Thing](Thing.md) | [forms](forms.md) | range | [Form](Form.md) | - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - - -## Mappings - -| Mapping Type | Mapped Value | -| --- | --- | -| self | hctl:Form | -| native | td:Form | - - - - - -## LinkML Source - -<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> - -### Direct - -<details> -```yaml -name: Form -description: A form can be viewed as a statement of to perform an operation type on - form context, make a request method to submission target, where the optional form - fields may further describe the required request. In Thing Descriptions, the form - context is the surrounding Object, such as Properties, Actions, and Events or the - Thing itself for meta-interactions. -from_schema: td -slots: -- target -attributes: - href: - name: href - from_schema: td - rank: 1000 - domain_of: - - Form - range: anyUri - required: true - contentType: - name: contentType - description: Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., - 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media - type. - from_schema: td - domain_of: - - ExpectedResponse - - Form - contentCoding: - name: contentCoding - description: Content coding values indicate an encoding transformation that has - been or can be applied to a representation. Content codings are primarily used - to allow a representation to be compressed or otherwise usefully transformed without - losing the identity of its underlying media type and without loss of information. - Examples of content coding include \"gzip\", \"deflate\", etc. - from_schema: td - rank: 1000 - domain_of: - - Form - securityDefinitions: - name: securityDefinitions - description: A security schema applied to a (set of) affordance(s). - from_schema: td - rank: 1000 - domain_of: - - Form - - Thing - scopes: - name: scopes - description: TODO Check, was not in hctl ontology, if not could be source of discrepancy - from_schema: td - rank: 1000 - domain_of: - - Form - returns: - name: returns - description: This optional term can be used if, e.g., the output communication - metadata differ from input metadata (e.g., output contentType differ from the - input contentType). The response name contains metadata that is only valid for - the response messages. - from_schema: td - rank: 1000 - domain_of: - - Form - range: ExpectedResponse - additionalReturns: - name: additionalReturns - description: This optional term can be used if additional expected responses are - possible, e.g. for error reporting. Each additional response needs to be distinguished - from others in some way (for example, by specifying a protocol-specific response - code), and may also have its own data schema. - from_schema: td - rank: 1000 - multivalued: true - domain_of: - - Form - range: AdditionalExpectedResponse - subprotocol: - name: subprotocol - description: Indicates the exact mechanism by which an interaction will be accomplished - for a given protocol when there are multiple options. - from_schema: td - rank: 1000 - domain_of: - - Form - operationType: - name: operationType - description: Indicates the semantic intention of performing the operation(s) described - by the form. - from_schema: td - rank: 1000 - multivalued: true - domain_of: - - Form - range: OperationTypes -class_uri: hctl:Form - -``` -</details> - -### Induced - -<details> -```yaml -name: Form -description: A form can be viewed as a statement of to perform an operation type on - form context, make a request method to submission target, where the optional form - fields may further describe the required request. In Thing Descriptions, the form - context is the surrounding Object, such as Properties, Actions, and Events or the - Thing itself for meta-interactions. -from_schema: td -attributes: - href: - name: href - from_schema: td - rank: 1000 - alias: href - owner: Form - domain_of: - - Form - range: anyUri - required: true - contentType: - name: contentType - description: Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., - 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media - type. - from_schema: td - alias: contentType - owner: Form - domain_of: - - ExpectedResponse - - Form - range: string - contentCoding: - name: contentCoding - description: Content coding values indicate an encoding transformation that has - been or can be applied to a representation. Content codings are primarily used - to allow a representation to be compressed or otherwise usefully transformed without - losing the identity of its underlying media type and without loss of information. - Examples of content coding include \"gzip\", \"deflate\", etc. - from_schema: td - rank: 1000 - alias: contentCoding - owner: Form - domain_of: - - Form - range: string - securityDefinitions: - name: securityDefinitions - description: A security schema applied to a (set of) affordance(s). - from_schema: td - rank: 1000 - alias: securityDefinitions - owner: Form - domain_of: - - Form - - Thing - range: string - scopes: - name: scopes - description: TODO Check, was not in hctl ontology, if not could be source of discrepancy - from_schema: td - rank: 1000 - alias: scopes - owner: Form - domain_of: - - Form - range: string - returns: - name: returns - description: This optional term can be used if, e.g., the output communication - metadata differ from input metadata (e.g., output contentType differ from the - input contentType). The response name contains metadata that is only valid for - the response messages. - from_schema: td - rank: 1000 - alias: returns - owner: Form - domain_of: - - Form - range: ExpectedResponse - additionalReturns: - name: additionalReturns - description: This optional term can be used if additional expected responses are - possible, e.g. for error reporting. Each additional response needs to be distinguished - from others in some way (for example, by specifying a protocol-specific response - code), and may also have its own data schema. - from_schema: td - rank: 1000 - multivalued: true - alias: additionalReturns - owner: Form - domain_of: - - Form - range: AdditionalExpectedResponse - subprotocol: - name: subprotocol - description: Indicates the exact mechanism by which an interaction will be accomplished - for a given protocol when there are multiple options. - from_schema: td - rank: 1000 - alias: subprotocol - owner: Form - domain_of: - - Form - range: string - operationType: - name: operationType - description: Indicates the semantic intention of performing the operation(s) described - by the form. - from_schema: td - rank: 1000 - multivalued: true - alias: operationType - owner: Form - domain_of: - - Form - range: OperationTypes - target: - name: target - description: Target IRI of a link or submission target of a Form - from_schema: td - rank: 1000 - slot_uri: hctl:target - alias: target - owner: Form - domain_of: - - Link - - Form - range: anyUri - required: true -class_uri: hctl:Form - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/Integer.md b/resources/gens/docs/Integer.md deleted file mode 100644 index 5f18f94..0000000 --- a/resources/gens/docs/Integer.md +++ /dev/null @@ -1,38 +0,0 @@ -# Type: Integer - - - - -_An integer_ - - - -URI: [xsd:integer](http://www.w3.org/2001/XMLSchema#integer) - -* [base](https://w3id.org/linkml/base): int - -* [uri](https://w3id.org/linkml/uri): xsd:integer - - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/InteractionAffordance.md b/resources/gens/docs/InteractionAffordance.md deleted file mode 100644 index bcfe01d..0000000 --- a/resources/gens/docs/InteractionAffordance.md +++ /dev/null @@ -1,310 +0,0 @@ - - -# Class: InteractionAffordance - - -_TOOD_ - - - - - -URI: [td:InteractionAffordance](https://www.w3.org/2019/wot/td#InteractionAffordance) - - - - -```mermaid - classDiagram - class InteractionAffordance - InteractionAffordance <|-- PropertyAffordance - InteractionAffordance <|-- ActionAffordance - InteractionAffordance <|-- EventAffordance - - InteractionAffordance : description - - InteractionAffordance --> MultiLanguage : description - - InteractionAffordance : descriptionInLanguage - - InteractionAffordance --> MultiLanguage : descriptionInLanguage - - InteractionAffordance : descriptions - - InteractionAffordance --> MultiLanguage : descriptions - - InteractionAffordance : forms - - InteractionAffordance --> Form : forms - - InteractionAffordance : name - - InteractionAffordance : title - - InteractionAffordance --> MultiLanguage : title - - InteractionAffordance : titleInLanguage - - InteractionAffordance --> MultiLanguage : titleInLanguage - - InteractionAffordance : titles - - InteractionAffordance --> MultiLanguage : titles - - InteractionAffordance : uriVariables - - InteractionAffordance --> DataSchema : uriVariables - - -``` - - - - - -## Inheritance -* **InteractionAffordance** - * [PropertyAffordance](PropertyAffordance.md) [ [DataSchema](DataSchema.md)] - * [ActionAffordance](ActionAffordance.md) - * [EventAffordance](EventAffordance.md) - - - -## Slots - -| Name | Cardinality and Range | Description | Inheritance | -| --- | --- | --- | --- | -| [titles](titles.md) | 0..* <br/> [MultiLanguage](MultiLanguage.md) | | direct | -| [descriptions](descriptions.md) | 0..* <br/> [MultiLanguage](MultiLanguage.md) | TODO, check, according to the description a description should not contain a ... | direct | -| [title](title.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | Provides a human-readable title (e | direct | -| [description](description.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | | direct | -| [titleInLanguage](titleInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | direct | -| [descriptionInLanguage](descriptionInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | direct | -| [name](name.md) | 1..1 <br/> [String](String.md) | Indexing property to store entity names when serializing them in a JSON-LD @i... | direct | -| [uriVariables](uriVariables.md) | 0..* <br/> [DataSchema](DataSchema.md) | Define URI template variables according to RFC6570 as collection based on sch... | direct | -| [forms](forms.md) | 0..* <br/> [Form](Form.md) | Set of form hypermedia controls that describe how an operation can be perform... | direct | - - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - - -## Mappings - -| Mapping Type | Mapped Value | -| --- | --- | -| self | td:InteractionAffordance | -| native | td:InteractionAffordance | - - - - - -## LinkML Source - -<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> - -### Direct - -<details> -```yaml -name: InteractionAffordance -description: TOOD -from_schema: td -slots: -- titles -- descriptions -- title -- description -- titleInLanguage -- descriptionInLanguage -attributes: - name: - name: name - description: Indexing property to store entity names when serializing them in - a JSON-LD @index container. - from_schema: td - rank: 1000 - identifier: true - domain_of: - - InteractionAffordance - required: true - uriVariables: - name: uriVariables - description: 'Define URI template variables according to RFC6570 as collection - based on schema specifications. The individual variables DataSchema cannot be - an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.' - from_schema: td - rank: 1000 - multivalued: true - domain_of: - - InteractionAffordance - range: DataSchema - forms: - name: forms - description: Set of form hypermedia controls that describe how an operation can - be performed. - from_schema: td - rank: 1000 - multivalued: true - domain_of: - - InteractionAffordance - - Thing - range: Form -class_uri: td:InteractionAffordance - -``` -</details> - -### Induced - -<details> -```yaml -name: InteractionAffordance -description: TOOD -from_schema: td -attributes: - name: - name: name - description: Indexing property to store entity names when serializing them in - a JSON-LD @index container. - from_schema: td - rank: 1000 - identifier: true - alias: name - owner: InteractionAffordance - domain_of: - - InteractionAffordance - range: string - required: true - uriVariables: - name: uriVariables - description: 'Define URI template variables according to RFC6570 as collection - based on schema specifications. The individual variables DataSchema cannot be - an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.' - from_schema: td - rank: 1000 - multivalued: true - alias: uriVariables - owner: InteractionAffordance - domain_of: - - InteractionAffordance - range: DataSchema - forms: - name: forms - description: Set of form hypermedia controls that describe how an operation can - be performed. - from_schema: td - rank: 1000 - multivalued: true - alias: forms - owner: InteractionAffordance - domain_of: - - InteractionAffordance - - Thing - range: Form - titles: - name: titles - from_schema: td - rank: 1000 - multivalued: true - alias: titles - owner: InteractionAffordance - domain_of: - - InteractionAffordance - - Thing - range: MultiLanguage - inlined: true - descriptions: - name: descriptions - description: TODO, check, according to the description a description should not - contain a lang tag. - from_schema: td - rank: 1000 - multivalued: true - alias: descriptions - owner: InteractionAffordance - domain_of: - - SecurityScheme - - InteractionAffordance - - Thing - range: MultiLanguage - inlined: true - title: - name: title - description: Provides a human-readable title (e.g., display a text for UI representation) - based on a default language. - from_schema: td - rank: 1000 - slot_uri: td:title - alias: title - owner: InteractionAffordance - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - description: - name: description - from_schema: td - rank: 1000 - alias: description - owner: InteractionAffordance - domain_of: - - SecurityScheme - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - titleInLanguage: - name: titleInLanguage - description: title of the TD element (Thing, interaction affordance, security - scheme or data scheme) with language tag. By convention, a language tag must - be added to the object of descriptionInLanguage. Otherwise use description. - from_schema: td - rank: 1000 - alias: titleInLanguage - owner: InteractionAffordance - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - descriptionInLanguage: - name: descriptionInLanguage - description: description of the TD element (Thing, interaction affordance, security - scheme or data scheme) with language tag. By convention, a language tag must - be added to the object of descriptionInLanguage. Otherwise use description. - from_schema: td - rank: 1000 - alias: descriptionInLanguage - owner: InteractionAffordance - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage -class_uri: td:InteractionAffordance - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/Jsonpath.md b/resources/gens/docs/Jsonpath.md deleted file mode 100644 index 17af831..0000000 --- a/resources/gens/docs/Jsonpath.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type: Jsonpath - - - - -_A string encoding a JSON Path. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded in tree form._ - - - -URI: [xsd:string](http://www.w3.org/2001/XMLSchema#string) - -* [base](https://w3id.org/linkml/base): str - -* [uri](https://w3id.org/linkml/uri): xsd:string - -* [repr](https://w3id.org/linkml/repr): str - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/Jsonpointer.md b/resources/gens/docs/Jsonpointer.md deleted file mode 100644 index 7280725..0000000 --- a/resources/gens/docs/Jsonpointer.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type: Jsonpointer - - - - -_A string encoding a JSON Pointer. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to a valid object within the current instance document when encoded in tree form._ - - - -URI: [xsd:string](http://www.w3.org/2001/XMLSchema#string) - -* [base](https://w3id.org/linkml/base): str - -* [uri](https://w3id.org/linkml/uri): xsd:string - -* [repr](https://w3id.org/linkml/repr): str - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/Link.md b/resources/gens/docs/Link.md deleted file mode 100644 index 9ff5ad2..0000000 --- a/resources/gens/docs/Link.md +++ /dev/null @@ -1,260 +0,0 @@ - - -# Class: Link - - -_A link can be viewed as a statement of the form link context that has a relation type resource at link target", where the optional target attributes may further describe the resource._ - - - - - -URI: [hctl:Link](https://www.w3.org/2019/wot/hypermedia#Link) - - - - -```mermaid - classDiagram - class Link - Link : anchor - - Link : hintsAtMediaType - - Link : hreflang - - Link : relation - - Link : sizes - - Link : target - - Link : type - - -``` - - - - -<!-- no inheritance hierarchy --> - - -## Slots - -| Name | Cardinality and Range | Description | Inheritance | -| --- | --- | --- | --- | -| [target](target.md) | 1..1 <br/> [AnyUri](AnyUri.md) | Target IRI of a link or submission target of a Form | direct | -| [hintsAtMediaType](hintsAtMediaType.md) | 0..1 <br/> [String](String.md) | Target attribute providing a hint indicating what the media type [IANA-MEDIA-... | direct | -| [type](type.md) | 0..1 <br/> [String](String.md) | | direct | -| [relation](relation.md) | 0..1 <br/> [String](String.md) | A link relation type identifies the semantics of a link | direct | -| [anchor](anchor.md) | 0..1 <br/> [AnyUri](AnyUri.md) | By default, the context, or anchor, of a link conveyed in the Link header fie... | direct | -| [sizes](sizes.md) | 0..1 <br/> [String](String.md) | Target attribute that specifies one or more sizes for the referenced icon | direct | -| [hreflang](hreflang.md) | 0..1 <br/> [String](String.md) | The hreflang attribute specifies the language of a linked document | direct | - - - - - -## Usages - -| used by | used in | type | used | -| --- | --- | --- | --- | -| [Thing](Thing.md) | [links](links.md) | range | [Link](Link.md) | - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - - -## Mappings - -| Mapping Type | Mapped Value | -| --- | --- | -| self | hctl:Link | -| native | td:Link | - - - - - -## LinkML Source - -<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> - -### Direct - -<details> -```yaml -name: Link -description: A link can be viewed as a statement of the form link context that has - a relation type resource at link target", where the optional target attributes may - further describe the resource. -from_schema: td -slots: -- target -attributes: - hintsAtMediaType: - name: hintsAtMediaType - description: Target attribute providing a hint indicating what the media type - [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. - from_schema: td - rank: 1000 - domain_of: - - Link - type: - name: type - from_schema: td - rank: 1000 - domain_of: - - Link - relation: - name: relation - description: A link relation type identifies the semantics of a link. - from_schema: td - rank: 1000 - domain_of: - - Link - anchor: - name: anchor - description: By default, the context, or anchor, of a link conveyed in the Link - header field is the URL of the representation it is associated with, as defined - in RFC7231, Section 3.1.4.1, and is serialized as a URI. - from_schema: td - rank: 1000 - domain_of: - - Link - range: anyUri - sizes: - name: sizes - description: Target attribute that specifies one or more sizes for the referenced - icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} - (e.g., \"16x16\", \"16x16 32x32\"). - from_schema: td - rank: 1000 - domain_of: - - Link - hreflang: - name: hreflang - description: The hreflang attribute specifies the language of a linked document. - The value of this must be a valid language tag [[BCP47]]. - from_schema: td - rank: 1000 - domain_of: - - Link - pattern: ^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ -class_uri: hctl:Link - -``` -</details> - -### Induced - -<details> -```yaml -name: Link -description: A link can be viewed as a statement of the form link context that has - a relation type resource at link target", where the optional target attributes may - further describe the resource. -from_schema: td -attributes: - hintsAtMediaType: - name: hintsAtMediaType - description: Target attribute providing a hint indicating what the media type - [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. - from_schema: td - rank: 1000 - alias: hintsAtMediaType - owner: Link - domain_of: - - Link - range: string - type: - name: type - from_schema: td - rank: 1000 - alias: type - owner: Link - domain_of: - - Link - range: string - relation: - name: relation - description: A link relation type identifies the semantics of a link. - from_schema: td - rank: 1000 - alias: relation - owner: Link - domain_of: - - Link - range: string - anchor: - name: anchor - description: By default, the context, or anchor, of a link conveyed in the Link - header field is the URL of the representation it is associated with, as defined - in RFC7231, Section 3.1.4.1, and is serialized as a URI. - from_schema: td - rank: 1000 - alias: anchor - owner: Link - domain_of: - - Link - range: anyUri - sizes: - name: sizes - description: Target attribute that specifies one or more sizes for the referenced - icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} - (e.g., \"16x16\", \"16x16 32x32\"). - from_schema: td - rank: 1000 - alias: sizes - owner: Link - domain_of: - - Link - range: string - hreflang: - name: hreflang - description: The hreflang attribute specifies the language of a linked document. - The value of this must be a valid language tag [[BCP47]]. - from_schema: td - rank: 1000 - alias: hreflang - owner: Link - domain_of: - - Link - range: string - pattern: ^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ - target: - name: target - description: Target IRI of a link or submission target of a Form - from_schema: td - rank: 1000 - slot_uri: hctl:target - alias: target - owner: Link - domain_of: - - Link - - Form - range: anyUri - required: true -class_uri: hctl:Link - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/MultiLanguage.md b/resources/gens/docs/MultiLanguage.md deleted file mode 100644 index 38269ca..0000000 --- a/resources/gens/docs/MultiLanguage.md +++ /dev/null @@ -1,154 +0,0 @@ - - -# Class: MultiLanguage - - - -URI: [td:MultiLanguage](https://www.w3.org/2019/wot/td#MultiLanguage) - - - - -```mermaid - classDiagram - class MultiLanguage - MultiLanguage : key - - -``` - - - - -<!-- no inheritance hierarchy --> - - -## Slots - -| Name | Cardinality and Range | Description | Inheritance | -| --- | --- | --- | --- | -| [key](key.md) | 1..1 <br/> [String](String.md) | | direct | - - - - - -## Usages - -| used by | used in | type | used | -| --- | --- | --- | --- | -| [SecurityScheme](SecurityScheme.md) | [descriptions](descriptions.md) | range | [MultiLanguage](MultiLanguage.md) | -| [DataSchema](DataSchema.md) | [description](description.md) | range | [MultiLanguage](MultiLanguage.md) | -| [DataSchema](DataSchema.md) | [title](title.md) | range | [MultiLanguage](MultiLanguage.md) | -| [DataSchema](DataSchema.md) | [titleInLanguage](titleInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | -| [DataSchema](DataSchema.md) | [descriptionInLanguage](descriptionInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | -| [InteractionAffordance](InteractionAffordance.md) | [titles](titles.md) | range | [MultiLanguage](MultiLanguage.md) | -| [InteractionAffordance](InteractionAffordance.md) | [descriptions](descriptions.md) | range | [MultiLanguage](MultiLanguage.md) | -| [InteractionAffordance](InteractionAffordance.md) | [title](title.md) | range | [MultiLanguage](MultiLanguage.md) | -| [InteractionAffordance](InteractionAffordance.md) | [description](description.md) | range | [MultiLanguage](MultiLanguage.md) | -| [InteractionAffordance](InteractionAffordance.md) | [titleInLanguage](titleInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | -| [InteractionAffordance](InteractionAffordance.md) | [descriptionInLanguage](descriptionInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | -| [PropertyAffordance](PropertyAffordance.md) | [description](description.md) | range | [MultiLanguage](MultiLanguage.md) | -| [PropertyAffordance](PropertyAffordance.md) | [title](title.md) | range | [MultiLanguage](MultiLanguage.md) | -| [PropertyAffordance](PropertyAffordance.md) | [titleInLanguage](titleInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | -| [PropertyAffordance](PropertyAffordance.md) | [descriptionInLanguage](descriptionInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | -| [PropertyAffordance](PropertyAffordance.md) | [titles](titles.md) | range | [MultiLanguage](MultiLanguage.md) | -| [PropertyAffordance](PropertyAffordance.md) | [descriptions](descriptions.md) | range | [MultiLanguage](MultiLanguage.md) | -| [ActionAffordance](ActionAffordance.md) | [titles](titles.md) | range | [MultiLanguage](MultiLanguage.md) | -| [ActionAffordance](ActionAffordance.md) | [descriptions](descriptions.md) | range | [MultiLanguage](MultiLanguage.md) | -| [ActionAffordance](ActionAffordance.md) | [title](title.md) | range | [MultiLanguage](MultiLanguage.md) | -| [ActionAffordance](ActionAffordance.md) | [description](description.md) | range | [MultiLanguage](MultiLanguage.md) | -| [ActionAffordance](ActionAffordance.md) | [titleInLanguage](titleInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | -| [ActionAffordance](ActionAffordance.md) | [descriptionInLanguage](descriptionInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | -| [EventAffordance](EventAffordance.md) | [titles](titles.md) | range | [MultiLanguage](MultiLanguage.md) | -| [EventAffordance](EventAffordance.md) | [descriptions](descriptions.md) | range | [MultiLanguage](MultiLanguage.md) | -| [EventAffordance](EventAffordance.md) | [title](title.md) | range | [MultiLanguage](MultiLanguage.md) | -| [EventAffordance](EventAffordance.md) | [description](description.md) | range | [MultiLanguage](MultiLanguage.md) | -| [EventAffordance](EventAffordance.md) | [titleInLanguage](titleInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | -| [EventAffordance](EventAffordance.md) | [descriptionInLanguage](descriptionInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | -| [Thing](Thing.md) | [title](title.md) | range | [MultiLanguage](MultiLanguage.md) | -| [Thing](Thing.md) | [description](description.md) | range | [MultiLanguage](MultiLanguage.md) | -| [Thing](Thing.md) | [titles](titles.md) | range | [MultiLanguage](MultiLanguage.md) | -| [Thing](Thing.md) | [descriptions](descriptions.md) | range | [MultiLanguage](MultiLanguage.md) | -| [Thing](Thing.md) | [titleInLanguage](titleInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | -| [Thing](Thing.md) | [descriptionInLanguage](descriptionInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - - -## Mappings - -| Mapping Type | Mapped Value | -| --- | --- | -| self | td:MultiLanguage | -| native | td:MultiLanguage | - - - - - -## LinkML Source - -<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> - -### Direct - -<details> -```yaml -name: MultiLanguage -from_schema: td -attributes: - key: - name: key - from_schema: td - rank: 1000 - identifier: true - domain_of: - - MultiLanguage - required: true - pattern: ^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ - -``` -</details> - -### Induced - -<details> -```yaml -name: MultiLanguage -from_schema: td -attributes: - key: - name: key - from_schema: td - rank: 1000 - identifier: true - alias: key - owner: MultiLanguage - domain_of: - - MultiLanguage - range: string - required: true - pattern: ^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/Ncname.md b/resources/gens/docs/Ncname.md deleted file mode 100644 index 9e4032e..0000000 --- a/resources/gens/docs/Ncname.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type: Ncname - - - - -_Prefix part of CURIE_ - - - -URI: [xsd:string](http://www.w3.org/2001/XMLSchema#string) - -* [base](https://w3id.org/linkml/base): NCName - -* [uri](https://w3id.org/linkml/uri): xsd:string - -* [repr](https://w3id.org/linkml/repr): str - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/Nodeidentifier.md b/resources/gens/docs/Nodeidentifier.md deleted file mode 100644 index bce8d34..0000000 --- a/resources/gens/docs/Nodeidentifier.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type: Nodeidentifier - - - - -_A URI, CURIE or BNODE that represents a node in a model._ - - - -URI: [shex:nonLiteral](http://www.w3.org/ns/shex#nonLiteral) - -* [base](https://w3id.org/linkml/base): NodeIdentifier - -* [uri](https://w3id.org/linkml/uri): shex:nonLiteral - -* [repr](https://w3id.org/linkml/repr): str - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/Objectidentifier.md b/resources/gens/docs/Objectidentifier.md deleted file mode 100644 index 50423e5..0000000 --- a/resources/gens/docs/Objectidentifier.md +++ /dev/null @@ -1,43 +0,0 @@ -# Type: Objectidentifier - - - - -_A URI or CURIE that represents an object in the model._ - - - -URI: [shex:iri](http://www.w3.org/ns/shex#iri) - -* [base](https://w3id.org/linkml/base): ElementIdentifier - -* [uri](https://w3id.org/linkml/uri): shex:iri - -* [repr](https://w3id.org/linkml/repr): str - - - - - - - - -## Comments - -* Used for inheritance and type checking - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/OperationTypes.md b/resources/gens/docs/OperationTypes.md deleted file mode 100644 index 91a1b25..0000000 --- a/resources/gens/docs/OperationTypes.md +++ /dev/null @@ -1,167 +0,0 @@ -# Enum: OperationTypes - - - - -_Enumerations of well-known operation types necessary to implement the WoT interaction model._ - - - -URI: [OperationTypes](OperationTypes.md) - -## Permissible Values - -| Value | Meaning | Description | -| --- | --- | --- | -| readproperty | td:readProperty | Identifies the read operation on Property Affordances to retrieve the corresp... | -| writeproperty | td:writeProperty | Identifies the write operation on Property Affordances to update the correspo... | -| observeproperty | td:observeProperty | Identifies the observe operation on Property Affordances to be notified with ... | -| unobserveproperty | td:unobserveProperty | Identifies the unobserve operation on Property Affordances to stop the corres... | -| invokeaction | td:invokeAction | Identifies the invoke operation on Action Affordances to perform the correspo... | -| queryaction | td:queryAction | Identifies the querying operation on Action Affordances to get the status of ... | -| cancelaction | td:cancelAction | Identifies the cancel operation on Action Affordances to cancel the ongoing c... | -| subscribeevent | td:subscribeEvent | Identifies the subscribe operation on Event Affordances to be notified by the... | -| unsubscribeevent | td:unsubscribeEvent | Identifies the unsubscribe operation on Event Affordances to stop the corresp... | -| readallproperties | td:readAllProperties | Identifies the readallproperties operation on a Thing to retrieve the data of... | -| writeallproperties | writeAllProperties | Identifies the writeallproperties operation on a Thing to update the data of ... | -| readmultipleproperties | td:readMultipleProperties | Identifies the readmultipleproperties operation on a Thing to retrieve the da... | -| writemultipleproperties | td:writeMultipleProperties | Identifies the writemultipleproperties operation on a Thing to update the dat... | -| observeallproperties | td:observeAllProperties | Identifies the observeallproperties operation on Properties to be notified wi... | -| unobserveallproperties | td:unobserveAllProperties | Identifies the unobserveallproperties operation on Properties to stop notific... | -| subscribeallevents | td:subscribeAllEvents | Identifies the subscribeallevents operation on Events to subscribe to notific... | -| unsubscribeallevents | td:unsubscribeAllEvents | Identifies the unsubscribeallevents operation on Events to unsubscribe from n... | -| queryallactions | td:queryAllActions | Identifies the queryallactions operation on a Thing to get the status of all ... | - - - - -## Slots - -| Name | Description | -| --- | --- | -| [operationType](operationType.md) | Indicates the semantic intention of performing the operation(s) described by ... | - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: OperationTypes -description: Enumerations of well-known operation types necessary to implement the - WoT interaction model. -from_schema: td -rank: 1000 -permissible_values: - readproperty: - text: readproperty - description: Identifies the read operation on Property Affordances to retrieve - the corresponding data. - meaning: td:readProperty - writeproperty: - text: writeproperty - description: Identifies the write operation on Property Affordances to update - the corresponding data. - meaning: td:writeProperty - observeproperty: - text: observeproperty - description: Identifies the observe operation on Property Affordances to be notified - with the new data when the Property is updated. - meaning: td:observeProperty - unobserveproperty: - text: unobserveproperty - description: Identifies the unobserve operation on Property Affordances to stop - the corresponding notifications. - meaning: td:unobserveProperty - invokeaction: - text: invokeaction - description: Identifies the invoke operation on Action Affordances to perform - the corresponding action. - meaning: td:invokeAction - queryaction: - text: queryaction - description: Identifies the querying operation on Action Affordances to get the - status of the corresponding action. - meaning: td:queryAction - cancelaction: - text: cancelaction - description: Identifies the cancel operation on Action Affordances to cancel the - ongoing corresponding action. - meaning: td:cancelAction - subscribeevent: - text: subscribeevent - description: Identifies the subscribe operation on Event Affordances to be notified - by the Thing when the event occurs. - meaning: td:subscribeEvent - unsubscribeevent: - text: unsubscribeevent - description: Identifies the unsubscribe operation on Event Affordances to stop - the corresponding notifications. - meaning: td:unsubscribeEvent - readallproperties: - text: readallproperties - description: Identifies the readallproperties operation on a Thing to retrieve - the data of all Properties in a single interaction. - meaning: td:readAllProperties - writeallproperties: - text: writeallproperties - description: Identifies the writeallproperties operation on a Thing to update - the data of all writable Properties in a single interaction. - meaning: writeAllProperties - readmultipleproperties: - text: readmultipleproperties - description: Identifies the readmultipleproperties operation on a Thing to retrieve - the data of selected Properties in a single interaction. - meaning: td:readMultipleProperties - writemultipleproperties: - text: writemultipleproperties - description: Identifies the writemultipleproperties operation on a Thing to update - the data of selected writable Properties in a single interaction. - meaning: td:writeMultipleProperties - observeallproperties: - text: observeallproperties - description: Identifies the observeallproperties operation on Properties to be - notified with new data when any Property is updated. - meaning: td:observeAllProperties - unobserveallproperties: - text: unobserveallproperties - description: Identifies the unobserveallproperties operation on Properties to - stop notifications from all Properties in a single interaction. - meaning: td:unobserveAllProperties - subscribeallevents: - text: subscribeallevents - description: Identifies the subscribeallevents operation on Events to subscribe - to notifications from all Events in a single interaction. - meaning: td:subscribeAllEvents - unsubscribeallevents: - text: unsubscribeallevents - description: Identifies the unsubscribeallevents operation on Events to unsubscribe - from notifications from all Events in a single interaction. - meaning: td:unsubscribeAllEvents - queryallactions: - text: queryallactions - description: Identifies the queryallactions operation on a Thing to get the status - of all Actions in a single interaction. - meaning: td:queryAllActions - -``` -</details> diff --git a/resources/gens/docs/PropertyAffordance.md b/resources/gens/docs/PropertyAffordance.md deleted file mode 100644 index c7934f6..0000000 --- a/resources/gens/docs/PropertyAffordance.md +++ /dev/null @@ -1,350 +0,0 @@ - - -# Class: PropertyAffordance - - -_An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated._ - - - - - -URI: [td:PropertyAffordance](https://www.w3.org/2019/wot/td#PropertyAffordance) - - - - -```mermaid - classDiagram - class PropertyAffordance - DataSchema <|-- PropertyAffordance - InteractionAffordance <|-- PropertyAffordance - - PropertyAffordance : description - - PropertyAffordance --> MultiLanguage : description - - PropertyAffordance : descriptionInLanguage - - PropertyAffordance --> MultiLanguage : descriptionInLanguage - - PropertyAffordance : descriptions - - PropertyAffordance --> MultiLanguage : descriptions - - PropertyAffordance : forms - - PropertyAffordance --> Form : forms - - PropertyAffordance : name - - PropertyAffordance : observable - - PropertyAffordance : propertyName - - PropertyAffordance : readonly - - PropertyAffordance : title - - PropertyAffordance --> MultiLanguage : title - - PropertyAffordance : titleInLanguage - - PropertyAffordance --> MultiLanguage : titleInLanguage - - PropertyAffordance : titles - - PropertyAffordance --> MultiLanguage : titles - - PropertyAffordance : uriVariables - - PropertyAffordance --> DataSchema : uriVariables - - PropertyAffordance : writeOnly - - -``` - - - - - -## Inheritance -* [InteractionAffordance](InteractionAffordance.md) - * **PropertyAffordance** [ [DataSchema](DataSchema.md)] - - - -## Slots - -| Name | Cardinality and Range | Description | Inheritance | -| --- | --- | --- | --- | -| [observable](observable.md) | 0..1 <br/> [Boolean](Boolean.md) | A hint that indicates whether Servients hosting the Thing and Intermediaries ... | direct | -| [description](description.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | | [DataSchema](DataSchema.md), [InteractionAffordance](InteractionAffordance.md) | -| [title](title.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | Provides a human-readable title (e | [DataSchema](DataSchema.md), [InteractionAffordance](InteractionAffordance.md) | -| [titleInLanguage](titleInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | [DataSchema](DataSchema.md), [InteractionAffordance](InteractionAffordance.md) | -| [descriptionInLanguage](descriptionInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | [DataSchema](DataSchema.md), [InteractionAffordance](InteractionAffordance.md) | -| [propertyName](propertyName.md) | 0..1 <br/> [String](String.md) | Used to store the indexing name in the parent object when this schema appears... | [DataSchema](DataSchema.md) | -| [writeOnly](writeOnly.md) | 0..1 <br/> [String](String.md) | Boolean value that is a hint to indicate whether a property interaction/value... | [DataSchema](DataSchema.md) | -| [readonly](readonly.md) | 0..1 <br/> [String](String.md) | Boolean value that is a hint to indicate whether a property interaction/value... | [DataSchema](DataSchema.md) | -| [titles](titles.md) | 0..* <br/> [MultiLanguage](MultiLanguage.md) | | [InteractionAffordance](InteractionAffordance.md) | -| [descriptions](descriptions.md) | 0..* <br/> [MultiLanguage](MultiLanguage.md) | TODO, check, according to the description a description should not contain a ... | [InteractionAffordance](InteractionAffordance.md) | -| [name](name.md) | 1..1 <br/> [String](String.md) | Indexing property to store entity names when serializing them in a JSON-LD @i... | [InteractionAffordance](InteractionAffordance.md) | -| [uriVariables](uriVariables.md) | 0..* <br/> [DataSchema](DataSchema.md) | Define URI template variables according to RFC6570 as collection based on sch... | [InteractionAffordance](InteractionAffordance.md) | -| [forms](forms.md) | 0..* <br/> [Form](Form.md) | Set of form hypermedia controls that describe how an operation can be perform... | [InteractionAffordance](InteractionAffordance.md) | - - - - - -## Usages - -| used by | used in | type | used | -| --- | --- | --- | --- | -| [Thing](Thing.md) | [properties](properties.md) | range | [PropertyAffordance](PropertyAffordance.md) | - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - - -## Mappings - -| Mapping Type | Mapped Value | -| --- | --- | -| self | td:PropertyAffordance | -| native | td:PropertyAffordance | - - - - - -## LinkML Source - -<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> - -### Direct - -<details> -```yaml -name: PropertyAffordance -description: An Interaction Affordance that exposes state of the Thing. This state - can be retrieved (read) and/or updated. -from_schema: td -is_a: InteractionAffordance -mixins: -- DataSchema -attributes: - observable: - name: observable - description: A hint that indicates whether Servients hosting the Thing and Intermediaries - should probide a Protocol Binding that supports the observeproperty and unobserveproperty - operations for this Property. - from_schema: td - rank: 1000 - domain_of: - - PropertyAffordance - range: boolean -class_uri: td:PropertyAffordance - -``` -</details> - -### Induced - -<details> -```yaml -name: PropertyAffordance -description: An Interaction Affordance that exposes state of the Thing. This state - can be retrieved (read) and/or updated. -from_schema: td -is_a: InteractionAffordance -mixins: -- DataSchema -attributes: - observable: - name: observable - description: A hint that indicates whether Servients hosting the Thing and Intermediaries - should probide a Protocol Binding that supports the observeproperty and unobserveproperty - operations for this Property. - from_schema: td - rank: 1000 - alias: observable - owner: PropertyAffordance - domain_of: - - PropertyAffordance - range: boolean - description: - name: description - from_schema: td - rank: 1000 - alias: description - owner: PropertyAffordance - domain_of: - - SecurityScheme - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - title: - name: title - description: Provides a human-readable title (e.g., display a text for UI representation) - based on a default language. - from_schema: td - rank: 1000 - slot_uri: td:title - alias: title - owner: PropertyAffordance - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - titleInLanguage: - name: titleInLanguage - description: title of the TD element (Thing, interaction affordance, security - scheme or data scheme) with language tag. By convention, a language tag must - be added to the object of descriptionInLanguage. Otherwise use description. - from_schema: td - rank: 1000 - alias: titleInLanguage - owner: PropertyAffordance - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - descriptionInLanguage: - name: descriptionInLanguage - description: description of the TD element (Thing, interaction affordance, security - scheme or data scheme) with language tag. By convention, a language tag must - be added to the object of descriptionInLanguage. Otherwise use description. - from_schema: td - rank: 1000 - alias: descriptionInLanguage - owner: PropertyAffordance - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - propertyName: - name: propertyName - description: Used to store the indexing name in the parent object when this schema - appears as a property of an object schema. - from_schema: td - rank: 1000 - alias: propertyName - owner: PropertyAffordance - domain_of: - - DataSchema - range: string - writeOnly: - name: writeOnly - description: Boolean value that is a hint to indicate whether a property interaction/value - is write only (=true) or not (=false). - from_schema: td - rank: 1000 - alias: writeOnly - owner: PropertyAffordance - domain_of: - - DataSchema - range: string - readonly: - name: readonly - description: Boolean value that is a hint to indicate whether a property interaction/value - is read only (=true) or not (=false). - from_schema: td - rank: 1000 - alias: readonly - owner: PropertyAffordance - domain_of: - - DataSchema - range: string - titles: - name: titles - from_schema: td - rank: 1000 - multivalued: true - alias: titles - owner: PropertyAffordance - domain_of: - - InteractionAffordance - - Thing - range: MultiLanguage - inlined: true - descriptions: - name: descriptions - description: TODO, check, according to the description a description should not - contain a lang tag. - from_schema: td - rank: 1000 - multivalued: true - alias: descriptions - owner: PropertyAffordance - domain_of: - - SecurityScheme - - InteractionAffordance - - Thing - range: MultiLanguage - inlined: true - name: - name: name - description: Indexing property to store entity names when serializing them in - a JSON-LD @index container. - from_schema: td - rank: 1000 - identifier: true - alias: name - owner: PropertyAffordance - domain_of: - - InteractionAffordance - range: string - required: true - uriVariables: - name: uriVariables - description: 'Define URI template variables according to RFC6570 as collection - based on schema specifications. The individual variables DataSchema cannot be - an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.' - from_schema: td - rank: 1000 - multivalued: true - alias: uriVariables - owner: PropertyAffordance - domain_of: - - InteractionAffordance - range: DataSchema - forms: - name: forms - description: Set of form hypermedia controls that describe how an operation can - be performed. - from_schema: td - rank: 1000 - multivalued: true - alias: forms - owner: PropertyAffordance - domain_of: - - InteractionAffordance - - Thing - range: Form -class_uri: td:PropertyAffordance - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/SecurityScheme.md b/resources/gens/docs/SecurityScheme.md deleted file mode 100644 index 2772586..0000000 --- a/resources/gens/docs/SecurityScheme.md +++ /dev/null @@ -1,194 +0,0 @@ - - -# Class: SecurityScheme - - - -URI: [td:SecurityScheme](https://www.w3.org/2019/wot/td#SecurityScheme) - - - - -```mermaid - classDiagram - class SecurityScheme - SecurityScheme : @type - - SecurityScheme : description - - SecurityScheme : descriptions - - SecurityScheme --> MultiLanguage : descriptions - - SecurityScheme : proxy - - SecurityScheme : scheme - - SecurityScheme --> SecuritySchemeType : scheme - - -``` - - - - -<!-- no inheritance hierarchy --> - - -## Slots - -| Name | Cardinality and Range | Description | Inheritance | -| --- | --- | --- | --- | -| [@type](@type.md) | 0..* <br/> [String](String.md) | | direct | -| [descriptions](descriptions.md) | 0..* <br/> [MultiLanguage](MultiLanguage.md) | TODO, check, according to the description a description should not contain a ... | direct | -| [description](description.md) | 0..1 <br/> [String](String.md) | | direct | -| [proxy](proxy.md) | 0..1 <br/> [AnyUri](AnyUri.md) | URI of the proxy server this security configuration provides access to | direct | -| [scheme](scheme.md) | 1..1 <br/> [SecuritySchemeType](SecuritySchemeType.md) | | direct | - - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - - -## Mappings - -| Mapping Type | Mapped Value | -| --- | --- | -| self | td:SecurityScheme | -| native | td:SecurityScheme | - - - - - -## LinkML Source - -<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> - -### Direct - -<details> -```yaml -name: SecurityScheme -from_schema: td -slots: -- '@type' -- descriptions -attributes: - description: - name: description - from_schema: td - domain_of: - - SecurityScheme - - DataSchema - - InteractionAffordance - - Thing - proxy: - name: proxy - description: URI of the proxy server this security configuration provides access - to. If not given, the corresponding security configuration is for the endpoint. - from_schema: td - rank: 1000 - domain_of: - - SecurityScheme - range: anyUri - scheme: - name: scheme - from_schema: td - rank: 1000 - domain_of: - - SecurityScheme - range: SecuritySchemeType - required: true - -``` -</details> - -### Induced - -<details> -```yaml -name: SecurityScheme -from_schema: td -attributes: - description: - name: description - from_schema: td - alias: description - owner: SecurityScheme - domain_of: - - SecurityScheme - - DataSchema - - InteractionAffordance - - Thing - range: string - proxy: - name: proxy - description: URI of the proxy server this security configuration provides access - to. If not given, the corresponding security configuration is for the endpoint. - from_schema: td - rank: 1000 - alias: proxy - owner: SecurityScheme - domain_of: - - SecurityScheme - range: anyUri - scheme: - name: scheme - from_schema: td - rank: 1000 - alias: scheme - owner: SecurityScheme - domain_of: - - SecurityScheme - range: SecuritySchemeType - required: true - '@type': - name: '@type' - from_schema: td - rank: 1000 - multivalued: true - alias: '@type' - owner: SecurityScheme - domain_of: - - SecurityScheme - - Thing - range: string - descriptions: - name: descriptions - description: TODO, check, according to the description a description should not - contain a lang tag. - from_schema: td - rank: 1000 - multivalued: true - alias: descriptions - owner: SecurityScheme - domain_of: - - SecurityScheme - - InteractionAffordance - - Thing - range: MultiLanguage - inlined: true - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/SecuritySchemeType.md b/resources/gens/docs/SecuritySchemeType.md deleted file mode 100644 index 1bd064e..0000000 --- a/resources/gens/docs/SecuritySchemeType.md +++ /dev/null @@ -1,106 +0,0 @@ -# Enum: SecuritySchemeType - - - -URI: [SecuritySchemeType](SecuritySchemeType.md) - -## Permissible Values - -| Value | Meaning | Description | -| --- | --- | --- | -| nosec | wotsec:NoSecurityScheme | A security configuration corresponding to identified by the Vocabulary Term n... | -| combo | wotsec:ComboSecurityScheme | Elements of this scheme define various ways in which other named schemes defi... | -| basic | wotsec:BasicSecurityScheme | Uses an unencrypted username and password | -| digest | wotsec:DigestSecurityScheme | This scheme is similar to basic authentication but with added features to avo... | -| bearer | wotsec:BearerSecurityScheme | Bearer tokens are used independently of OAuth2 | -| psk | wotsec:PSKSecurityScheme | This is meant to identify that a standard is used for pre-shared keys such as... | -| oauth2 | wotsec:OAuth2SecurityScheme | OAuth 2 | -| apikey | wotsec:APIKeySecurityScheme | This scheme is to be used when the access token is opaque | -| auto | wotsec:AutoSecurityScheme | This scheme indicates that the security parameters are going to be negotiated... | - - - - -## Slots - -| Name | Description | -| --- | --- | -| [scheme](scheme.md) | | - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: SecuritySchemeType -from_schema: td -rank: 1000 -permissible_values: - nosec: - text: nosec - description: A security configuration corresponding to identified by the Vocabulary - Term nosec, indicating there is no authentication or other mechanism required - to access the resource. - meaning: wotsec:NoSecurityScheme - combo: - text: combo - description: Elements of this scheme define various ways in which other named - schemes defined in securityDefinitions, including other ComboSecurityScheme - definitions, are to be combined to create a new scheme definition. - meaning: wotsec:ComboSecurityScheme - basic: - text: basic - description: Uses an unencrypted username and password. - meaning: wotsec:BasicSecurityScheme - digest: - text: digest - description: This scheme is similar to basic authentication but with added features - to avoid man-in-the-middle attacks. - meaning: wotsec:DigestSecurityScheme - bearer: - text: bearer - description: Bearer tokens are used independently of OAuth2. - meaning: wotsec:BearerSecurityScheme - psk: - text: psk - description: This is meant to identify that a standard is used for pre-shared - keys such as TLS-PSK [RFC4279], and that the ciphersuite used for keys will - be established during protocol negotiation. - meaning: wotsec:PSKSecurityScheme - oauth2: - text: oauth2 - description: OAuth 2.0 authentication security configuration for systems conformant - with [RFC6749] and [RFC8252]. - meaning: wotsec:OAuth2SecurityScheme - apikey: - text: apikey - description: This scheme is to be used when the access token is opaque. - meaning: wotsec:APIKeySecurityScheme - auto: - text: auto - description: This scheme indicates that the security parameters are going to be - negotiated by the underlying protocols at runtime - meaning: wotsec:AutoSecurityScheme - -``` -</details> diff --git a/resources/gens/docs/Sparqlpath.md b/resources/gens/docs/Sparqlpath.md deleted file mode 100644 index e9429a2..0000000 --- a/resources/gens/docs/Sparqlpath.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type: Sparqlpath - - - - -_A string encoding a SPARQL Property Path. The value of the string MUST conform to SPARQL syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded as RDF._ - - - -URI: [xsd:string](http://www.w3.org/2001/XMLSchema#string) - -* [base](https://w3id.org/linkml/base): str - -* [uri](https://w3id.org/linkml/uri): xsd:string - -* [repr](https://w3id.org/linkml/repr): str - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/String.md b/resources/gens/docs/String.md deleted file mode 100644 index f4ee52a..0000000 --- a/resources/gens/docs/String.md +++ /dev/null @@ -1,38 +0,0 @@ -# Type: String - - - - -_A character string_ - - - -URI: [xsd:string](http://www.w3.org/2001/XMLSchema#string) - -* [base](https://w3id.org/linkml/base): str - -* [uri](https://w3id.org/linkml/uri): xsd:string - - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/Thing.md b/resources/gens/docs/Thing.md deleted file mode 100644 index 408c79c..0000000 --- a/resources/gens/docs/Thing.md +++ /dev/null @@ -1,620 +0,0 @@ - - -# Class: Thing - - -_An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things._ - - - - - -URI: [td:Thing](https://www.w3.org/2019/wot/td#Thing) - - - - -```mermaid - classDiagram - class Thing - Thing : @type - - Thing : actions - - Thing --> ActionAffordance : actions - - Thing : base - - Thing : created - - Thing : description - - Thing --> MultiLanguage : description - - Thing : descriptionInLanguage - - Thing --> MultiLanguage : descriptionInLanguage - - Thing : descriptions - - Thing --> MultiLanguage : descriptions - - Thing : events - - Thing --> EventAffordance : events - - Thing : forms - - Thing --> Form : forms - - Thing : id - - Thing : instance - - Thing : links - - Thing --> Link : links - - Thing : modified - - Thing : profile - - Thing : properties - - Thing --> PropertyAffordance : properties - - Thing : schemaDefinitions - - Thing --> DataSchema : schemaDefinitions - - Thing : security - - Thing : securityDefinitions - - Thing : supportContact - - Thing : title - - Thing --> MultiLanguage : title - - Thing : titleInLanguage - - Thing --> MultiLanguage : titleInLanguage - - Thing : titles - - Thing --> MultiLanguage : titles - - Thing : version - - Thing --> VersionInfo : version - - -``` - - - - -<!-- no inheritance hierarchy --> - - -## Slots - -| Name | Cardinality and Range | Description | Inheritance | -| --- | --- | --- | --- | -| [id](id.md) | 1..1 <br/> [AnyUri](AnyUri.md) | TODO | direct | -| [title](title.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | Provides a human-readable title (e | direct | -| [description](description.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | | direct | -| [titles](titles.md) | 0..* <br/> [MultiLanguage](MultiLanguage.md) | | direct | -| [descriptions](descriptions.md) | 0..* <br/> [MultiLanguage](MultiLanguage.md) | TODO, check, according to the description a description should not contain a ... | direct | -| [@type](@type.md) | 0..* <br/> [String](String.md) | | direct | -| [titleInLanguage](titleInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | direct | -| [descriptionInLanguage](descriptionInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | direct | -| [securityDefinitions](securityDefinitions.md) | 0..* <br/> [String](String.md) or <br />[String](String.md) or <br />[SecuritySchemeType](SecuritySchemeType.md) | A security scheme applied to a (set of) affordance(s) | direct | -| [security](security.md) | 0..* <br/> [String](String.md) | A Thing may define abstract security schemes, used to configure the secure ac... | direct | -| [schemaDefinitions](schemaDefinitions.md) | 0..* <br/> [DataSchema](DataSchema.md) | TODO CHECK | direct | -| [profile](profile.md) | 0..* <br/> [AnyUri](AnyUri.md) | Indicates the WoT Profile mechanisms followed by this Thing Description and t... | direct | -| [instance](instance.md) | 0..1 <br/> [String](String.md) | Provides a version identicator of this TD instance | direct | -| [created](created.md) | 0..1 <br/> [Datetime](Datetime.md) | Provides information when the TD instance was created | direct | -| [modified](modified.md) | 0..1 <br/> [Datetime](Datetime.md) | Provides information when the TD instance was last modified | direct | -| [supportContact](supportContact.md) | 0..1 <br/> [AnyUri](AnyUri.md) | Provides information about the TD maintainer as URI scheme (e | direct | -| [base](base.md) | 0..1 <br/> [AnyUri](AnyUri.md) | Define the base URI that is used for all relative URI references throughout a... | direct | -| [version](version.md) | 0..1 <br/> [VersionInfo](VersionInfo.md) | | direct | -| [forms](forms.md) | 0..* <br/> [Form](Form.md) | Set of form hypermedia controls that describe how an operation can be perform... | direct | -| [links](links.md) | 0..* <br/> [Link](Link.md) | Provides Web links to arbitrary resources that relate to the specified Thing ... | direct | -| [properties](properties.md) | 0..* <br/> [PropertyAffordance](PropertyAffordance.md) | All Property-based interaction affordances of the Thing | direct | -| [actions](actions.md) | 0..* <br/> [ActionAffordance](ActionAffordance.md) | All Action-based interaction affordances of the Thing | direct | -| [events](events.md) | 0..* <br/> [EventAffordance](EventAffordance.md) | All Event-based interaction affordances of the Thing | direct | - - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - - -## Mappings - -| Mapping Type | Mapped Value | -| --- | --- | -| self | td:Thing | -| native | td:Thing | - - - - - -## LinkML Source - -<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> - -### Direct - -<details> -```yaml -name: Thing -description: An abstraction of a physical or a virtual entity whose metadata and interfaces - are described by a WoT Thing Description, whereas a virtual entity is the composition - of one or more Things. -from_schema: td -slots: -- id -- title -- description -- titles -- descriptions -- '@type' -- titleInLanguage -- descriptionInLanguage -attributes: - securityDefinitions: - name: securityDefinitions - description: A security scheme applied to a (set of) affordance(s). TODO check - from_schema: td - multivalued: true - domain_of: - - Form - - Thing - any_of: - - range: string - - range: SecuritySchemeType - security: - name: security - description: 'A Thing may define abstract security schemes, used to configure - the secure access of (a set of) affordance(s). TODO: check' - from_schema: td - rank: 1000 - multivalued: true - domain_of: - - Thing - schemaDefinitions: - name: schemaDefinitions - description: TODO CHECK - from_schema: td - rank: 1000 - multivalued: true - domain_of: - - Thing - range: DataSchema - profile: - name: profile - description: Indicates the WoT Profile mechanisms followed by this Thing Description - and the corresponding Thing implementation. - from_schema: td - rank: 1000 - multivalued: true - domain_of: - - Thing - range: anyUri - instance: - name: instance - description: Provides a version identicator of this TD instance. - from_schema: td - domain_of: - - VersionInfo - - Thing - created: - name: created - description: Provides information when the TD instance was created. - from_schema: td - rank: 1000 - domain_of: - - Thing - range: datetime - modified: - name: modified - description: Provides information when the TD instance was last modified. - from_schema: td - rank: 1000 - domain_of: - - Thing - range: datetime - supportContact: - name: supportContact - description: Provides information about the TD maintainer as URI scheme (e.g., - <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> - [[RFC9112]]). - from_schema: td - rank: 1000 - domain_of: - - Thing - range: anyUri - base: - name: base - description: Define the base URI that is used for all relative URI references - throughout a TD document. - from_schema: td - rank: 1000 - domain_of: - - Thing - range: anyUri - version: - name: version - from_schema: td - rank: 1000 - domain_of: - - Thing - range: VersionInfo - forms: - name: forms - description: Set of form hypermedia controls that describe how an operation can - be performed. Forms are serializations of Protocol Bindings. - from_schema: td - multivalued: true - domain_of: - - InteractionAffordance - - Thing - range: Form - links: - name: links - description: Provides Web links to arbitrary resources that relate to the specified - Thing Description. - from_schema: td - rank: 1000 - multivalued: true - domain_of: - - Thing - range: Link - properties: - name: properties - description: All Property-based interaction affordances of the Thing. - from_schema: td - rank: 1000 - multivalued: true - domain_of: - - Thing - range: PropertyAffordance - inlined: true - actions: - name: actions - description: All Action-based interaction affordances of the Thing. - from_schema: td - rank: 1000 - multivalued: true - domain_of: - - Thing - range: ActionAffordance - inlined: true - events: - name: events - description: All Event-based interaction affordances of the Thing. - from_schema: td - rank: 1000 - multivalued: true - domain_of: - - Thing - range: EventAffordance - inlined: true -class_uri: td:Thing - -``` -</details> - -### Induced - -<details> -```yaml -name: Thing -description: An abstraction of a physical or a virtual entity whose metadata and interfaces - are described by a WoT Thing Description, whereas a virtual entity is the composition - of one or more Things. -from_schema: td -attributes: - securityDefinitions: - name: securityDefinitions - description: A security scheme applied to a (set of) affordance(s). TODO check - from_schema: td - multivalued: true - alias: securityDefinitions - owner: Thing - domain_of: - - Form - - Thing - range: string - any_of: - - range: string - - range: SecuritySchemeType - security: - name: security - description: 'A Thing may define abstract security schemes, used to configure - the secure access of (a set of) affordance(s). TODO: check' - from_schema: td - rank: 1000 - multivalued: true - alias: security - owner: Thing - domain_of: - - Thing - range: string - schemaDefinitions: - name: schemaDefinitions - description: TODO CHECK - from_schema: td - rank: 1000 - multivalued: true - alias: schemaDefinitions - owner: Thing - domain_of: - - Thing - range: DataSchema - profile: - name: profile - description: Indicates the WoT Profile mechanisms followed by this Thing Description - and the corresponding Thing implementation. - from_schema: td - rank: 1000 - multivalued: true - alias: profile - owner: Thing - domain_of: - - Thing - range: anyUri - instance: - name: instance - description: Provides a version identicator of this TD instance. - from_schema: td - alias: instance - owner: Thing - domain_of: - - VersionInfo - - Thing - range: string - created: - name: created - description: Provides information when the TD instance was created. - from_schema: td - rank: 1000 - alias: created - owner: Thing - domain_of: - - Thing - range: datetime - modified: - name: modified - description: Provides information when the TD instance was last modified. - from_schema: td - rank: 1000 - alias: modified - owner: Thing - domain_of: - - Thing - range: datetime - supportContact: - name: supportContact - description: Provides information about the TD maintainer as URI scheme (e.g., - <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> - [[RFC9112]]). - from_schema: td - rank: 1000 - alias: supportContact - owner: Thing - domain_of: - - Thing - range: anyUri - base: - name: base - description: Define the base URI that is used for all relative URI references - throughout a TD document. - from_schema: td - rank: 1000 - alias: base - owner: Thing - domain_of: - - Thing - range: anyUri - version: - name: version - from_schema: td - rank: 1000 - alias: version - owner: Thing - domain_of: - - Thing - range: VersionInfo - forms: - name: forms - description: Set of form hypermedia controls that describe how an operation can - be performed. Forms are serializations of Protocol Bindings. - from_schema: td - multivalued: true - alias: forms - owner: Thing - domain_of: - - InteractionAffordance - - Thing - range: Form - links: - name: links - description: Provides Web links to arbitrary resources that relate to the specified - Thing Description. - from_schema: td - rank: 1000 - multivalued: true - alias: links - owner: Thing - domain_of: - - Thing - range: Link - properties: - name: properties - description: All Property-based interaction affordances of the Thing. - from_schema: td - rank: 1000 - multivalued: true - alias: properties - owner: Thing - domain_of: - - Thing - range: PropertyAffordance - inlined: true - actions: - name: actions - description: All Action-based interaction affordances of the Thing. - from_schema: td - rank: 1000 - multivalued: true - alias: actions - owner: Thing - domain_of: - - Thing - range: ActionAffordance - inlined: true - events: - name: events - description: All Event-based interaction affordances of the Thing. - from_schema: td - rank: 1000 - multivalued: true - alias: events - owner: Thing - domain_of: - - Thing - range: EventAffordance - inlined: true - id: - name: id - description: TODO - from_schema: td - rank: 1000 - slot_uri: td:id - identifier: true - alias: id - owner: Thing - domain_of: - - Thing - range: anyUri - required: true - title: - name: title - description: Provides a human-readable title (e.g., display a text for UI representation) - based on a default language. - from_schema: td - rank: 1000 - slot_uri: td:title - alias: title - owner: Thing - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - description: - name: description - from_schema: td - rank: 1000 - alias: description - owner: Thing - domain_of: - - SecurityScheme - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - titles: - name: titles - from_schema: td - rank: 1000 - multivalued: true - alias: titles - owner: Thing - domain_of: - - InteractionAffordance - - Thing - range: MultiLanguage - inlined: true - descriptions: - name: descriptions - description: TODO, check, according to the description a description should not - contain a lang tag. - from_schema: td - rank: 1000 - multivalued: true - alias: descriptions - owner: Thing - domain_of: - - SecurityScheme - - InteractionAffordance - - Thing - range: MultiLanguage - inlined: true - '@type': - name: '@type' - from_schema: td - rank: 1000 - multivalued: true - alias: '@type' - owner: Thing - domain_of: - - SecurityScheme - - Thing - range: string - titleInLanguage: - name: titleInLanguage - description: title of the TD element (Thing, interaction affordance, security - scheme or data scheme) with language tag. By convention, a language tag must - be added to the object of descriptionInLanguage. Otherwise use description. - from_schema: td - rank: 1000 - alias: titleInLanguage - owner: Thing - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage - descriptionInLanguage: - name: descriptionInLanguage - description: description of the TD element (Thing, interaction affordance, security - scheme or data scheme) with language tag. By convention, a language tag must - be added to the object of descriptionInLanguage. Otherwise use description. - from_schema: td - rank: 1000 - alias: descriptionInLanguage - owner: Thing - domain_of: - - DataSchema - - InteractionAffordance - - Thing - range: MultiLanguage -class_uri: td:Thing - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/Time.md b/resources/gens/docs/Time.md deleted file mode 100644 index 5b549ef..0000000 --- a/resources/gens/docs/Time.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type: Time - - - - -_A time object represents a (local) time of day, independent of any particular day_ - - - -URI: [xsd:time](http://www.w3.org/2001/XMLSchema#time) - -* [base](https://w3id.org/linkml/base): XSDTime - -* [uri](https://w3id.org/linkml/uri): xsd:time - -* [repr](https://w3id.org/linkml/repr): str - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/Uri.md b/resources/gens/docs/Uri.md deleted file mode 100644 index fd0d161..0000000 --- a/resources/gens/docs/Uri.md +++ /dev/null @@ -1,43 +0,0 @@ -# Type: Uri - - - - -_a complete URI_ - - - -URI: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI) - -* [base](https://w3id.org/linkml/base): URI - -* [uri](https://w3id.org/linkml/uri): xsd:anyURI - -* [repr](https://w3id.org/linkml/repr): str - - - - - - - - -## Comments - -* in RDF serializations a slot with range of uri is treated as a literal or type xsd:anyURI unless it is an identifier or a reference to an identifier, in which case it is translated directly to a node - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/Uriorcurie.md b/resources/gens/docs/Uriorcurie.md deleted file mode 100644 index 2b3f34f..0000000 --- a/resources/gens/docs/Uriorcurie.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type: Uriorcurie - - - - -_a URI or a CURIE_ - - - -URI: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI) - -* [base](https://w3id.org/linkml/base): URIorCURIE - -* [uri](https://w3id.org/linkml/uri): xsd:anyURI - -* [repr](https://w3id.org/linkml/repr): str - - - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - diff --git a/resources/gens/docs/VersionInfo.md b/resources/gens/docs/VersionInfo.md deleted file mode 100644 index 4bf654d..0000000 --- a/resources/gens/docs/VersionInfo.md +++ /dev/null @@ -1,145 +0,0 @@ - - -# Class: VersionInfo - - -_Provides version information._ - - - - - -URI: [schema:version](http://schema.org/version) - - - - -```mermaid - classDiagram - class VersionInfo - VersionInfo : instance - - VersionInfo : model - - -``` - - - - -<!-- no inheritance hierarchy --> - - -## Slots - -| Name | Cardinality and Range | Description | Inheritance | -| --- | --- | --- | --- | -| [instance](instance.md) | 1..1 <br/> [String](String.md) | | direct | -| [model](model.md) | 0..1 <br/> [String](String.md) | | direct | - - - - - -## Usages - -| used by | used in | type | used | -| --- | --- | --- | --- | -| [Thing](Thing.md) | [version](version.md) | range | [VersionInfo](VersionInfo.md) | - - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - - -## Mappings - -| Mapping Type | Mapped Value | -| --- | --- | -| self | schema:version | -| native | td:VersionInfo | - - - - - -## LinkML Source - -<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> - -### Direct - -<details> -```yaml -name: VersionInfo -description: Provides version information. -from_schema: td -attributes: - instance: - name: instance - from_schema: td - rank: 1000 - domain_of: - - VersionInfo - - Thing - required: true - model: - name: model - from_schema: td - rank: 1000 - domain_of: - - VersionInfo -class_uri: schema:version - -``` -</details> - -### Induced - -<details> -```yaml -name: VersionInfo -description: Provides version information. -from_schema: td -attributes: - instance: - name: instance - from_schema: td - rank: 1000 - alias: instance - owner: VersionInfo - domain_of: - - VersionInfo - - Thing - range: string - required: true - model: - name: model - from_schema: td - rank: 1000 - alias: model - owner: VersionInfo - domain_of: - - VersionInfo - range: string -class_uri: schema:version - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/about.md b/resources/gens/docs/about.md deleted file mode 100644 index bd22788..0000000 --- a/resources/gens/docs/about.md +++ /dev/null @@ -1,3 +0,0 @@ -# thing-description-schema - -Thing Description Standard diff --git a/resources/gens/docs/actionAffordance__idempotent.md b/resources/gens/docs/actionAffordance__idempotent.md deleted file mode 100644 index d264124..0000000 --- a/resources/gens/docs/actionAffordance__idempotent.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: idempotent - - -Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input. - -URI: [td:actionAffordance__idempotent](https://www.w3.org/2019/wot/td#actionAffordance__idempotent) - - -## Domain and Range - -None → <sub>0..1</sub> [Boolean](types/Boolean.md) - -## Parents - - -## Children - - -## Used by - - * [ActionAffordance](ActionAffordance.md) diff --git a/resources/gens/docs/actionAffordance__input.md b/resources/gens/docs/actionAffordance__input.md deleted file mode 100644 index dfe0b3c..0000000 --- a/resources/gens/docs/actionAffordance__input.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: input - - -Used to define the input data schema of the action. - -URI: [td:actionAffordance__input](https://www.w3.org/2019/wot/td#actionAffordance__input) - - -## Domain and Range - -None → <sub>0..1</sub> [DataSchema](DataSchema.md) - -## Parents - - -## Children - - -## Used by - - * [ActionAffordance](ActionAffordance.md) diff --git a/resources/gens/docs/actionAffordance__output.md b/resources/gens/docs/actionAffordance__output.md deleted file mode 100644 index 6f0213c..0000000 --- a/resources/gens/docs/actionAffordance__output.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: output - - -Used to define the output data schema of the action. - -URI: [td:actionAffordance__output](https://www.w3.org/2019/wot/td#actionAffordance__output) - - -## Domain and Range - -None → <sub>0..1</sub> [DataSchema](DataSchema.md) - -## Parents - - -## Children - - -## Used by - - * [ActionAffordance](ActionAffordance.md) diff --git a/resources/gens/docs/actionAffordance__safe.md b/resources/gens/docs/actionAffordance__safe.md deleted file mode 100644 index 6bad113..0000000 --- a/resources/gens/docs/actionAffordance__safe.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: safe - - -Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action. - -URI: [td:actionAffordance__safe](https://www.w3.org/2019/wot/td#actionAffordance__safe) - - -## Domain and Range - -None → <sub>0..1</sub> [Boolean](types/Boolean.md) - -## Parents - - -## Children - - -## Used by - - * [ActionAffordance](ActionAffordance.md) diff --git a/resources/gens/docs/actionAffordance__synchronous.md b/resources/gens/docs/actionAffordance__synchronous.md deleted file mode 100644 index 85f9302..0000000 --- a/resources/gens/docs/actionAffordance__synchronous.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: synchronous - - -Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made. - -URI: [td:actionAffordance__synchronous](https://www.w3.org/2019/wot/td#actionAffordance__synchronous) - - -## Domain and Range - -None → <sub>0..1</sub> [Boolean](types/Boolean.md) - -## Parents - - -## Children - - -## Used by - - * [ActionAffordance](ActionAffordance.md) diff --git a/resources/gens/docs/actions.md b/resources/gens/docs/actions.md deleted file mode 100644 index 26245c3..0000000 --- a/resources/gens/docs/actions.md +++ /dev/null @@ -1,75 +0,0 @@ - - -# Slot: actions - - -_All Action-based interaction affordances of the Thing._ - - - -URI: [td:actions](https://www.w3.org/2019/wot/td#actions) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [ActionAffordance](ActionAffordance.md) - -* Multivalued: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: actions -description: All Action-based interaction affordances of the Thing. -from_schema: td -rank: 1000 -multivalued: true -alias: actions -owner: Thing -domain_of: -- Thing -range: ActionAffordance -inlined: true - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/additionalExpectedResponse__additionalOutputSchema.md b/resources/gens/docs/additionalExpectedResponse__additionalOutputSchema.md deleted file mode 100644 index df58643..0000000 --- a/resources/gens/docs/additionalExpectedResponse__additionalOutputSchema.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: additionalOutputSchema - - -This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used. - -URI: [td:additionalExpectedResponse__additionalOutputSchema](https://www.w3.org/2019/wot/td#additionalExpectedResponse__additionalOutputSchema) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) diff --git a/resources/gens/docs/additionalExpectedResponse__schema.md b/resources/gens/docs/additionalExpectedResponse__schema.md deleted file mode 100644 index 141417b..0000000 --- a/resources/gens/docs/additionalExpectedResponse__schema.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: schema - - -TODO Check, was not in hctl ontology, if not could be source of discrepancy - -URI: [td:additionalExpectedResponse__schema](https://www.w3.org/2019/wot/td#additionalExpectedResponse__schema) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) diff --git a/resources/gens/docs/additionalExpectedResponse__success.md b/resources/gens/docs/additionalExpectedResponse__success.md deleted file mode 100644 index 4acc7a7..0000000 --- a/resources/gens/docs/additionalExpectedResponse__success.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: success - - -Signals if the additional response should not be considered an error. - -URI: [td:additionalExpectedResponse__success](https://www.w3.org/2019/wot/td#additionalExpectedResponse__success) - - -## Domain and Range - -None → <sub>0..1</sub> [Boolean](types/Boolean.md) - -## Parents - - -## Children - - -## Used by - - * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) diff --git a/resources/gens/docs/additionalOutputSchema.md b/resources/gens/docs/additionalOutputSchema.md deleted file mode 100644 index 48c7bc5..0000000 --- a/resources/gens/docs/additionalOutputSchema.md +++ /dev/null @@ -1,74 +0,0 @@ - - -# Slot: additionalOutputSchema - - -_This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used._ - - - -URI: [td:additionalOutputSchema](https://www.w3.org/2019/wot/td#additionalOutputSchema) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | Communication metadata describing the expected response message for additiona... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: additionalOutputSchema -description: This optional term can be used to define a data schema for an additional - response if it differs from the default output data schema. Rather than a DataSchema - object, the name of a previous definition given in a SchemaDefinitions map must - be used. -from_schema: td -rank: 1000 -alias: additionalOutputSchema -owner: AdditionalExpectedResponse -domain_of: -- AdditionalExpectedResponse -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/additionalReturns.md b/resources/gens/docs/additionalReturns.md deleted file mode 100644 index 063739c..0000000 --- a/resources/gens/docs/additionalReturns.md +++ /dev/null @@ -1,77 +0,0 @@ - - -# Slot: additionalReturns - - -_This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema._ - - - -URI: [td:additionalReturns](https://www.w3.org/2019/wot/td#additionalReturns) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | - - - - - - - -## Properties - -* Range: [AdditionalExpectedResponse](AdditionalExpectedResponse.md) - -* Multivalued: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: additionalReturns -description: This optional term can be used if additional expected responses are possible, - e.g. for error reporting. Each additional response needs to be distinguished from - others in some way (for example, by specifying a protocol-specific response code), - and may also have its own data schema. -from_schema: td -rank: 1000 -multivalued: true -alias: additionalReturns -owner: Form -domain_of: -- Form -range: AdditionalExpectedResponse - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/anchor.md b/resources/gens/docs/anchor.md deleted file mode 100644 index bc4a52f..0000000 --- a/resources/gens/docs/anchor.md +++ /dev/null @@ -1,73 +0,0 @@ - - -# Slot: anchor - - -_By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI._ - - - -URI: [td:anchor](https://www.w3.org/2019/wot/td#anchor) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | - - - - - - - -## Properties - -* Range: [AnyUri](AnyUri.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: anchor -description: By default, the context, or anchor, of a link conveyed in the Link header - field is the URL of the representation it is associated with, as defined in RFC7231, - Section 3.1.4.1, and is serialized as a URI. -from_schema: td -rank: 1000 -alias: anchor -owner: Link -domain_of: -- Link -range: anyUri - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/base.md b/resources/gens/docs/base.md deleted file mode 100644 index e9efb17..0000000 --- a/resources/gens/docs/base.md +++ /dev/null @@ -1,72 +0,0 @@ - - -# Slot: base - - -_Define the base URI that is used for all relative URI references throughout a TD document._ - - - -URI: [td:base](https://www.w3.org/2019/wot/td#base) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [AnyUri](AnyUri.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: base -description: Define the base URI that is used for all relative URI references throughout - a TD document. -from_schema: td -rank: 1000 -alias: base -owner: Thing -domain_of: -- Thing -range: anyUri - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/cancellation.md b/resources/gens/docs/cancellation.md deleted file mode 100644 index 066fb63..0000000 --- a/resources/gens/docs/cancellation.md +++ /dev/null @@ -1,72 +0,0 @@ - - -# Slot: cancellation - - -_Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook._ - - - -URI: [td:cancellation](https://www.w3.org/2019/wot/td#cancellation) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | - - - - - - - -## Properties - -* Range: [DataSchema](DataSchema.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: cancellation -description: Defines any data that needs to be passed to cancel a subscription, e.g., - a specific message to remove a Webhook. -from_schema: td -rank: 1000 -alias: cancellation -owner: EventAffordance -domain_of: -- EventAffordance -range: DataSchema - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/contentCoding.md b/resources/gens/docs/contentCoding.md deleted file mode 100644 index a70e716..0000000 --- a/resources/gens/docs/contentCoding.md +++ /dev/null @@ -1,75 +0,0 @@ - - -# Slot: contentCoding - - -_Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \"gzip\", \"deflate\", etc._ - - - -URI: [td:contentCoding](https://www.w3.org/2019/wot/td#contentCoding) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: contentCoding -description: Content coding values indicate an encoding transformation that has been - or can be applied to a representation. Content codings are primarily used to allow - a representation to be compressed or otherwise usefully transformed without losing - the identity of its underlying media type and without loss of information. Examples - of content coding include \"gzip\", \"deflate\", etc. -from_schema: td -rank: 1000 -alias: contentCoding -owner: Form -domain_of: -- Form -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/contentType.md b/resources/gens/docs/contentType.md deleted file mode 100644 index 58214b7..0000000 --- a/resources/gens/docs/contentType.md +++ /dev/null @@ -1,58 +0,0 @@ - - -# Slot: contentType - -URI: [td:contentType](https://www.w3.org/2019/wot/td#contentType) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [ExpectedResponse](ExpectedResponse.md) | Communication metadata describing the expected response message for the prima... | no | -| [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | Communication metadata describing the expected response message for additiona... | no | -| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - - -## LinkML Source - -<details> -```yaml -name: contentType -alias: contentType -domain_of: -- ExpectedResponse -- Form -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/created.md b/resources/gens/docs/created.md deleted file mode 100644 index 3cb5c7d..0000000 --- a/resources/gens/docs/created.md +++ /dev/null @@ -1,71 +0,0 @@ - - -# Slot: created - - -_Provides information when the TD instance was created._ - - - -URI: [td:created](https://www.w3.org/2019/wot/td#created) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [Datetime](Datetime.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: created -description: Provides information when the TD instance was created. -from_schema: td -rank: 1000 -alias: created -owner: Thing -domain_of: -- Thing -range: datetime - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/dataSchema__propertyName.md b/resources/gens/docs/dataSchema__propertyName.md deleted file mode 100644 index 2a23e5e..0000000 --- a/resources/gens/docs/dataSchema__propertyName.md +++ /dev/null @@ -1,23 +0,0 @@ - -# Slot: propertyName - - -Used to store the indexing name in the parent object when this schema appears as a property of an object schema. - -URI: [td:dataSchema__propertyName](https://www.w3.org/2019/wot/td#dataSchema__propertyName) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [DataSchema](DataSchema.md) - * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/docs/dataSchema__readonly.md b/resources/gens/docs/dataSchema__readonly.md deleted file mode 100644 index da62dd8..0000000 --- a/resources/gens/docs/dataSchema__readonly.md +++ /dev/null @@ -1,23 +0,0 @@ - -# Slot: readonly - - -Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false). - -URI: [td:dataSchema__readonly](https://www.w3.org/2019/wot/td#dataSchema__readonly) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [DataSchema](DataSchema.md) - * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/docs/dataSchema__writeOnly.md b/resources/gens/docs/dataSchema__writeOnly.md deleted file mode 100644 index 0aa99e7..0000000 --- a/resources/gens/docs/dataSchema__writeOnly.md +++ /dev/null @@ -1,23 +0,0 @@ - -# Slot: writeOnly - - -Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false). - -URI: [td:dataSchema__writeOnly](https://www.w3.org/2019/wot/td#dataSchema__writeOnly) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [DataSchema](DataSchema.md) - * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/docs/description.md b/resources/gens/docs/description.md deleted file mode 100644 index e28cfbb..0000000 --- a/resources/gens/docs/description.md +++ /dev/null @@ -1,73 +0,0 @@ - - -# Slot: description - -URI: [td:description](https://www.w3.org/2019/wot/td#description) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [SecurityScheme](SecurityScheme.md) | | no | -| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | -| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | -| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | -| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | - - - - - - - -## Properties - -* Range: [MultiLanguage](MultiLanguage.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: description -from_schema: td -rank: 1000 -alias: description -domain_of: -- SecurityScheme -- DataSchema -- InteractionAffordance -- Thing -range: MultiLanguage - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/descriptionInLanguage.md b/resources/gens/docs/descriptionInLanguage.md deleted file mode 100644 index f866185..0000000 --- a/resources/gens/docs/descriptionInLanguage.md +++ /dev/null @@ -1,79 +0,0 @@ - - -# Slot: descriptionInLanguage - - -_description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description._ - - - -URI: [td:descriptionInLanguage](https://www.w3.org/2019/wot/td#descriptionInLanguage) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | -| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | -| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | -| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | - - - - - - - -## Properties - -* Range: [MultiLanguage](MultiLanguage.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: descriptionInLanguage -description: description of the TD element (Thing, interaction affordance, security - scheme or data scheme) with language tag. By convention, a language tag must be - added to the object of descriptionInLanguage. Otherwise use description. -from_schema: td -rank: 1000 -alias: descriptionInLanguage -domain_of: -- DataSchema -- InteractionAffordance -- Thing -range: MultiLanguage - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/descriptions.md b/resources/gens/docs/descriptions.md deleted file mode 100644 index 2093bb7..0000000 --- a/resources/gens/docs/descriptions.md +++ /dev/null @@ -1,82 +0,0 @@ - - -# Slot: descriptions - - -_TODO, check, according to the description a description should not contain a lang tag._ - - - -URI: [td:descriptions](https://www.w3.org/2019/wot/td#descriptions) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [SecurityScheme](SecurityScheme.md) | | no | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | -| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | -| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | -| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | - - - - - - - -## Properties - -* Range: [MultiLanguage](MultiLanguage.md) - -* Multivalued: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: descriptions -description: TODO, check, according to the description a description should not contain - a lang tag. -from_schema: td -rank: 1000 -multivalued: true -alias: descriptions -domain_of: -- SecurityScheme -- InteractionAffordance -- Thing -range: MultiLanguage -inlined: true - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/eventAffordance__cancellation.md b/resources/gens/docs/eventAffordance__cancellation.md deleted file mode 100644 index 58c6616..0000000 --- a/resources/gens/docs/eventAffordance__cancellation.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: cancellation - - -Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook. - -URI: [td:eventAffordance__cancellation](https://www.w3.org/2019/wot/td#eventAffordance__cancellation) - - -## Domain and Range - -None → <sub>0..1</sub> [DataSchema](DataSchema.md) - -## Parents - - -## Children - - -## Used by - - * [EventAffordance](EventAffordance.md) diff --git a/resources/gens/docs/eventAffordance__notification.md b/resources/gens/docs/eventAffordance__notification.md deleted file mode 100644 index f52e864..0000000 --- a/resources/gens/docs/eventAffordance__notification.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: notification - - -Defines the data schema of the Event instance messages pushed by the Thing. - -URI: [td:eventAffordance__notification](https://www.w3.org/2019/wot/td#eventAffordance__notification) - - -## Domain and Range - -None → <sub>0..1</sub> [DataSchema](DataSchema.md) - -## Parents - - -## Children - - -## Used by - - * [EventAffordance](EventAffordance.md) diff --git a/resources/gens/docs/eventAffordance__notificationResponse.md b/resources/gens/docs/eventAffordance__notificationResponse.md deleted file mode 100644 index 554aa4e..0000000 --- a/resources/gens/docs/eventAffordance__notificationResponse.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: notificationResponse - - -Defines the data schema of the Event response messages sent by the consumer in a response to a data message. - -URI: [td:eventAffordance__notificationResponse](https://www.w3.org/2019/wot/td#eventAffordance__notificationResponse) - - -## Domain and Range - -None → <sub>0..1</sub> [DataSchema](DataSchema.md) - -## Parents - - -## Children - - -## Used by - - * [EventAffordance](EventAffordance.md) diff --git a/resources/gens/docs/eventAffordance__subscription.md b/resources/gens/docs/eventAffordance__subscription.md deleted file mode 100644 index 4975c2b..0000000 --- a/resources/gens/docs/eventAffordance__subscription.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: subscription - - -Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks. - -URI: [td:eventAffordance__subscription](https://www.w3.org/2019/wot/td#eventAffordance__subscription) - - -## Domain and Range - -None → <sub>0..1</sub> [DataSchema](DataSchema.md) - -## Parents - - -## Children - - -## Used by - - * [EventAffordance](EventAffordance.md) diff --git a/resources/gens/docs/events.md b/resources/gens/docs/events.md deleted file mode 100644 index e1144a3..0000000 --- a/resources/gens/docs/events.md +++ /dev/null @@ -1,75 +0,0 @@ - - -# Slot: events - - -_All Event-based interaction affordances of the Thing._ - - - -URI: [td:events](https://www.w3.org/2019/wot/td#events) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [EventAffordance](EventAffordance.md) - -* Multivalued: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: events -description: All Event-based interaction affordances of the Thing. -from_schema: td -rank: 1000 -multivalued: true -alias: events -owner: Thing -domain_of: -- Thing -range: EventAffordance -inlined: true - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/expectedResponse__contentType.md b/resources/gens/docs/expectedResponse__contentType.md deleted file mode 100644 index 594d0c8..0000000 --- a/resources/gens/docs/expectedResponse__contentType.md +++ /dev/null @@ -1,23 +0,0 @@ - -# Slot: contentType - - -TODO Check, was not in hctl ontology, if not could be source of discrepancy - -URI: [td:expectedResponse__contentType](https://www.w3.org/2019/wot/td#expectedResponse__contentType) - - -## Domain and Range - -None → <sub>1..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) - * [ExpectedResponse](ExpectedResponse.md) diff --git a/resources/gens/docs/form__additionalReturns.md b/resources/gens/docs/form__additionalReturns.md deleted file mode 100644 index 5c82d86..0000000 --- a/resources/gens/docs/form__additionalReturns.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: additionalReturns - - -This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema. - -URI: [td:form__additionalReturns](https://www.w3.org/2019/wot/td#form__additionalReturns) - - -## Domain and Range - -None → <sub>0..\*</sub> [AdditionalExpectedResponse](AdditionalExpectedResponse.md) - -## Parents - - -## Children - - -## Used by - - * [Form](Form.md) diff --git a/resources/gens/docs/form__contentCoding.md b/resources/gens/docs/form__contentCoding.md deleted file mode 100644 index bc9cf0c..0000000 --- a/resources/gens/docs/form__contentCoding.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: contentCoding - - -Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \"gzip\", \"deflate\", etc. - -URI: [td:form__contentCoding](https://www.w3.org/2019/wot/td#form__contentCoding) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [Form](Form.md) diff --git a/resources/gens/docs/form__contentType.md b/resources/gens/docs/form__contentType.md deleted file mode 100644 index 0dc84dc..0000000 --- a/resources/gens/docs/form__contentType.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: contentType - - -Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type. - -URI: [td:form__contentType](https://www.w3.org/2019/wot/td#form__contentType) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [Form](Form.md) diff --git a/resources/gens/docs/form__href.md b/resources/gens/docs/form__href.md deleted file mode 100644 index 433da24..0000000 --- a/resources/gens/docs/form__href.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: href - - - - -URI: [td:form__href](https://www.w3.org/2019/wot/td#form__href) - - -## Domain and Range - -None → <sub>1..1</sub> [AnyUri](types/AnyUri.md) - -## Parents - - -## Children - - -## Used by - - * [Form](Form.md) diff --git a/resources/gens/docs/form__operationType.md b/resources/gens/docs/form__operationType.md deleted file mode 100644 index 80ce5be..0000000 --- a/resources/gens/docs/form__operationType.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: operationType - - -Indicates the semantic intention of performing the operation(s) described by the form. - -URI: [td:form__operationType](https://www.w3.org/2019/wot/td#form__operationType) - - -## Domain and Range - -None → <sub>0..\*</sub> [OperationTypes](OperationTypes.md) - -## Parents - - -## Children - - -## Used by - - * [Form](Form.md) diff --git a/resources/gens/docs/form__returns.md b/resources/gens/docs/form__returns.md deleted file mode 100644 index e2bb8cf..0000000 --- a/resources/gens/docs/form__returns.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: returns - - -This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages. - -URI: [td:form__returns](https://www.w3.org/2019/wot/td#form__returns) - - -## Domain and Range - -None → <sub>0..1</sub> [ExpectedResponse](ExpectedResponse.md) - -## Parents - - -## Children - - -## Used by - - * [Form](Form.md) diff --git a/resources/gens/docs/form__scopes.md b/resources/gens/docs/form__scopes.md deleted file mode 100644 index 2527760..0000000 --- a/resources/gens/docs/form__scopes.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: scopes - - -TODO Check, was not in hctl ontology, if not could be source of discrepancy - -URI: [td:form__scopes](https://www.w3.org/2019/wot/td#form__scopes) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [Form](Form.md) diff --git a/resources/gens/docs/form__securityDefinitions.md b/resources/gens/docs/form__securityDefinitions.md deleted file mode 100644 index 94eadf0..0000000 --- a/resources/gens/docs/form__securityDefinitions.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: securityDefinitions - - -A security schema applied to a (set of) affordance(s). - -URI: [td:form__securityDefinitions](https://www.w3.org/2019/wot/td#form__securityDefinitions) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [Form](Form.md) diff --git a/resources/gens/docs/form__subprotocol.md b/resources/gens/docs/form__subprotocol.md deleted file mode 100644 index a1f0776..0000000 --- a/resources/gens/docs/form__subprotocol.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: subprotocol - - -Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options. - -URI: [td:form__subprotocol](https://www.w3.org/2019/wot/td#form__subprotocol) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [Form](Form.md) diff --git a/resources/gens/docs/forms.md b/resources/gens/docs/forms.md deleted file mode 100644 index f0f1542..0000000 --- a/resources/gens/docs/forms.md +++ /dev/null @@ -1,60 +0,0 @@ - - -# Slot: forms - -URI: [td:forms](https://www.w3.org/2019/wot/td#forms) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | -| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | -| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | -| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - - -## LinkML Source - -<details> -```yaml -name: forms -alias: forms -domain_of: -- InteractionAffordance -- Thing -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/hintsAtMediaType.md b/resources/gens/docs/hintsAtMediaType.md deleted file mode 100644 index 0f9b41a..0000000 --- a/resources/gens/docs/hintsAtMediaType.md +++ /dev/null @@ -1,72 +0,0 @@ - - -# Slot: hintsAtMediaType - - -_Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be._ - - - -URI: [td:hintsAtMediaType](https://www.w3.org/2019/wot/td#hintsAtMediaType) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: hintsAtMediaType -description: Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] - of the result of dereferencing the link should be. -from_schema: td -rank: 1000 -alias: hintsAtMediaType -owner: Link -domain_of: -- Link -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/href.md b/resources/gens/docs/href.md deleted file mode 100644 index 407d53d..0000000 --- a/resources/gens/docs/href.md +++ /dev/null @@ -1,68 +0,0 @@ - - -# Slot: href - -URI: [td:href](https://www.w3.org/2019/wot/td#href) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | - - - - - - - -## Properties - -* Range: [AnyUri](AnyUri.md) - -* Required: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: href -from_schema: td -rank: 1000 -alias: href -owner: Form -domain_of: -- Form -range: anyUri -required: true - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/hreflang.md b/resources/gens/docs/hreflang.md deleted file mode 100644 index 260d11b..0000000 --- a/resources/gens/docs/hreflang.md +++ /dev/null @@ -1,75 +0,0 @@ - - -# Slot: hreflang - - -_The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]._ - - - -URI: [td:hreflang](https://www.w3.org/2019/wot/td#hreflang) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - -* Regex pattern: `^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$` - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: hreflang -description: The hreflang attribute specifies the language of a linked document. The - value of this must be a valid language tag [[BCP47]]. -from_schema: td -rank: 1000 -alias: hreflang -owner: Link -domain_of: -- Link -range: string -pattern: ^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/id.md b/resources/gens/docs/id.md deleted file mode 100644 index ac908ff..0000000 --- a/resources/gens/docs/id.md +++ /dev/null @@ -1,75 +0,0 @@ - - -# Slot: id - - -_TODO_ - - - -URI: [td:id](https://www.w3.org/2019/wot/td#id) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [AnyUri](AnyUri.md) - -* Required: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: id -description: TODO -from_schema: td -rank: 1000 -slot_uri: td:id -identifier: true -alias: id -domain_of: -- Thing -range: anyUri -required: true - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/idempotent.md b/resources/gens/docs/idempotent.md deleted file mode 100644 index ad5cff3..0000000 --- a/resources/gens/docs/idempotent.md +++ /dev/null @@ -1,73 +0,0 @@ - - -# Slot: idempotent - - -_Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input._ - - - -URI: [td:idempotent](https://www.w3.org/2019/wot/td#idempotent) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | - - - - - - - -## Properties - -* Range: [Boolean](Boolean.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: idempotent -description: Indicates whether the action is idempotent (=true) or not. Informs whether - the action can be called repeatedly with the same results, if present, based on - the same input. -from_schema: td -rank: 1000 -alias: idempotent -owner: ActionAffordance -domain_of: -- ActionAffordance -range: boolean - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/index.md b/resources/gens/docs/index.md deleted file mode 100644 index aaa1ef6..0000000 --- a/resources/gens/docs/index.md +++ /dev/null @@ -1,135 +0,0 @@ -# thing-description-schema - -LinkML schema for modelling the Web of Things Thing Description information model. This schema is used to generate -JSON Schema, SHACL shapes, and RDF. - -URI: td - -Name: thing-description-schema - - - -## Classes - -| Class | Description | -| --- | --- | -| [DataSchema](DataSchema.md) | Metadata that describes the data format used. It can be used for validation. | -| [ExpectedResponse](ExpectedResponse.md) | Communication metadata describing the expected response message for the primary response. | -|         [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | Communication metadata describing the expected response message for additional responses. | -| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions. | -| [InteractionAffordance](InteractionAffordance.md) | TOOD | -|         [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time). | -|         [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts). | -|         [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated. | -| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relation type resource at link target", where the optional target attributes may further describe the resource. | -| [MultiLanguage](MultiLanguage.md) | None | -| [SecurityScheme](SecurityScheme.md) | None | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things. | -| [VersionInfo](VersionInfo.md) | Provides version information. | - - - -## Slots - -| Slot | Description | -| --- | --- | -| [@type](@type.md) | | -| [actions](actions.md) | All Action-based interaction affordances of the Thing | -| [additionalOutputSchema](additionalOutputSchema.md) | This optional term can be used to define a data schema for an additional resp... | -| [additionalReturns](additionalReturns.md) | This optional term can be used if additional expected responses are possible,... | -| [anchor](anchor.md) | By default, the context, or anchor, of a link conveyed in the Link header fie... | -| [base](base.md) | Define the base URI that is used for all relative URI references throughout a... | -| [cancellation](cancellation.md) | Defines any data that needs to be passed to cancel a subscription, e | -| [contentCoding](contentCoding.md) | Content coding values indicate an encoding transformation that has been or ca... | -| [contentType](contentType.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | -| [created](created.md) | Provides information when the TD instance was created | -| [description](description.md) | | -| [descriptionInLanguage](descriptionInLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | -| [descriptions](descriptions.md) | TODO, check, according to the description a description should not contain a ... | -| [events](events.md) | All Event-based interaction affordances of the Thing | -| [forms](forms.md) | Set of form hypermedia controls that describe how an operation can be perform... | -| [hintsAtMediaType](hintsAtMediaType.md) | Target attribute providing a hint indicating what the media type [IANA-MEDIA-... | -| [href](href.md) | | -| [hreflang](hreflang.md) | The hreflang attribute specifies the language of a linked document | -| [id](id.md) | TODO | -| [idempotent](idempotent.md) | Indicates whether the action is idempotent (=true) or not | -| [input](input.md) | Used to define the input data schema of the action | -| [instance](instance.md) | | -| [key](key.md) | | -| [links](links.md) | Provides Web links to arbitrary resources that relate to the specified Thing ... | -| [model](model.md) | | -| [modified](modified.md) | Provides information when the TD instance was last modified | -| [name](name.md) | Indexing property to store entity names when serializing them in a JSON-LD @i... | -| [notification](notification.md) | Defines the data schema of the Event instance messages pushed by the Thing | -| [notificationResponse](notificationResponse.md) | Defines the data schema of the Event response messages sent by the consumer i... | -| [observable](observable.md) | A hint that indicates whether Servients hosting the Thing and Intermediaries ... | -| [operationType](operationType.md) | Indicates the semantic intention of performing the operation(s) described by ... | -| [output](output.md) | Used to define the output data schema of the action | -| [profile](profile.md) | Indicates the WoT Profile mechanisms followed by this Thing Description and t... | -| [properties](properties.md) | All Property-based interaction affordances of the Thing | -| [propertyName](propertyName.md) | Used to store the indexing name in the parent object when this schema appears... | -| [proxy](proxy.md) | URI of the proxy server this security configuration provides access to | -| [readonly](readonly.md) | Boolean value that is a hint to indicate whether a property interaction/value... | -| [relation](relation.md) | A link relation type identifies the semantics of a link | -| [returns](returns.md) | This optional term can be used if, e | -| [safe](safe.md) | Signals if the action is safe (=true) or not | -| [schema](schema.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | -| [schemaDefinitions](schemaDefinitions.md) | TODO CHECK | -| [scheme](scheme.md) | | -| [scopes](scopes.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | -| [security](security.md) | A Thing may define abstract security schemes, used to configure the secure ac... | -| [securityDefinitions](securityDefinitions.md) | A security schema applied to a (set of) affordance(s) | -| [sizes](sizes.md) | Target attribute that specifies one or more sizes for the referenced icon | -| [subprotocol](subprotocol.md) | Indicates the exact mechanism by which an interaction will be accomplished fo... | -| [subscription](subscription.md) | Defines data that needs to be passed upon subscription, e | -| [success](success.md) | Signals if the additional response should not be considered an error | -| [supportContact](supportContact.md) | Provides information about the TD maintainer as URI scheme (e | -| [synchronous](synchronous.md) | Indicates whether the action is synchronous (=true) or not | -| [target](target.md) | Target IRI of a link or submission target of a Form | -| [title](title.md) | Provides a human-readable title (e | -| [titleInLanguage](titleInLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | -| [titles](titles.md) | | -| [type](type.md) | | -| [uriVariables](uriVariables.md) | Define URI template variables according to RFC6570 as collection based on sch... | -| [version](version.md) | | -| [writeOnly](writeOnly.md) | Boolean value that is a hint to indicate whether a property interaction/value... | - - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [OperationTypes](OperationTypes.md) | Enumerations of well-known operation types necessary to implement the WoT int... | -| [SecuritySchemeType](SecuritySchemeType.md) | | - - -## Types - -| Type | Description | -| --- | --- | -| [AnyUri](AnyUri.md) | a complete URI | -| [Boolean](Boolean.md) | A binary (true or false) value | -| [Curie](Curie.md) | a compact URI | -| [Date](Date.md) | a date (year, month and day) in an idealized calendar | -| [DateOrDatetime](DateOrDatetime.md) | Either a date or a datetime | -| [Datetime](Datetime.md) | The combination of a date and time | -| [Decimal](Decimal.md) | A real number with arbitrary precision that conforms to the xsd:decimal speci... | -| [Double](Double.md) | A real number that conforms to the xsd:double specification | -| [Float](Float.md) | A real number that conforms to the xsd:float specification | -| [Integer](Integer.md) | An integer | -| [Jsonpath](Jsonpath.md) | A string encoding a JSON Path | -| [Jsonpointer](Jsonpointer.md) | A string encoding a JSON Pointer | -| [Ncname](Ncname.md) | Prefix part of CURIE | -| [Nodeidentifier](Nodeidentifier.md) | A URI, CURIE or BNODE that represents a node in a model | -| [Objectidentifier](Objectidentifier.md) | A URI or CURIE that represents an object in the model | -| [Sparqlpath](Sparqlpath.md) | A string encoding a SPARQL Property Path | -| [String](String.md) | A character string | -| [Time](Time.md) | A time object represents a (local) time of day, independent of any particular... | -| [Uri](Uri.md) | a complete URI | -| [Uriorcurie](Uriorcurie.md) | a URI or a CURIE | - - -## Subsets - -| Subset | Description | -| --- | --- | diff --git a/resources/gens/docs/input.md b/resources/gens/docs/input.md deleted file mode 100644 index 0120c04..0000000 --- a/resources/gens/docs/input.md +++ /dev/null @@ -1,71 +0,0 @@ - - -# Slot: input - - -_Used to define the input data schema of the action._ - - - -URI: [td:input](https://www.w3.org/2019/wot/td#input) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | - - - - - - - -## Properties - -* Range: [DataSchema](DataSchema.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: input -description: Used to define the input data schema of the action. -from_schema: td -rank: 1000 -alias: input -owner: ActionAffordance -domain_of: -- ActionAffordance -range: DataSchema - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/instance.md b/resources/gens/docs/instance.md deleted file mode 100644 index 608bbe3..0000000 --- a/resources/gens/docs/instance.md +++ /dev/null @@ -1,57 +0,0 @@ - - -# Slot: instance - -URI: [td:instance](https://www.w3.org/2019/wot/td#instance) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [VersionInfo](VersionInfo.md) | Provides version information | no | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - - -## LinkML Source - -<details> -```yaml -name: instance -alias: instance -domain_of: -- VersionInfo -- Thing -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/interactionAffordance__forms.md b/resources/gens/docs/interactionAffordance__forms.md deleted file mode 100644 index 3baa9c9..0000000 --- a/resources/gens/docs/interactionAffordance__forms.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Slot: forms - - -Set of form hypermedia controls that describe how an operation can be performed. - -URI: [td:interactionAffordance__forms](https://www.w3.org/2019/wot/td#interactionAffordance__forms) - - -## Domain and Range - -None → <sub>0..\*</sub> [Form](Form.md) - -## Parents - - -## Children - - -## Used by - - * [ActionAffordance](ActionAffordance.md) - * [EventAffordance](EventAffordance.md) - * [InteractionAffordance](InteractionAffordance.md) - * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/docs/interactionAffordance__name.md b/resources/gens/docs/interactionAffordance__name.md deleted file mode 100644 index c64f7e4..0000000 --- a/resources/gens/docs/interactionAffordance__name.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Slot: name - - -Indexing property to store entity names when serializing them in a JSON-LD @index container. - -URI: [td:interactionAffordance__name](https://www.w3.org/2019/wot/td#interactionAffordance__name) - - -## Domain and Range - -None → <sub>1..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [ActionAffordance](ActionAffordance.md) - * [EventAffordance](EventAffordance.md) - * [InteractionAffordance](InteractionAffordance.md) - * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/docs/interactionAffordance__uriVariables.md b/resources/gens/docs/interactionAffordance__uriVariables.md deleted file mode 100644 index bd13092..0000000 --- a/resources/gens/docs/interactionAffordance__uriVariables.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Slot: uriVariables - - -Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. - -URI: [td:interactionAffordance__uriVariables](https://www.w3.org/2019/wot/td#interactionAffordance__uriVariables) - - -## Domain and Range - -None → <sub>0..\*</sub> [DataSchema](DataSchema.md) - -## Parents - - -## Children - - -## Used by - - * [ActionAffordance](ActionAffordance.md) - * [EventAffordance](EventAffordance.md) - * [InteractionAffordance](InteractionAffordance.md) - * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/docs/key.md b/resources/gens/docs/key.md deleted file mode 100644 index 2b8ad23..0000000 --- a/resources/gens/docs/key.md +++ /dev/null @@ -1,72 +0,0 @@ - - -# Slot: key - -URI: [td:key](https://www.w3.org/2019/wot/td#key) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [MultiLanguage](MultiLanguage.md) | | no | - - - - - - - -## Properties - -* Range: [String](String.md) - -* Required: True - -* Regex pattern: `^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$` - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: key -from_schema: td -rank: 1000 -identifier: true -alias: key -owner: MultiLanguage -domain_of: -- MultiLanguage -range: string -required: true -pattern: ^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/link__anchor.md b/resources/gens/docs/link__anchor.md deleted file mode 100644 index 0c252bd..0000000 --- a/resources/gens/docs/link__anchor.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: anchor - - -By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI. - -URI: [td:link__anchor](https://www.w3.org/2019/wot/td#link__anchor) - - -## Domain and Range - -None → <sub>0..1</sub> [AnyUri](types/AnyUri.md) - -## Parents - - -## Children - - -## Used by - - * [Link](Link.md) diff --git a/resources/gens/docs/link__hintsAtMediaType.md b/resources/gens/docs/link__hintsAtMediaType.md deleted file mode 100644 index 7cc13ed..0000000 --- a/resources/gens/docs/link__hintsAtMediaType.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: hintsAtMediaType - - -Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. - -URI: [td:link__hintsAtMediaType](https://www.w3.org/2019/wot/td#link__hintsAtMediaType) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [Link](Link.md) diff --git a/resources/gens/docs/link__hreflang.md b/resources/gens/docs/link__hreflang.md deleted file mode 100644 index c7bfced..0000000 --- a/resources/gens/docs/link__hreflang.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: hreflang - - -The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]. - -URI: [td:link__hreflang](https://www.w3.org/2019/wot/td#link__hreflang) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [Link](Link.md) diff --git a/resources/gens/docs/link__relation.md b/resources/gens/docs/link__relation.md deleted file mode 100644 index d158fd5..0000000 --- a/resources/gens/docs/link__relation.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: relation - - -A link relation type identifies the semantics of a link. - -URI: [td:link__relation](https://www.w3.org/2019/wot/td#link__relation) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [Link](Link.md) diff --git a/resources/gens/docs/link__sizes.md b/resources/gens/docs/link__sizes.md deleted file mode 100644 index d263e9e..0000000 --- a/resources/gens/docs/link__sizes.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: sizes - - -Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \"16x16\", \"16x16 32x32\"). - -URI: [td:link__sizes](https://www.w3.org/2019/wot/td#link__sizes) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [Link](Link.md) diff --git a/resources/gens/docs/link__type.md b/resources/gens/docs/link__type.md deleted file mode 100644 index a6c71a6..0000000 --- a/resources/gens/docs/link__type.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: type - - - - -URI: [td:link__type](https://www.w3.org/2019/wot/td#link__type) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [Link](Link.md) diff --git a/resources/gens/docs/links.md b/resources/gens/docs/links.md deleted file mode 100644 index 44e1875..0000000 --- a/resources/gens/docs/links.md +++ /dev/null @@ -1,75 +0,0 @@ - - -# Slot: links - - -_Provides Web links to arbitrary resources that relate to the specified Thing Description._ - - - -URI: [td:links](https://www.w3.org/2019/wot/td#links) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [Link](Link.md) - -* Multivalued: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: links -description: Provides Web links to arbitrary resources that relate to the specified - Thing Description. -from_schema: td -rank: 1000 -multivalued: true -alias: links -owner: Thing -domain_of: -- Thing -range: Link - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/model.md b/resources/gens/docs/model.md deleted file mode 100644 index 126cd46..0000000 --- a/resources/gens/docs/model.md +++ /dev/null @@ -1,65 +0,0 @@ - - -# Slot: model - -URI: [td:model](https://www.w3.org/2019/wot/td#model) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [VersionInfo](VersionInfo.md) | Provides version information | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: model -from_schema: td -rank: 1000 -alias: model -owner: VersionInfo -domain_of: -- VersionInfo -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/modified.md b/resources/gens/docs/modified.md deleted file mode 100644 index 97e2144..0000000 --- a/resources/gens/docs/modified.md +++ /dev/null @@ -1,71 +0,0 @@ - - -# Slot: modified - - -_Provides information when the TD instance was last modified._ - - - -URI: [td:modified](https://www.w3.org/2019/wot/td#modified) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [Datetime](Datetime.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: modified -description: Provides information when the TD instance was last modified. -from_schema: td -rank: 1000 -alias: modified -owner: Thing -domain_of: -- Thing -range: datetime - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/multiLanguage__key.md b/resources/gens/docs/multiLanguage__key.md deleted file mode 100644 index 38f7fbf..0000000 --- a/resources/gens/docs/multiLanguage__key.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: key - - - - -URI: [td:multiLanguage__key](https://www.w3.org/2019/wot/td#multiLanguage__key) - - -## Domain and Range - -None → <sub>1..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [MultiLanguage](MultiLanguage.md) diff --git a/resources/gens/docs/name.md b/resources/gens/docs/name.md deleted file mode 100644 index c551b23..0000000 --- a/resources/gens/docs/name.md +++ /dev/null @@ -1,79 +0,0 @@ - - -# Slot: name - - -_Indexing property to store entity names when serializing them in a JSON-LD @index container._ - - - -URI: [td:name](https://www.w3.org/2019/wot/td#name) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | -| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | -| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | -| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | - - - - - - - -## Properties - -* Range: [String](String.md) - -* Required: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: name -description: Indexing property to store entity names when serializing them in a JSON-LD - @index container. -from_schema: td -rank: 1000 -identifier: true -alias: name -owner: InteractionAffordance -domain_of: -- InteractionAffordance -range: string -required: true - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/notification.md b/resources/gens/docs/notification.md deleted file mode 100644 index 7aff397..0000000 --- a/resources/gens/docs/notification.md +++ /dev/null @@ -1,72 +0,0 @@ - - -# Slot: notification - - -_Defines the data schema of the Event instance messages pushed by the Thing._ - - - -URI: [td:notification](https://www.w3.org/2019/wot/td#notification) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | - - - - - - - -## Properties - -* Range: [DataSchema](DataSchema.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: notification -description: Defines the data schema of the Event instance messages pushed by the - Thing. -from_schema: td -rank: 1000 -alias: notification -owner: EventAffordance -domain_of: -- EventAffordance -range: DataSchema - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/notificationResponse.md b/resources/gens/docs/notificationResponse.md deleted file mode 100644 index 4cb181e..0000000 --- a/resources/gens/docs/notificationResponse.md +++ /dev/null @@ -1,72 +0,0 @@ - - -# Slot: notificationResponse - - -_Defines the data schema of the Event response messages sent by the consumer in a response to a data message._ - - - -URI: [td:notificationResponse](https://www.w3.org/2019/wot/td#notificationResponse) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | - - - - - - - -## Properties - -* Range: [DataSchema](DataSchema.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: notificationResponse -description: Defines the data schema of the Event response messages sent by the consumer - in a response to a data message. -from_schema: td -rank: 1000 -alias: notificationResponse -owner: EventAffordance -domain_of: -- EventAffordance -range: DataSchema - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/observable.md b/resources/gens/docs/observable.md deleted file mode 100644 index c648302..0000000 --- a/resources/gens/docs/observable.md +++ /dev/null @@ -1,73 +0,0 @@ - - -# Slot: observable - - -_A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property._ - - - -URI: [td:observable](https://www.w3.org/2019/wot/td#observable) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | - - - - - - - -## Properties - -* Range: [Boolean](Boolean.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: observable -description: A hint that indicates whether Servients hosting the Thing and Intermediaries - should probide a Protocol Binding that supports the observeproperty and unobserveproperty - operations for this Property. -from_schema: td -rank: 1000 -alias: observable -owner: PropertyAffordance -domain_of: -- PropertyAffordance -range: boolean - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/operationType.md b/resources/gens/docs/operationType.md deleted file mode 100644 index eb3a694..0000000 --- a/resources/gens/docs/operationType.md +++ /dev/null @@ -1,75 +0,0 @@ - - -# Slot: operationType - - -_Indicates the semantic intention of performing the operation(s) described by the form._ - - - -URI: [td:operationType](https://www.w3.org/2019/wot/td#operationType) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | - - - - - - - -## Properties - -* Range: [OperationTypes](OperationTypes.md) - -* Multivalued: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: operationType -description: Indicates the semantic intention of performing the operation(s) described - by the form. -from_schema: td -rank: 1000 -multivalued: true -alias: operationType -owner: Form -domain_of: -- Form -range: OperationTypes - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/output.md b/resources/gens/docs/output.md deleted file mode 100644 index f856185..0000000 --- a/resources/gens/docs/output.md +++ /dev/null @@ -1,71 +0,0 @@ - - -# Slot: output - - -_Used to define the output data schema of the action._ - - - -URI: [td:output](https://www.w3.org/2019/wot/td#output) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | - - - - - - - -## Properties - -* Range: [DataSchema](DataSchema.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: output -description: Used to define the output data schema of the action. -from_schema: td -rank: 1000 -alias: output -owner: ActionAffordance -domain_of: -- ActionAffordance -range: DataSchema - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/profile.md b/resources/gens/docs/profile.md deleted file mode 100644 index 1a976fd..0000000 --- a/resources/gens/docs/profile.md +++ /dev/null @@ -1,75 +0,0 @@ - - -# Slot: profile - - -_Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation._ - - - -URI: [td:profile](https://www.w3.org/2019/wot/td#profile) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [AnyUri](AnyUri.md) - -* Multivalued: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: profile -description: Indicates the WoT Profile mechanisms followed by this Thing Description - and the corresponding Thing implementation. -from_schema: td -rank: 1000 -multivalued: true -alias: profile -owner: Thing -domain_of: -- Thing -range: anyUri - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/properties.md b/resources/gens/docs/properties.md deleted file mode 100644 index 96fff72..0000000 --- a/resources/gens/docs/properties.md +++ /dev/null @@ -1,75 +0,0 @@ - - -# Slot: properties - - -_All Property-based interaction affordances of the Thing._ - - - -URI: [td:properties](https://www.w3.org/2019/wot/td#properties) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [PropertyAffordance](PropertyAffordance.md) - -* Multivalued: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: properties -description: All Property-based interaction affordances of the Thing. -from_schema: td -rank: 1000 -multivalued: true -alias: properties -owner: Thing -domain_of: -- Thing -range: PropertyAffordance -inlined: true - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/propertyAffordance__observable.md b/resources/gens/docs/propertyAffordance__observable.md deleted file mode 100644 index 5f3796d..0000000 --- a/resources/gens/docs/propertyAffordance__observable.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: observable - - -A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property. - -URI: [td:propertyAffordance__observable](https://www.w3.org/2019/wot/td#propertyAffordance__observable) - - -## Domain and Range - -None → <sub>0..1</sub> [Boolean](types/Boolean.md) - -## Parents - - -## Children - - -## Used by - - * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/docs/propertyName.md b/resources/gens/docs/propertyName.md deleted file mode 100644 index b3f2ee5..0000000 --- a/resources/gens/docs/propertyName.md +++ /dev/null @@ -1,73 +0,0 @@ - - -# Slot: propertyName - - -_Used to store the indexing name in the parent object when this schema appears as a property of an object schema._ - - - -URI: [td:propertyName](https://www.w3.org/2019/wot/td#propertyName) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | -| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: propertyName -description: Used to store the indexing name in the parent object when this schema - appears as a property of an object schema. -from_schema: td -rank: 1000 -alias: propertyName -owner: DataSchema -domain_of: -- DataSchema -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/proxy.md b/resources/gens/docs/proxy.md deleted file mode 100644 index b696b29..0000000 --- a/resources/gens/docs/proxy.md +++ /dev/null @@ -1,72 +0,0 @@ - - -# Slot: proxy - - -_URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint._ - - - -URI: [td:proxy](https://www.w3.org/2019/wot/td#proxy) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [SecurityScheme](SecurityScheme.md) | | no | - - - - - - - -## Properties - -* Range: [AnyUri](AnyUri.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: proxy -description: URI of the proxy server this security configuration provides access to. - If not given, the corresponding security configuration is for the endpoint. -from_schema: td -rank: 1000 -alias: proxy -owner: SecurityScheme -domain_of: -- SecurityScheme -range: anyUri - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/readonly.md b/resources/gens/docs/readonly.md deleted file mode 100644 index c263882..0000000 --- a/resources/gens/docs/readonly.md +++ /dev/null @@ -1,73 +0,0 @@ - - -# Slot: readonly - - -_Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false)._ - - - -URI: [td:readonly](https://www.w3.org/2019/wot/td#readonly) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | -| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: readonly -description: Boolean value that is a hint to indicate whether a property interaction/value - is read only (=true) or not (=false). -from_schema: td -rank: 1000 -alias: readonly -owner: DataSchema -domain_of: -- DataSchema -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/relation.md b/resources/gens/docs/relation.md deleted file mode 100644 index 613f0a1..0000000 --- a/resources/gens/docs/relation.md +++ /dev/null @@ -1,71 +0,0 @@ - - -# Slot: relation - - -_A link relation type identifies the semantics of a link._ - - - -URI: [td:relation](https://www.w3.org/2019/wot/td#relation) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: relation -description: A link relation type identifies the semantics of a link. -from_schema: td -rank: 1000 -alias: relation -owner: Link -domain_of: -- Link -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/returns.md b/resources/gens/docs/returns.md deleted file mode 100644 index 4f4a4a1..0000000 --- a/resources/gens/docs/returns.md +++ /dev/null @@ -1,73 +0,0 @@ - - -# Slot: returns - - -_This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages._ - - - -URI: [td:returns](https://www.w3.org/2019/wot/td#returns) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | - - - - - - - -## Properties - -* Range: [ExpectedResponse](ExpectedResponse.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: returns -description: This optional term can be used if, e.g., the output communication metadata - differ from input metadata (e.g., output contentType differ from the input contentType). - The response name contains metadata that is only valid for the response messages. -from_schema: td -rank: 1000 -alias: returns -owner: Form -domain_of: -- Form -range: ExpectedResponse - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/safe.md b/resources/gens/docs/safe.md deleted file mode 100644 index 958b463..0000000 --- a/resources/gens/docs/safe.md +++ /dev/null @@ -1,72 +0,0 @@ - - -# Slot: safe - - -_Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action._ - - - -URI: [td:safe](https://www.w3.org/2019/wot/td#safe) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | - - - - - - - -## Properties - -* Range: [Boolean](Boolean.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: safe -description: Signals if the action is safe (=true) or not. Used to signal if there - is no internal state (cf. resource state) is changed when invoking an Action. -from_schema: td -rank: 1000 -alias: safe -owner: ActionAffordance -domain_of: -- ActionAffordance -range: boolean - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/schema.md b/resources/gens/docs/schema.md deleted file mode 100644 index e358a79..0000000 --- a/resources/gens/docs/schema.md +++ /dev/null @@ -1,71 +0,0 @@ - - -# Slot: schema - - -_TODO Check, was not in hctl ontology, if not could be source of discrepancy_ - - - -URI: [td:schema](https://www.w3.org/2019/wot/td#schema) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | Communication metadata describing the expected response message for additiona... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: schema -description: TODO Check, was not in hctl ontology, if not could be source of discrepancy -from_schema: td -rank: 1000 -alias: schema -owner: AdditionalExpectedResponse -domain_of: -- AdditionalExpectedResponse -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/schemaDefinitions.md b/resources/gens/docs/schemaDefinitions.md deleted file mode 100644 index ab96c70..0000000 --- a/resources/gens/docs/schemaDefinitions.md +++ /dev/null @@ -1,74 +0,0 @@ - - -# Slot: schemaDefinitions - - -_TODO CHECK_ - - - -URI: [td:schemaDefinitions](https://www.w3.org/2019/wot/td#schemaDefinitions) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [DataSchema](DataSchema.md) - -* Multivalued: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: schemaDefinitions -description: TODO CHECK -from_schema: td -rank: 1000 -multivalued: true -alias: schemaDefinitions -owner: Thing -domain_of: -- Thing -range: DataSchema - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/scheme.md b/resources/gens/docs/scheme.md deleted file mode 100644 index bf6ea40..0000000 --- a/resources/gens/docs/scheme.md +++ /dev/null @@ -1,68 +0,0 @@ - - -# Slot: scheme - -URI: [td:scheme](https://www.w3.org/2019/wot/td#scheme) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [SecurityScheme](SecurityScheme.md) | | no | - - - - - - - -## Properties - -* Range: [SecuritySchemeType](SecuritySchemeType.md) - -* Required: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: scheme -from_schema: td -rank: 1000 -alias: scheme -owner: SecurityScheme -domain_of: -- SecurityScheme -range: SecuritySchemeType -required: true - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/scopes.md b/resources/gens/docs/scopes.md deleted file mode 100644 index 69f6e6a..0000000 --- a/resources/gens/docs/scopes.md +++ /dev/null @@ -1,71 +0,0 @@ - - -# Slot: scopes - - -_TODO Check, was not in hctl ontology, if not could be source of discrepancy_ - - - -URI: [td:scopes](https://www.w3.org/2019/wot/td#scopes) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: scopes -description: TODO Check, was not in hctl ontology, if not could be source of discrepancy -from_schema: td -rank: 1000 -alias: scopes -owner: Form -domain_of: -- Form -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/security.md b/resources/gens/docs/security.md deleted file mode 100644 index e6d3f53..0000000 --- a/resources/gens/docs/security.md +++ /dev/null @@ -1,75 +0,0 @@ - - -# Slot: security - - -_A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check_ - - - -URI: [td:security](https://www.w3.org/2019/wot/td#security) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - -* Multivalued: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: security -description: 'A Thing may define abstract security schemes, used to configure the - secure access of (a set of) affordance(s). TODO: check' -from_schema: td -rank: 1000 -multivalued: true -alias: security -owner: Thing -domain_of: -- Thing -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/securityDefinitions.md b/resources/gens/docs/securityDefinitions.md deleted file mode 100644 index b8092cb..0000000 --- a/resources/gens/docs/securityDefinitions.md +++ /dev/null @@ -1,57 +0,0 @@ - - -# Slot: securityDefinitions - -URI: [td:securityDefinitions](https://www.w3.org/2019/wot/td#securityDefinitions) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - - -## LinkML Source - -<details> -```yaml -name: securityDefinitions -alias: securityDefinitions -domain_of: -- Form -- Thing -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/securityScheme__description.md b/resources/gens/docs/securityScheme__description.md deleted file mode 100644 index 58b4fdc..0000000 --- a/resources/gens/docs/securityScheme__description.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: description - - - - -URI: [td:securityScheme__description](https://www.w3.org/2019/wot/td#securityScheme__description) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [SecurityScheme](SecurityScheme.md) diff --git a/resources/gens/docs/securityScheme__proxy.md b/resources/gens/docs/securityScheme__proxy.md deleted file mode 100644 index a2675b5..0000000 --- a/resources/gens/docs/securityScheme__proxy.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: proxy - - -URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint. - -URI: [td:securityScheme__proxy](https://www.w3.org/2019/wot/td#securityScheme__proxy) - - -## Domain and Range - -None → <sub>0..1</sub> [AnyUri](types/AnyUri.md) - -## Parents - - -## Children - - -## Used by - - * [SecurityScheme](SecurityScheme.md) diff --git a/resources/gens/docs/securityScheme__scheme.md b/resources/gens/docs/securityScheme__scheme.md deleted file mode 100644 index bae1108..0000000 --- a/resources/gens/docs/securityScheme__scheme.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: scheme - - - - -URI: [td:securityScheme__scheme](https://www.w3.org/2019/wot/td#securityScheme__scheme) - - -## Domain and Range - -None → <sub>1..1</sub> [SecuritySchemeType](SecuritySchemeType.md) - -## Parents - - -## Children - - -## Used by - - * [SecurityScheme](SecurityScheme.md) diff --git a/resources/gens/docs/sizes.md b/resources/gens/docs/sizes.md deleted file mode 100644 index df36fdf..0000000 --- a/resources/gens/docs/sizes.md +++ /dev/null @@ -1,73 +0,0 @@ - - -# Slot: sizes - - -_Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \"16x16\", \"16x16 32x32\")._ - - - -URI: [td:sizes](https://www.w3.org/2019/wot/td#sizes) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: sizes -description: Target attribute that specifies one or more sizes for the referenced - icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} - (e.g., \"16x16\", \"16x16 32x32\"). -from_schema: td -rank: 1000 -alias: sizes -owner: Link -domain_of: -- Link -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/subprotocol.md b/resources/gens/docs/subprotocol.md deleted file mode 100644 index 99621dc..0000000 --- a/resources/gens/docs/subprotocol.md +++ /dev/null @@ -1,72 +0,0 @@ - - -# Slot: subprotocol - - -_Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options._ - - - -URI: [td:subprotocol](https://www.w3.org/2019/wot/td#subprotocol) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: subprotocol -description: Indicates the exact mechanism by which an interaction will be accomplished - for a given protocol when there are multiple options. -from_schema: td -rank: 1000 -alias: subprotocol -owner: Form -domain_of: -- Form -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/subscription.md b/resources/gens/docs/subscription.md deleted file mode 100644 index e57157e..0000000 --- a/resources/gens/docs/subscription.md +++ /dev/null @@ -1,72 +0,0 @@ - - -# Slot: subscription - - -_Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks._ - - - -URI: [td:subscription](https://www.w3.org/2019/wot/td#subscription) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | - - - - - - - -## Properties - -* Range: [DataSchema](DataSchema.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: subscription -description: Defines data that needs to be passed upon subscription, e.g., filters - or message format for setting up Webhooks. -from_schema: td -rank: 1000 -alias: subscription -owner: EventAffordance -domain_of: -- EventAffordance -range: DataSchema - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/success.md b/resources/gens/docs/success.md deleted file mode 100644 index 371b2ac..0000000 --- a/resources/gens/docs/success.md +++ /dev/null @@ -1,71 +0,0 @@ - - -# Slot: success - - -_Signals if the additional response should not be considered an error._ - - - -URI: [td:success](https://www.w3.org/2019/wot/td#success) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | Communication metadata describing the expected response message for additiona... | no | - - - - - - - -## Properties - -* Range: [Boolean](Boolean.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: success -description: Signals if the additional response should not be considered an error. -from_schema: td -rank: 1000 -alias: success -owner: AdditionalExpectedResponse -domain_of: -- AdditionalExpectedResponse -range: boolean - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/supportContact.md b/resources/gens/docs/supportContact.md deleted file mode 100644 index aa860df..0000000 --- a/resources/gens/docs/supportContact.md +++ /dev/null @@ -1,72 +0,0 @@ - - -# Slot: supportContact - - -_Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]])._ - - - -URI: [td:supportContact](https://www.w3.org/2019/wot/td#supportContact) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [AnyUri](AnyUri.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: supportContact -description: Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> - [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]). -from_schema: td -rank: 1000 -alias: supportContact -owner: Thing -domain_of: -- Thing -range: anyUri - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/synchronous.md b/resources/gens/docs/synchronous.md deleted file mode 100644 index b3d39f6..0000000 --- a/resources/gens/docs/synchronous.md +++ /dev/null @@ -1,75 +0,0 @@ - - -# Slot: synchronous - - -_Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made._ - - - -URI: [td:synchronous](https://www.w3.org/2019/wot/td#synchronous) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | - - - - - - - -## Properties - -* Range: [Boolean](Boolean.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: synchronous -description: Indicates whether the action is synchronous (=true) or not. A synchronous - action means that the response of action contains all the information about the - result of the action and no further querying about the status of the action is needed. - Lack of this keyword means that no claim on the synchronicity of the action can - be made. -from_schema: td -rank: 1000 -alias: synchronous -owner: ActionAffordance -domain_of: -- ActionAffordance -range: boolean - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/target.md b/resources/gens/docs/target.md deleted file mode 100644 index 4ba8e42..0000000 --- a/resources/gens/docs/target.md +++ /dev/null @@ -1,76 +0,0 @@ - - -# Slot: target - - -_Target IRI of a link or submission target of a Form_ - - - -URI: [hctl:target](https://www.w3.org/2019/wot/hypermedia#target) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | -| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | - - - - - - - -## Properties - -* Range: [AnyUri](AnyUri.md) - -* Required: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: target -description: Target IRI of a link or submission target of a Form -from_schema: td -rank: 1000 -slot_uri: hctl:target -alias: target -domain_of: -- Link -- Form -range: anyUri -required: true - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/thing-description-schema.md b/resources/gens/docs/thing-description-schema.md deleted file mode 100644 index edb1927..0000000 --- a/resources/gens/docs/thing-description-schema.md +++ /dev/null @@ -1,7 +0,0 @@ -# thing-description-schema - -LinkML schema for modelling the Web of Things Thing Description information model. This schema is used to generate -JSON Schema, SHACL shapes, and RDF. - -URI: td - diff --git a/resources/gens/docs/thing__actions.md b/resources/gens/docs/thing__actions.md deleted file mode 100644 index 612014f..0000000 --- a/resources/gens/docs/thing__actions.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: actions - - -All Action-based interaction affordances of the Thing. - -URI: [td:thing__actions](https://www.w3.org/2019/wot/td#thing__actions) - - -## Domain and Range - -None → <sub>0..\*</sub> [ActionAffordance](ActionAffordance.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__base.md b/resources/gens/docs/thing__base.md deleted file mode 100644 index 086db39..0000000 --- a/resources/gens/docs/thing__base.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: base - - -Define the base URI that is used for all relative URI references throughout a TD document. - -URI: [td:thing__base](https://www.w3.org/2019/wot/td#thing__base) - - -## Domain and Range - -None → <sub>0..1</sub> [AnyUri](types/AnyUri.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__created.md b/resources/gens/docs/thing__created.md deleted file mode 100644 index d2b96d8..0000000 --- a/resources/gens/docs/thing__created.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: created - - -Provides information when the TD instance was created. - -URI: [td:thing__created](https://www.w3.org/2019/wot/td#thing__created) - - -## Domain and Range - -None → <sub>0..1</sub> [Datetime](types/Datetime.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__events.md b/resources/gens/docs/thing__events.md deleted file mode 100644 index df347b9..0000000 --- a/resources/gens/docs/thing__events.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: events - - -All Event-based interaction affordances of the Thing. - -URI: [td:thing__events](https://www.w3.org/2019/wot/td#thing__events) - - -## Domain and Range - -None → <sub>0..\*</sub> [EventAffordance](EventAffordance.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__forms.md b/resources/gens/docs/thing__forms.md deleted file mode 100644 index fd8904f..0000000 --- a/resources/gens/docs/thing__forms.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: forms - - -Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings. - -URI: [td:thing__forms](https://www.w3.org/2019/wot/td#thing__forms) - - -## Domain and Range - -None → <sub>0..\*</sub> [Form](Form.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__instance.md b/resources/gens/docs/thing__instance.md deleted file mode 100644 index 9689e52..0000000 --- a/resources/gens/docs/thing__instance.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: instance - - -Provides a version identicator of this TD instance. - -URI: [td:thing__instance](https://www.w3.org/2019/wot/td#thing__instance) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__links.md b/resources/gens/docs/thing__links.md deleted file mode 100644 index c1998e5..0000000 --- a/resources/gens/docs/thing__links.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: links - - -Provides Web links to arbitrary resources that relate to the specified Thing Description. - -URI: [td:thing__links](https://www.w3.org/2019/wot/td#thing__links) - - -## Domain and Range - -None → <sub>0..\*</sub> [Link](Link.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__modified.md b/resources/gens/docs/thing__modified.md deleted file mode 100644 index c2b4ab0..0000000 --- a/resources/gens/docs/thing__modified.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: modified - - -Provides information when the TD instance was last modified. - -URI: [td:thing__modified](https://www.w3.org/2019/wot/td#thing__modified) - - -## Domain and Range - -None → <sub>0..1</sub> [Datetime](types/Datetime.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__profile.md b/resources/gens/docs/thing__profile.md deleted file mode 100644 index 4da25da..0000000 --- a/resources/gens/docs/thing__profile.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: profile - - -Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation. - -URI: [td:thing__profile](https://www.w3.org/2019/wot/td#thing__profile) - - -## Domain and Range - -None → <sub>0..\*</sub> [AnyUri](types/AnyUri.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__properties.md b/resources/gens/docs/thing__properties.md deleted file mode 100644 index f3a316e..0000000 --- a/resources/gens/docs/thing__properties.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: properties - - -All Property-based interaction affordances of the Thing. - -URI: [td:thing__properties](https://www.w3.org/2019/wot/td#thing__properties) - - -## Domain and Range - -None → <sub>0..\*</sub> [PropertyAffordance](PropertyAffordance.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__schemaDefinitions.md b/resources/gens/docs/thing__schemaDefinitions.md deleted file mode 100644 index b7b4ae8..0000000 --- a/resources/gens/docs/thing__schemaDefinitions.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: schemaDefinitions - - -TODO CHECK - -URI: [td:thing__schemaDefinitions](https://www.w3.org/2019/wot/td#thing__schemaDefinitions) - - -## Domain and Range - -None → <sub>0..\*</sub> [DataSchema](DataSchema.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__security.md b/resources/gens/docs/thing__security.md deleted file mode 100644 index daf6686..0000000 --- a/resources/gens/docs/thing__security.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: security - - -A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check - -URI: [td:thing__security](https://www.w3.org/2019/wot/td#thing__security) - - -## Domain and Range - -None → <sub>0..\*</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__securityDefinitions.md b/resources/gens/docs/thing__securityDefinitions.md deleted file mode 100644 index a5f0f2d..0000000 --- a/resources/gens/docs/thing__securityDefinitions.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: securityDefinitions - - -A security scheme applied to a (set of) affordance(s). TODO check - -URI: [td:thing__securityDefinitions](https://www.w3.org/2019/wot/td#thing__securityDefinitions) - - -## Domain and Range - -None → <sub>0..\*</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__supportContact.md b/resources/gens/docs/thing__supportContact.md deleted file mode 100644 index 082bb18..0000000 --- a/resources/gens/docs/thing__supportContact.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: supportContact - - -Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]). - -URI: [td:thing__supportContact](https://www.w3.org/2019/wot/td#thing__supportContact) - - -## Domain and Range - -None → <sub>0..1</sub> [AnyUri](types/AnyUri.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing__version.md b/resources/gens/docs/thing__version.md deleted file mode 100644 index 3d3fbce..0000000 --- a/resources/gens/docs/thing__version.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: version - - - - -URI: [td:thing__version](https://www.w3.org/2019/wot/td#thing__version) - - -## Domain and Range - -None → <sub>0..1</sub> [VersionInfo](VersionInfo.md) - -## Parents - - -## Children - - -## Used by - - * [Thing](Thing.md) diff --git a/resources/gens/docs/thing_description_schema.md b/resources/gens/docs/thing_description_schema.md deleted file mode 100644 index 05c8b80..0000000 --- a/resources/gens/docs/thing_description_schema.md +++ /dev/null @@ -1,150 +0,0 @@ - -# thing-description-schema - - -**metamodel version:** 1.7.0 - -**version:** None - - -LinkML schema for modelling the Web of Things Thing Description information model. This schema is used to generate -JSON Schema, SHACL shapes, and RDF. - - -### Classes - - * [DataSchema](DataSchema.md) - Metadata that describes the data format used. It can be used for validation. - * [ExpectedResponse](ExpectedResponse.md) - Communication metadata describing the expected response message for the primary response. - * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) - Communication metadata describing the expected response message for additional responses. - * [Form](Form.md) - A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions. - * [InteractionAffordance](InteractionAffordance.md) - TOOD - * [ActionAffordance](ActionAffordance.md) - An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time). - * [EventAffordance](EventAffordance.md) - An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts). - * [PropertyAffordance](PropertyAffordance.md) - An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated. - * [Link](Link.md) - A link can be viewed as a statement of the form link context that has a relation type resource at link target", where the optional target attributes may further describe the resource. - * [MultiLanguage](MultiLanguage.md) - * [SecurityScheme](SecurityScheme.md) - * [Thing](Thing.md) - An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things. - * [VersionInfo](VersionInfo.md) - Provides version information. - -### Mixins - - -### Slots - - * [@type](@type.md) - * [âžžidempotent](actionAffordance__idempotent.md) - Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input. - * [âžžinput](actionAffordance__input.md) - Used to define the input data schema of the action. - * [âžžoutput](actionAffordance__output.md) - Used to define the output data schema of the action. - * [âžžsafe](actionAffordance__safe.md) - Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action. - * [âžžsynchronous](actionAffordance__synchronous.md) - Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made. - * [âžžadditionalOutputSchema](additionalExpectedResponse__additionalOutputSchema.md) - This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used. - * [âžžschema](additionalExpectedResponse__schema.md) - TODO Check, was not in hctl ontology, if not could be source of discrepancy - * [âžžsuccess](additionalExpectedResponse__success.md) - Signals if the additional response should not be considered an error. - * [âžžpropertyName](dataSchema__propertyName.md) - Used to store the indexing name in the parent object when this schema appears as a property of an object schema. - * [âžžreadonly](dataSchema__readonly.md) - Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false). - * [âžžwriteOnly](dataSchema__writeOnly.md) - Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false). - * [description](description.md) - * [descriptionInLanguage](descriptionInLanguage.md) - description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. - * [descriptions](descriptions.md) - TODO, check, according to the description a description should not contain a lang tag. - * [âžžcancellation](eventAffordance__cancellation.md) - Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook. - * [âžžnotification](eventAffordance__notification.md) - Defines the data schema of the Event instance messages pushed by the Thing. - * [âžžnotificationResponse](eventAffordance__notificationResponse.md) - Defines the data schema of the Event response messages sent by the consumer in a response to a data message. - * [âžžsubscription](eventAffordance__subscription.md) - Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks. - * [âžžcontentType](expectedResponse__contentType.md) - TODO Check, was not in hctl ontology, if not could be source of discrepancy - * [âžžadditionalReturns](form__additionalReturns.md) - This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema. - * [âžžcontentCoding](form__contentCoding.md) - Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \"gzip\", \"deflate\", etc. - * [âžžcontentType](form__contentType.md) - Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type. - * [âžžhref](form__href.md) - * [âžžoperationType](form__operationType.md) - Indicates the semantic intention of performing the operation(s) described by the form. - * [âžžreturns](form__returns.md) - This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages. - * [âžžscopes](form__scopes.md) - TODO Check, was not in hctl ontology, if not could be source of discrepancy - * [âžžsecurityDefinitions](form__securityDefinitions.md) - A security schema applied to a (set of) affordance(s). - * [âžžsubprotocol](form__subprotocol.md) - Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options. - * [id](id.md) - TODO - * [âžžforms](interactionAffordance__forms.md) - Set of form hypermedia controls that describe how an operation can be performed. - * [âžžname](interactionAffordance__name.md) - Indexing property to store entity names when serializing them in a JSON-LD @index container. - * [âžžuriVariables](interactionAffordance__uriVariables.md) - Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. - * [âžžanchor](link__anchor.md) - By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI. - * [âžžhintsAtMediaType](link__hintsAtMediaType.md) - Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. - * [âžžhreflang](link__hreflang.md) - The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]. - * [âžžrelation](link__relation.md) - A link relation type identifies the semantics of a link. - * [âžžsizes](link__sizes.md) - Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \"16x16\", \"16x16 32x32\"). - * [âžžtype](link__type.md) - * [âžžkey](multiLanguage__key.md) - * [âžžobservable](propertyAffordance__observable.md) - A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property. - * [âžždescription](securityScheme__description.md) - * [âžžproxy](securityScheme__proxy.md) - URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint. - * [âžžscheme](securityScheme__scheme.md) - * [target](target.md) - Target IRI of a link or submission target of a Form - * [âžžactions](thing__actions.md) - All Action-based interaction affordances of the Thing. - * [âžžbase](thing__base.md) - Define the base URI that is used for all relative URI references throughout a TD document. - * [âžžcreated](thing__created.md) - Provides information when the TD instance was created. - * [âžževents](thing__events.md) - All Event-based interaction affordances of the Thing. - * [âžžforms](thing__forms.md) - Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings. - * [âžžinstance](thing__instance.md) - Provides a version identicator of this TD instance. - * [âžžlinks](thing__links.md) - Provides Web links to arbitrary resources that relate to the specified Thing Description. - * [âžžmodified](thing__modified.md) - Provides information when the TD instance was last modified. - * [âžžprofile](thing__profile.md) - Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation. - * [âžžproperties](thing__properties.md) - All Property-based interaction affordances of the Thing. - * [âžžschemaDefinitions](thing__schemaDefinitions.md) - TODO CHECK - * [âžžsecurity](thing__security.md) - A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check - * [âžžsecurityDefinitions](thing__securityDefinitions.md) - A security scheme applied to a (set of) affordance(s). TODO check - * [âžžsupportContact](thing__supportContact.md) - Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]). - * [âžžversion](thing__version.md) - * [title](title.md) - Provides a human-readable title (e.g., display a text for UI representation) based on a default language. - * [titleInLanguage](titleInLanguage.md) - title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. - * [titles](titles.md) - * [âžžinstance](versionInfo__instance.md) - * [âžžmodel](versionInfo__model.md) - -### Enums - - * [OperationTypes](OperationTypes.md) - Enumerations of well-known operation types necessary to implement the WoT interaction model. - * [SecuritySchemeType](SecuritySchemeType.md) - -### Subsets - - -### Types - - -#### Built in - - * **Bool** - * **Curie** - * **Decimal** - * **ElementIdentifier** - * **NCName** - * **NodeIdentifier** - * **URI** - * **URIorCURIE** - * **XSDDate** - * **XSDDateTime** - * **XSDTime** - * **float** - * **int** - * **str** - -#### Defined - - * [AnyUri](types/AnyUri.md) (**URI**) - a complete URI - * [Boolean](types/Boolean.md) (**Bool**) - A binary (true or false) value - * [Curie](types/Curie.md) (**Curie**) - a compact URI - * [Date](types/Date.md) (**XSDDate**) - a date (year, month and day) in an idealized calendar - * [DateOrDatetime](types/DateOrDatetime.md) (**str**) - Either a date or a datetime - * [Datetime](types/Datetime.md) (**XSDDateTime**) - The combination of a date and time - * [Decimal](types/Decimal.md) (**Decimal**) - A real number with arbitrary precision that conforms to the xsd:decimal specification - * [Double](types/Double.md) (**float**) - A real number that conforms to the xsd:double specification - * [Float](types/Float.md) (**float**) - A real number that conforms to the xsd:float specification - * [Integer](types/Integer.md) (**int**) - An integer - * [Jsonpath](types/Jsonpath.md) (**str**) - A string encoding a JSON Path. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded in tree form. - * [Jsonpointer](types/Jsonpointer.md) (**str**) - A string encoding a JSON Pointer. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to a valid object within the current instance document when encoded in tree form. - * [Ncname](types/Ncname.md) (**NCName**) - Prefix part of CURIE - * [Nodeidentifier](types/Nodeidentifier.md) (**NodeIdentifier**) - A URI, CURIE or BNODE that represents a node in a model. - * [Objectidentifier](types/Objectidentifier.md) (**ElementIdentifier**) - A URI or CURIE that represents an object in the model. - * [Sparqlpath](types/Sparqlpath.md) (**str**) - A string encoding a SPARQL Property Path. The value of the string MUST conform to SPARQL syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded as RDF. - * [String](types/String.md) (**str**) - A character string - * [Time](types/Time.md) (**XSDTime**) - A time object represents a (local) time of day, independent of any particular day - * [Uri](types/Uri.md) (**URI**) - a complete URI - * [Uriorcurie](types/Uriorcurie.md) (**URIorCURIE**) - a URI or a CURIE diff --git a/resources/gens/docs/title.md b/resources/gens/docs/title.md deleted file mode 100644 index 3a9d8e4..0000000 --- a/resources/gens/docs/title.md +++ /dev/null @@ -1,79 +0,0 @@ - - -# Slot: title - - -_Provides a human-readable title (e.g., display a text for UI representation) based on a default language._ - - - -URI: [td:title](https://www.w3.org/2019/wot/td#title) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | -| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | -| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | -| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | - - - - - - - -## Properties - -* Range: [MultiLanguage](MultiLanguage.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: title -description: Provides a human-readable title (e.g., display a text for UI representation) - based on a default language. -from_schema: td -rank: 1000 -slot_uri: td:title -alias: title -domain_of: -- DataSchema -- InteractionAffordance -- Thing -range: MultiLanguage - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/titleInLanguage.md b/resources/gens/docs/titleInLanguage.md deleted file mode 100644 index 9f6f6ff..0000000 --- a/resources/gens/docs/titleInLanguage.md +++ /dev/null @@ -1,79 +0,0 @@ - - -# Slot: titleInLanguage - - -_title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description._ - - - -URI: [td:titleInLanguage](https://www.w3.org/2019/wot/td#titleInLanguage) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | -| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | -| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | -| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | - - - - - - - -## Properties - -* Range: [MultiLanguage](MultiLanguage.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: titleInLanguage -description: title of the TD element (Thing, interaction affordance, security scheme - or data scheme) with language tag. By convention, a language tag must be added to - the object of descriptionInLanguage. Otherwise use description. -from_schema: td -rank: 1000 -alias: titleInLanguage -domain_of: -- DataSchema -- InteractionAffordance -- Thing -range: MultiLanguage - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/titles.md b/resources/gens/docs/titles.md deleted file mode 100644 index 6303f28..0000000 --- a/resources/gens/docs/titles.md +++ /dev/null @@ -1,73 +0,0 @@ - - -# Slot: titles - -URI: [td:titles](https://www.w3.org/2019/wot/td#titles) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | -| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | -| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | -| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | - - - - - - - -## Properties - -* Range: [MultiLanguage](MultiLanguage.md) - -* Multivalued: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: titles -from_schema: td -rank: 1000 -multivalued: true -alias: titles -domain_of: -- InteractionAffordance -- Thing -range: MultiLanguage -inlined: true - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/type.md b/resources/gens/docs/type.md deleted file mode 100644 index d319db9..0000000 --- a/resources/gens/docs/type.md +++ /dev/null @@ -1,65 +0,0 @@ - - -# Slot: type - -URI: [td:type](https://www.w3.org/2019/wot/td#type) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: type -from_schema: td -rank: 1000 -alias: type -owner: Link -domain_of: -- Link -range: string - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/types/AnyUri.md b/resources/gens/docs/types/AnyUri.md deleted file mode 100644 index 6546757..0000000 --- a/resources/gens/docs/types/AnyUri.md +++ /dev/null @@ -1,11 +0,0 @@ - -# Type: anyUri - - -a complete URI - -URI: [td:AnyUri](https://www.w3.org/2019/wot/td#AnyUri) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **URI** | diff --git a/resources/gens/docs/types/Boolean.md b/resources/gens/docs/types/Boolean.md deleted file mode 100644 index dc83a9c..0000000 --- a/resources/gens/docs/types/Boolean.md +++ /dev/null @@ -1,19 +0,0 @@ - -# Type: boolean - - -A binary (true or false) value - -URI: [linkml:Boolean](https://w3id.org/linkml/Boolean) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **Bool** | -| Representation | | bool | - -## Other properties - -| | | | -| --- | --- | --- | -| **Exact Mappings:** | | schema:Boolean | - diff --git a/resources/gens/docs/types/Curie.md b/resources/gens/docs/types/Curie.md deleted file mode 100644 index c1803f9..0000000 --- a/resources/gens/docs/types/Curie.md +++ /dev/null @@ -1,20 +0,0 @@ - -# Type: curie - - -a compact URI - -URI: [linkml:Curie](https://w3id.org/linkml/Curie) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **Curie** | -| Representation | | str | - -## Other properties - -| | | | -| --- | --- | --- | -| **Comments:** | | in RDF serializations this MUST be expanded to a URI | -| | | in non-RDF serializations MAY be serialized as the compact representation | - diff --git a/resources/gens/docs/types/Date.md b/resources/gens/docs/types/Date.md deleted file mode 100644 index 06948af..0000000 --- a/resources/gens/docs/types/Date.md +++ /dev/null @@ -1,19 +0,0 @@ - -# Type: date - - -a date (year, month and day) in an idealized calendar - -URI: [linkml:Date](https://w3id.org/linkml/Date) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **XSDDate** | -| Representation | | str | - -## Other properties - -| | | | -| --- | --- | --- | -| **Exact Mappings:** | | schema:Date | - diff --git a/resources/gens/docs/types/DateOrDatetime.md b/resources/gens/docs/types/DateOrDatetime.md deleted file mode 100644 index ef98389..0000000 --- a/resources/gens/docs/types/DateOrDatetime.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Type: date_or_datetime - - -Either a date or a datetime - -URI: [linkml:DateOrDatetime](https://w3id.org/linkml/DateOrDatetime) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **str** | -| Representation | | str | diff --git a/resources/gens/docs/types/Datetime.md b/resources/gens/docs/types/Datetime.md deleted file mode 100644 index 9510454..0000000 --- a/resources/gens/docs/types/Datetime.md +++ /dev/null @@ -1,19 +0,0 @@ - -# Type: datetime - - -The combination of a date and time - -URI: [linkml:Datetime](https://w3id.org/linkml/Datetime) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **XSDDateTime** | -| Representation | | str | - -## Other properties - -| | | | -| --- | --- | --- | -| **Exact Mappings:** | | schema:DateTime | - diff --git a/resources/gens/docs/types/Decimal.md b/resources/gens/docs/types/Decimal.md deleted file mode 100644 index a7ba14a..0000000 --- a/resources/gens/docs/types/Decimal.md +++ /dev/null @@ -1,18 +0,0 @@ - -# Type: decimal - - -A real number with arbitrary precision that conforms to the xsd:decimal specification - -URI: [linkml:Decimal](https://w3id.org/linkml/Decimal) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **Decimal** | - -## Other properties - -| | | | -| --- | --- | --- | -| **Broad Mappings:** | | schema:Number | - diff --git a/resources/gens/docs/types/Double.md b/resources/gens/docs/types/Double.md deleted file mode 100644 index cfe6d71..0000000 --- a/resources/gens/docs/types/Double.md +++ /dev/null @@ -1,18 +0,0 @@ - -# Type: double - - -A real number that conforms to the xsd:double specification - -URI: [linkml:Double](https://w3id.org/linkml/Double) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **float** | - -## Other properties - -| | | | -| --- | --- | --- | -| **Close Mappings:** | | schema:Float | - diff --git a/resources/gens/docs/types/Float.md b/resources/gens/docs/types/Float.md deleted file mode 100644 index 7b303f9..0000000 --- a/resources/gens/docs/types/Float.md +++ /dev/null @@ -1,18 +0,0 @@ - -# Type: float - - -A real number that conforms to the xsd:float specification - -URI: [linkml:Float](https://w3id.org/linkml/Float) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **float** | - -## Other properties - -| | | | -| --- | --- | --- | -| **Exact Mappings:** | | schema:Float | - diff --git a/resources/gens/docs/types/Integer.md b/resources/gens/docs/types/Integer.md deleted file mode 100644 index 3cfcc66..0000000 --- a/resources/gens/docs/types/Integer.md +++ /dev/null @@ -1,18 +0,0 @@ - -# Type: integer - - -An integer - -URI: [linkml:Integer](https://w3id.org/linkml/Integer) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **int** | - -## Other properties - -| | | | -| --- | --- | --- | -| **Exact Mappings:** | | schema:Integer | - diff --git a/resources/gens/docs/types/Jsonpath.md b/resources/gens/docs/types/Jsonpath.md deleted file mode 100644 index a03a58e..0000000 --- a/resources/gens/docs/types/Jsonpath.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Type: jsonpath - - -A string encoding a JSON Path. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded in tree form. - -URI: [linkml:Jsonpath](https://w3id.org/linkml/Jsonpath) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **str** | -| Representation | | str | diff --git a/resources/gens/docs/types/Jsonpointer.md b/resources/gens/docs/types/Jsonpointer.md deleted file mode 100644 index a0e1ac4..0000000 --- a/resources/gens/docs/types/Jsonpointer.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Type: jsonpointer - - -A string encoding a JSON Pointer. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to a valid object within the current instance document when encoded in tree form. - -URI: [linkml:Jsonpointer](https://w3id.org/linkml/Jsonpointer) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **str** | -| Representation | | str | diff --git a/resources/gens/docs/types/Ncname.md b/resources/gens/docs/types/Ncname.md deleted file mode 100644 index 710b0b0..0000000 --- a/resources/gens/docs/types/Ncname.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Type: ncname - - -Prefix part of CURIE - -URI: [linkml:Ncname](https://w3id.org/linkml/Ncname) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **NCName** | -| Representation | | str | diff --git a/resources/gens/docs/types/Nodeidentifier.md b/resources/gens/docs/types/Nodeidentifier.md deleted file mode 100644 index f0097cd..0000000 --- a/resources/gens/docs/types/Nodeidentifier.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Type: nodeidentifier - - -A URI, CURIE or BNODE that represents a node in a model. - -URI: [linkml:Nodeidentifier](https://w3id.org/linkml/Nodeidentifier) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **NodeIdentifier** | -| Representation | | str | diff --git a/resources/gens/docs/types/Objectidentifier.md b/resources/gens/docs/types/Objectidentifier.md deleted file mode 100644 index 454ba6b..0000000 --- a/resources/gens/docs/types/Objectidentifier.md +++ /dev/null @@ -1,19 +0,0 @@ - -# Type: objectidentifier - - -A URI or CURIE that represents an object in the model. - -URI: [linkml:Objectidentifier](https://w3id.org/linkml/Objectidentifier) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **ElementIdentifier** | -| Representation | | str | - -## Other properties - -| | | | -| --- | --- | --- | -| **Comments:** | | Used for inheritance and type checking | - diff --git a/resources/gens/docs/types/Sparqlpath.md b/resources/gens/docs/types/Sparqlpath.md deleted file mode 100644 index fd99a92..0000000 --- a/resources/gens/docs/types/Sparqlpath.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Type: sparqlpath - - -A string encoding a SPARQL Property Path. The value of the string MUST conform to SPARQL syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded as RDF. - -URI: [linkml:Sparqlpath](https://w3id.org/linkml/Sparqlpath) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **str** | -| Representation | | str | diff --git a/resources/gens/docs/types/String.md b/resources/gens/docs/types/String.md deleted file mode 100644 index 6e61d70..0000000 --- a/resources/gens/docs/types/String.md +++ /dev/null @@ -1,18 +0,0 @@ - -# Type: string - - -A character string - -URI: [linkml:String](https://w3id.org/linkml/String) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **str** | - -## Other properties - -| | | | -| --- | --- | --- | -| **Exact Mappings:** | | schema:Text | - diff --git a/resources/gens/docs/types/Time.md b/resources/gens/docs/types/Time.md deleted file mode 100644 index 2b8652b..0000000 --- a/resources/gens/docs/types/Time.md +++ /dev/null @@ -1,19 +0,0 @@ - -# Type: time - - -A time object represents a (local) time of day, independent of any particular day - -URI: [linkml:Time](https://w3id.org/linkml/Time) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **XSDTime** | -| Representation | | str | - -## Other properties - -| | | | -| --- | --- | --- | -| **Exact Mappings:** | | schema:Time | - diff --git a/resources/gens/docs/types/Uri.md b/resources/gens/docs/types/Uri.md deleted file mode 100644 index 343807a..0000000 --- a/resources/gens/docs/types/Uri.md +++ /dev/null @@ -1,20 +0,0 @@ - -# Type: uri - - -a complete URI - -URI: [linkml:Uri](https://w3id.org/linkml/Uri) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **URI** | -| Representation | | str | - -## Other properties - -| | | | -| --- | --- | --- | -| **Comments:** | | in RDF serializations a slot with range of uri is treated as a literal or type xsd:anyURI unless it is an identifier or a reference to an identifier, in which case it is translated directly to a node | -| **Close Mappings:** | | schema:URL | - diff --git a/resources/gens/docs/types/Uriorcurie.md b/resources/gens/docs/types/Uriorcurie.md deleted file mode 100644 index 2f7b650..0000000 --- a/resources/gens/docs/types/Uriorcurie.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Type: uriorcurie - - -a URI or a CURIE - -URI: [linkml:Uriorcurie](https://w3id.org/linkml/Uriorcurie) - -| | | | -| --- | --- | --- | -| Root (builtin) type | | **URIorCURIE** | -| Representation | | str | diff --git a/resources/gens/docs/uriVariables.md b/resources/gens/docs/uriVariables.md deleted file mode 100644 index a33fc3d..0000000 --- a/resources/gens/docs/uriVariables.md +++ /dev/null @@ -1,79 +0,0 @@ - - -# Slot: uriVariables - - -_Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology._ - - - -URI: [td:uriVariables](https://www.w3.org/2019/wot/td#uriVariables) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | -| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | -| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | -| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | - - - - - - - -## Properties - -* Range: [DataSchema](DataSchema.md) - -* Multivalued: True - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: uriVariables -description: 'Define URI template variables according to RFC6570 as collection based - on schema specifications. The individual variables DataSchema cannot be an ObjectSchema - or an ArraySchema. TODO: range is not obvious from the ontology.' -from_schema: td -rank: 1000 -multivalued: true -alias: uriVariables -owner: InteractionAffordance -domain_of: -- InteractionAffordance -range: DataSchema - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/version.md b/resources/gens/docs/version.md deleted file mode 100644 index 74d472c..0000000 --- a/resources/gens/docs/version.md +++ /dev/null @@ -1,65 +0,0 @@ - - -# Slot: version - -URI: [td:version](https://www.w3.org/2019/wot/td#version) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | - - - - - - - -## Properties - -* Range: [VersionInfo](VersionInfo.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: version -from_schema: td -rank: 1000 -alias: version -owner: Thing -domain_of: -- Thing -range: VersionInfo - -``` -</details> \ No newline at end of file diff --git a/resources/gens/docs/versionInfo__instance.md b/resources/gens/docs/versionInfo__instance.md deleted file mode 100644 index 5538da6..0000000 --- a/resources/gens/docs/versionInfo__instance.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: instance - - - - -URI: [td:versionInfo__instance](https://www.w3.org/2019/wot/td#versionInfo__instance) - - -## Domain and Range - -None → <sub>1..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [VersionInfo](VersionInfo.md) diff --git a/resources/gens/docs/versionInfo__model.md b/resources/gens/docs/versionInfo__model.md deleted file mode 100644 index 9ceafca..0000000 --- a/resources/gens/docs/versionInfo__model.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Slot: model - - - - -URI: [td:versionInfo__model](https://www.w3.org/2019/wot/td#versionInfo__model) - - -## Domain and Range - -None → <sub>0..1</sub> [String](types/String.md) - -## Parents - - -## Children - - -## Used by - - * [VersionInfo](VersionInfo.md) diff --git a/resources/gens/docs/writeOnly.md b/resources/gens/docs/writeOnly.md deleted file mode 100644 index ddb914f..0000000 --- a/resources/gens/docs/writeOnly.md +++ /dev/null @@ -1,73 +0,0 @@ - - -# Slot: writeOnly - - -_Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false)._ - - - -URI: [td:writeOnly](https://www.w3.org/2019/wot/td#writeOnly) - - - -<!-- no inheritance hierarchy --> - - - - - -## Applicable Classes - -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | -| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | - - - - - - - -## Properties - -* Range: [String](String.md) - - - - - -## Identifier and Mapping Information - - - - - - - -### Schema Source - - -* from schema: td - - - - -## LinkML Source - -<details> -```yaml -name: writeOnly -description: Boolean value that is a hint to indicate whether a property interaction/value - is write only (=true) or not (=false). -from_schema: td -rank: 1000 -alias: writeOnly -owner: DataSchema -domain_of: -- DataSchema -range: string - -``` -</details> \ No newline at end of file diff --git a/src/linkml/config.yaml b/src/linkml/config.yaml index 7fe008c..4e3abb5 100644 --- a/src/linkml/config.yaml +++ b/src/linkml/config.yaml @@ -13,16 +13,14 @@ generator_args: mergeimports: true jsonldcontext: mergeimports: true - python: - mergeimports: true prefixmap: mergeimports: true shacl: mergeimports: true shex: mergeimports: true - sqlddl: - mergeimports: true typescript: mergeimports: true metadata: true + protobuf: + mergeimports: true From b23428698c61952c26b179d019e437603720e795 Mon Sep 17 00:00:00 2001 From: mahdanoura <mahda.noura@siemens.com> Date: Wed, 22 May 2024 22:19:54 +0200 Subject: [PATCH 05/10] doc generator added to main --- main.py | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/main.py b/main.py index 7d6bafe..28afe29 100644 --- a/main.py +++ b/main.py @@ -1,6 +1,6 @@ import argparse - import yaml + from linkml.generators.jsonschemagen import JsonSchemaGenerator from linkml.generators.shaclgen import ShaclGenerator from linkml.generators.shexgen import ShExGenerator @@ -10,6 +10,7 @@ from linkml.generators.jsonldcontextgen import ContextGenerator from linkml.generators.typescriptgen import TypescriptGenerator from linkml.generators.protogen import ProtoGenerator +from linkml.generators.docgen import DocGenerator from pathlib import Path RESOURCES_PATH = Path('resources') @@ -19,6 +20,13 @@ SOURCE_PATH = Path('src') LINKML_PATH = Path('linkml') LINKML_GENERATORS_CONFIG_YAML_PATH = SOURCE_PATH / LINKML_PATH / 'config.yaml' +DOCDIR = GENS_PATH / 'docs' + + +def generate_docs(yaml_path, docdir): + docdir.mkdir(parents=True, exist_ok=True) + doc_generator = DocGenerator(yaml_path) + doc_generator.serialize(directory=str(docdir)) def config_file_parse(config_path): @@ -30,9 +38,10 @@ def config_file_parse(config_path): return generators -def main(yaml_path, config_path): +def main(yaml_path, config_path, generate_docs_flag): yaml_content = yaml_path.read_text() generators = config_file_parse(config_path) + for generator in generators: output_dir = GENS_PATH / generator output_dir.mkdir(parents=True, exist_ok=True) @@ -68,11 +77,17 @@ def main(yaml_path, config_path): print(f"Unknown generator: {generator}") continue + if generate_docs_flag: + generate_docs(yaml_path, DOCDIR) + + if __name__ == '__main__': parser = argparse.ArgumentParser(description='WoT TD toolchain for automating specification generation') parser.add_argument('-y', '--yaml', default=YAML_SCHEMA_PATH, help='Path to the LinkML schema formatted as a YAML file.') parser.add_argument('-c', '--config-file', default=LINKML_GENERATORS_CONFIG_YAML_PATH, help='Path to YAML configuration for specifying the required LinkML generators.') + parser.add_argument('-d', '--generate-docs', action='store_true', + help='Boolean for documentation generation.') args = parser.parse_args() - main(Path(args.yaml), Path(args.config_file)) + main(Path(args.yaml), Path(args.config_file), args.generate_docs) From 964aed367806257fe80832fd0a4a5a3eaa347cc4 Mon Sep 17 00:00:00 2001 From: mahdanoura <mahda.noura@siemens.com> Date: Wed, 22 May 2024 22:32:30 +0200 Subject: [PATCH 06/10] serve docs with MKDocs --- main.py | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/main.py b/main.py index 28afe29..9a7d361 100644 --- a/main.py +++ b/main.py @@ -1,4 +1,5 @@ import argparse +import subprocess import yaml from linkml.generators.jsonschemagen import JsonSchemaGenerator @@ -23,6 +24,10 @@ DOCDIR = GENS_PATH / 'docs' +def serve_docs(): + subprocess.run(['mkdocs', 'serve'], check=True) + + def generate_docs(yaml_path, docdir): docdir.mkdir(parents=True, exist_ok=True) doc_generator = DocGenerator(yaml_path) @@ -38,7 +43,7 @@ def config_file_parse(config_path): return generators -def main(yaml_path, config_path, generate_docs_flag): +def main(yaml_path, config_path, generate_docs_flag, serve_docs_flag): yaml_content = yaml_path.read_text() generators = config_file_parse(config_path) @@ -80,6 +85,9 @@ def main(yaml_path, config_path, generate_docs_flag): if generate_docs_flag: generate_docs(yaml_path, DOCDIR) + if serve_docs_flag: + serve_docs() + if __name__ == '__main__': parser = argparse.ArgumentParser(description='WoT TD toolchain for automating specification generation') @@ -89,5 +97,7 @@ def main(yaml_path, config_path, generate_docs_flag): help='Path to YAML configuration for specifying the required LinkML generators.') parser.add_argument('-d', '--generate-docs', action='store_true', help='Boolean for documentation generation.') + parser.add_argument('-s', '--serve-docs', action='store_true', + help='Boolean for serving the documentation generated.') args = parser.parse_args() - main(Path(args.yaml), Path(args.config_file), args.generate_docs) + main(Path(args.yaml), Path(args.config_file), args.generate_docs, args.serve_docs) From ef0b36e41c729460c3e2fe4e94dff360c88fb780 Mon Sep 17 00:00:00 2001 From: mahdanoura <mahda.noura@siemens.com> Date: Wed, 22 May 2024 23:02:02 +0200 Subject: [PATCH 07/10] minor modifications --- Makefile | 156 ------------------------------------------------------- main.py | 7 +-- 2 files changed, 4 insertions(+), 159 deletions(-) delete mode 100644 Makefile diff --git a/Makefile b/Makefile deleted file mode 100644 index b3093a0..0000000 --- a/Makefile +++ /dev/null @@ -1,156 +0,0 @@ -MAKEFLAGS += --warn-undefined-variables -SHELL := bash -.SHELLFLAGS := -eu -o pipefail -c -.DEFAULT_GOAL := help -.DELETE_ON_ERROR: -.SUFFIXES: -.SECONDARY: - -RUN = poetry run -LINKML_SCHEMA_NAME=thing_description_schema -SCHEMA_NAME = $(LINKML_SCHEMA_NAME) -SOURCE_SCHEMA_PATH = resources/thing_description_schema.yaml -SOURCE_SCHEMA_DIR = $(dir $(SOURCE_SCHEMA_PATH)) -SRC = src -DEST = resources/gens -PYMODEL= $(DEST)/datamodel -DOCDIR = $(DEST)/docs -EXAMPLEDIR = examples -TEMPLATE_DIR = resources/templates -LINKML_GENERATORS_CONFIG_YAML= --config-file src/linkml/config.yaml - - -$(DEST): - mkdir -p $@ - -CONFIG_YAML = -ifdef LINKML_GENERATORS_CONFIG_YAML -CONFIG_YAML = ${LINKML_GENERATORS_CONFIG_YAML} -endif - -GEN_DOC_ARGS = -ifdef LINKML_GENERATORS_DOC_ARGS -GEN_DOC_ARGS = ${GEN_DOC_ARGS} -endif - -GEN_OWL_ARGS = -ifdef LINKML_GENERATORS_OWL_ARGS -GEN_OWL_ARGS = ${GEN_OWL_ARGS} -endif - -GEN_TS_ARGS = -ifdef LINKML_GENERATORS_TYPESCRIPT_ARGS -GEN_TS_ARGS = ${GEN_TS_ARGS} -endif - -.PHONY: all clean setup gen-project gen-examples gendoc - -help: status - @echo "" - @echo "make setup -- initial setup (run this first)" - @echo "make site -- makes site locally" - @echo "make install -- install dependencies" - @echo "make test -- runs tests" - @echo "make testdoc -- builds docs and runs local test server" - @echo "make deploy -- deploys site" - @echo "make update -- updates linkml version" - @echo "make help -- show this help" - @echo "" - - -status: check-config - @echo "Project: $(SCHEMA_NAME)" - @echo "Source: $(SOURCE_SCHEMA_PATH)" - -setup: check-config install gen-project gen-examples gendoc - - -check-config: -ifndef LINKML_SCHEMA_NAME - $(error **Project not configured**:\n\n) -else - $(info Ok) -endif - - -install: - poetry install -.PHONY: install - - -update: update-linkml - -update-linkml: - poetry add -D linkml@latest - -all: site -site: gen-project gendoc -%.yaml: gen-project -deploy: all mkd-gh-deploy - - -gen-project: $(DEST) - $(RUN) gen-project ${CONFIG_YAML} -d $(DEST) $(SOURCE_SCHEMA_PATH) --exclude excel && mv $(DEST)/*.py $(PYMODEL) - -ifneq ($(strip ${GEN_OWL_ARGS}),) - mkdir -p ${DEST}/owl || true - $(RUN) gen-owl ${GEN_OWL_ARGS} $(SOURCE_SCHEMA_PATH) >${DEST}/owl/${SCHEMA_NAME}.owl.ttl -endif - -ifneq ($(strip ${GEN_TS_ARGS}),) - mkdir -p ${DEST}/typescript || true - $(RUN) gen-typescript ${GEN_TS_ARGS} $(SOURCE_SCHEMA_PATH) >${DEST}/typescript/${SCHEMA_NAME}.ts -endif - -test: test-schema test-python test-examples - -test-schema: - $(RUN) gen-project ${CONFIG_YAML} -d tmp $(SOURCE_SCHEMA_PATH) - -test-python: - $(RUN) python -m unittest discover - -convert-examples-to-%: - $(patsubst %, $(RUN) linkml-convert % -s $(SOURCE_SCHEMA_PATH) -C Person, $(shell ${SHELL} find src/data/examples -name "*.yaml")) - -examples/%.yaml: src/data/examples/%.yaml - $(RUN) linkml-convert -s $(SOURCE_SCHEMA_PATH) -C Person $< -o $@ -examples/%.json: src/data/examples/%.yaml - $(RUN) linkml-convert -s $(SOURCE_SCHEMA_PATH) -C Person $< -o $@ -examples/%.ttl: src/data/examples/%.yaml - $(RUN) linkml-convert -P EXAMPLE=http://example.org/ -s $(SOURCE_SCHEMA_PATH) -C Person $< -o $@ - -test-examples: examples/output - -examples/output: src/thing_description_schema/schema/thing_description_schema.yaml - mkdir -p $@ - $(RUN) linkml-run-examples \ - --output-formats json \ - --output-formats yaml \ - --counter-example-input-directory src/data/examples/invalid \ - --input-directory src/data/examples/valid \ - --output-directory $@ \ - --schema $< > $@/README.md - -gendoc: $(DOCDIR) - mkdir -p $(DOCDIR) - cp -rf $(SRC)/docs/* $(DOCDIR) - $(RUN) gen-doc ${GEN_DOC_ARGS} -d $(DOCDIR) $(SOURCE_SCHEMA_PATH) - -testdoc: gendoc serve - -serve: mkd-serve - -MKDOCS = $(RUN) mkdocs -mkd-%: - $(MKDOCS) $* - -mkd-gh-deploy: - $(RUN) mkdocs gh-deploy - - -clean: - rm -rf $(DEST) - rm -rf tmp - rm -fr docs/* - rm -fr $(PYMODEL)/* diff --git a/main.py b/main.py index 9a7d361..952f521 100644 --- a/main.py +++ b/main.py @@ -86,6 +86,7 @@ def main(yaml_path, config_path, generate_docs_flag, serve_docs_flag): generate_docs(yaml_path, DOCDIR) if serve_docs_flag: + generate_docs(yaml_path, DOCDIR) serve_docs() @@ -95,9 +96,9 @@ def main(yaml_path, config_path, generate_docs_flag, serve_docs_flag): help='Path to the LinkML schema formatted as a YAML file.') parser.add_argument('-c', '--config-file', default=LINKML_GENERATORS_CONFIG_YAML_PATH, help='Path to YAML configuration for specifying the required LinkML generators.') - parser.add_argument('-d', '--generate-docs', action='store_true', - help='Boolean for documentation generation.') + parser.add_argument('-l', '--local-docs', action='store_true', + help='Boolean for documentation generation locally.') parser.add_argument('-s', '--serve-docs', action='store_true', help='Boolean for serving the documentation generated.') args = parser.parse_args() - main(Path(args.yaml), Path(args.config_file), args.generate_docs, args.serve_docs) + main(Path(args.yaml), Path(args.config_file), args.local_docs, args.serve_docs) From 4e57ea9c7fe972d64ba1beb5db6b338cb9848e08 Mon Sep 17 00:00:00 2001 From: mahdanoura <mahda.noura@siemens.com> Date: Wed, 29 May 2024 09:28:38 +0200 Subject: [PATCH 08/10] minor changes --- main.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/main.py b/main.py index 952f521..bc35788 100644 --- a/main.py +++ b/main.py @@ -97,8 +97,8 @@ def main(yaml_path, config_path, generate_docs_flag, serve_docs_flag): parser.add_argument('-c', '--config-file', default=LINKML_GENERATORS_CONFIG_YAML_PATH, help='Path to YAML configuration for specifying the required LinkML generators.') parser.add_argument('-l', '--local-docs', action='store_true', - help='Boolean for documentation generation locally.') + help='Boolean for local documentation generation.') parser.add_argument('-s', '--serve-docs', action='store_true', - help='Boolean for serving the documentation generated.') + help='Boolean for serving the generated documentation.') args = parser.parse_args() main(Path(args.yaml), Path(args.config_file), args.local_docs, args.serve_docs) From 4cd497f437d1a87454ef4154e826356566c0449e Mon Sep 17 00:00:00 2001 From: mahdanoura <mahda.noura@siemens.com> Date: Wed, 29 May 2024 09:29:19 +0200 Subject: [PATCH 09/10] python code generated automatically --- resources/gens/datamodel/thing_description_schema.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/resources/gens/datamodel/thing_description_schema.py b/resources/gens/datamodel/thing_description_schema.py index c43a28b..d8b5790 100644 --- a/resources/gens/datamodel/thing_description_schema.py +++ b/resources/gens/datamodel/thing_description_schema.py @@ -1,9 +1,9 @@ # Auto generated from thing_description_schema.yaml by pythongen.py version: 0.0.1 -# Generation date: 2024-05-21T15:16:14 +# Generation date: 2024-05-22T14:37:39 # Schema: thing-description-schema # # id: td -# description: LinkML schema for modelling the Web of Things Thing Description information model. This schema is used to generate +# description: LinkML schema for modelling the W3C Web of Things Thing Description information model. This schema is used to generate # JSON Schema, SHACL shapes, and RDF. # license: MIT From de7509bf5c499622a767a7387e1fc940f0226c6c Mon Sep 17 00:00:00 2001 From: mahdanoura <mahda.noura@siemens.com> Date: Wed, 29 May 2024 09:29:46 +0200 Subject: [PATCH 10/10] generated files --- resources/gens/docs/@type.md | 69 + resources/gens/docs/ActionAffordance.md | 459 +++ .../gens/docs/AdditionalExpectedResponse.md | 203 ++ resources/gens/docs/AnyUri.md | 38 + resources/gens/docs/Boolean.md | 39 + resources/gens/docs/Curie.md | 44 + resources/gens/docs/DataSchema.md | 288 ++ resources/gens/docs/Date.md | 39 + resources/gens/docs/DateOrDatetime.md | 39 + resources/gens/docs/Datetime.md | 39 + resources/gens/docs/Decimal.md | 38 + resources/gens/docs/Double.md | 38 + resources/gens/docs/EventAffordance.md | 444 +++ resources/gens/docs/ExpectedResponse.md | 143 + resources/gens/docs/Float.md | 38 + resources/gens/docs/Form.md | 379 +++ resources/gens/docs/Integer.md | 38 + resources/gens/docs/InteractionAffordance.md | 358 +++ resources/gens/docs/Jsonpath.md | 39 + resources/gens/docs/Jsonpointer.md | 39 + resources/gens/docs/Link.md | 265 ++ resources/gens/docs/MultiLanguage.md | 159 + resources/gens/docs/Ncname.md | 39 + resources/gens/docs/Nodeidentifier.md | 39 + resources/gens/docs/Objectidentifier.md | 43 + resources/gens/docs/OperationTypes.md | 167 ++ resources/gens/docs/PropertyAffordance.md | 397 +++ resources/gens/docs/SecurityScheme.md | 209 ++ resources/gens/docs/SecuritySchemeType.md | 106 + resources/gens/docs/Sparqlpath.md | 39 + resources/gens/docs/String.md | 38 + resources/gens/docs/Thing.md | 690 +++++ resources/gens/docs/Time.md | 39 + resources/gens/docs/Uri.md | 43 + resources/gens/docs/Uriorcurie.md | 39 + resources/gens/docs/VersionInfo.md | 150 + resources/gens/docs/about.md | 3 + resources/gens/docs/actions.md | 75 + resources/gens/docs/additionalOutputSchema.md | 74 + resources/gens/docs/additionalReturns.md | 77 + resources/gens/docs/anchor.md | 73 + resources/gens/docs/base.md | 72 + resources/gens/docs/cancellation.md | 72 + resources/gens/docs/contentCoding.md | 75 + resources/gens/docs/contentType.md | 58 + resources/gens/docs/created.md | 71 + resources/gens/docs/description.md | 73 + resources/gens/docs/descriptionInLanguage.md | 79 + resources/gens/docs/descriptions.md | 82 + resources/gens/docs/events.md | 75 + resources/gens/docs/forms.md | 60 + resources/gens/docs/hintsAtMediaType.md | 72 + resources/gens/docs/href.md | 68 + resources/gens/docs/hreflang.md | 75 + resources/gens/docs/id.md | 75 + resources/gens/docs/idempotent.md | 73 + resources/gens/docs/index.md | 135 + resources/gens/docs/input.md | 71 + resources/gens/docs/instance.md | 57 + resources/gens/docs/key.md | 72 + resources/gens/docs/links.md | 75 + resources/gens/docs/model.md | 65 + resources/gens/docs/modified.md | 71 + resources/gens/docs/name.md | 79 + resources/gens/docs/notification.md | 72 + resources/gens/docs/notificationResponse.md | 72 + resources/gens/docs/observable.md | 73 + resources/gens/docs/operationType.md | 75 + resources/gens/docs/output.md | 71 + resources/gens/docs/profile.md | 75 + resources/gens/docs/properties.md | 75 + resources/gens/docs/propertyName.md | 73 + resources/gens/docs/proxy.md | 72 + resources/gens/docs/readonly.md | 73 + resources/gens/docs/relation.md | 71 + resources/gens/docs/returns.md | 73 + resources/gens/docs/safe.md | 72 + resources/gens/docs/schema.md | 71 + resources/gens/docs/schemaDefinitions.md | 74 + resources/gens/docs/scheme.md | 68 + resources/gens/docs/scopes.md | 71 + resources/gens/docs/security.md | 75 + resources/gens/docs/securityDefinitions.md | 57 + resources/gens/docs/sizes.md | 73 + resources/gens/docs/subprotocol.md | 72 + resources/gens/docs/subscription.md | 72 + resources/gens/docs/success.md | 71 + resources/gens/docs/supportContact.md | 72 + resources/gens/docs/synchronous.md | 75 + resources/gens/docs/target.md | 76 + .../gens/docs/thing-description-schema.md | 7 + resources/gens/docs/title.md | 79 + resources/gens/docs/titleInLanguage.md | 79 + resources/gens/docs/titles.md | 73 + resources/gens/docs/type.md | 65 + resources/gens/docs/uriVariables.md | 79 + resources/gens/docs/version.md | 65 + resources/gens/docs/writeOnly.md | 73 + .../jsonld/thing_description_schema.jsonld | 2433 ++++++++++++++++ .../thing_description_schema.context.jsonld | 283 ++ .../jsonschema/thing_description_schema.json | 1086 +++++++ resources/gens/markdown/@type.md | 22 + resources/gens/markdown/ActionAffordance.md | 72 + .../markdown/AdditionalExpectedResponse.md | 44 + resources/gens/markdown/DataSchema.md | 56 + resources/gens/markdown/EventAffordance.md | 69 + resources/gens/markdown/ExpectedResponse.md | 32 + resources/gens/markdown/Form.md | 55 + .../gens/markdown/InteractionAffordance.md | 55 + resources/gens/markdown/Link.md | 45 + resources/gens/markdown/MultiLanguage.md | 26 + resources/gens/markdown/OperationTypes.md | 31 + resources/gens/markdown/PropertyAffordance.md | 82 + resources/gens/markdown/SecurityScheme.md | 27 + resources/gens/markdown/SecuritySchemeType.md | 22 + resources/gens/markdown/Thing.md | 86 + resources/gens/markdown/VersionInfo.md | 29 + .../markdown/actionAffordance__idempotent.md | 21 + .../gens/markdown/actionAffordance__input.md | 21 + .../gens/markdown/actionAffordance__output.md | 21 + .../gens/markdown/actionAffordance__safe.md | 21 + .../markdown/actionAffordance__synchronous.md | 21 + ...xpectedResponse__additionalOutputSchema.md | 21 + .../additionalExpectedResponse__schema.md | 21 + .../additionalExpectedResponse__success.md | 21 + .../gens/markdown/dataSchema__propertyName.md | 22 + .../gens/markdown/dataSchema__readonly.md | 22 + .../gens/markdown/dataSchema__writeOnly.md | 22 + resources/gens/markdown/description.md | 26 + .../gens/markdown/descriptionInLanguage.md | 26 + resources/gens/markdown/descriptions.md | 26 + .../markdown/eventAffordance__cancellation.md | 21 + .../markdown/eventAffordance__notification.md | 21 + .../eventAffordance__notificationResponse.md | 21 + .../markdown/eventAffordance__subscription.md | 21 + .../markdown/expectedResponse__contentType.md | 22 + .../gens/markdown/form__additionalReturns.md | 21 + .../gens/markdown/form__contentCoding.md | 21 + resources/gens/markdown/form__contentType.md | 21 + resources/gens/markdown/form__href.md | 21 + .../gens/markdown/form__operationType.md | 21 + resources/gens/markdown/form__returns.md | 21 + resources/gens/markdown/form__scopes.md | 21 + .../markdown/form__securityDefinitions.md | 21 + resources/gens/markdown/form__subprotocol.md | 21 + resources/gens/markdown/id.md | 27 + resources/gens/markdown/index.md | 150 + .../markdown/interactionAffordance__forms.md | 24 + .../markdown/interactionAffordance__name.md | 24 + .../interactionAffordance__uriVariables.md | 24 + resources/gens/markdown/link__anchor.md | 21 + .../gens/markdown/link__hintsAtMediaType.md | 21 + resources/gens/markdown/link__hreflang.md | 21 + resources/gens/markdown/link__relation.md | 21 + resources/gens/markdown/link__sizes.md | 21 + resources/gens/markdown/link__type.md | 21 + resources/gens/markdown/multiLanguage__key.md | 21 + .../propertyAffordance__observable.md | 21 + .../markdown/securityScheme__description.md | 21 + .../gens/markdown/securityScheme__proxy.md | 21 + .../gens/markdown/securityScheme__scheme.md | 21 + resources/gens/markdown/target.md | 28 + resources/gens/markdown/thing__actions.md | 21 + resources/gens/markdown/thing__base.md | 21 + resources/gens/markdown/thing__created.md | 21 + resources/gens/markdown/thing__events.md | 21 + resources/gens/markdown/thing__forms.md | 21 + resources/gens/markdown/thing__instance.md | 21 + resources/gens/markdown/thing__links.md | 21 + resources/gens/markdown/thing__modified.md | 21 + resources/gens/markdown/thing__profile.md | 21 + resources/gens/markdown/thing__properties.md | 21 + .../gens/markdown/thing__schemaDefinitions.md | 21 + resources/gens/markdown/thing__security.md | 21 + .../markdown/thing__securityDefinitions.md | 21 + .../gens/markdown/thing__supportContact.md | 21 + resources/gens/markdown/thing__version.md | 21 + .../gens/markdown/thing_description_schema.md | 2583 +++++++++++++++++ resources/gens/markdown/title.md | 32 + resources/gens/markdown/titleInLanguage.md | 26 + resources/gens/markdown/titles.md | 25 + resources/gens/markdown/types/AnyUri.md | 10 + resources/gens/markdown/types/Boolean.md | 17 + resources/gens/markdown/types/Curie.md | 18 + resources/gens/markdown/types/Date.md | 17 + .../gens/markdown/types/DateOrDatetime.md | 11 + resources/gens/markdown/types/Datetime.md | 17 + resources/gens/markdown/types/Decimal.md | 16 + resources/gens/markdown/types/Double.md | 16 + resources/gens/markdown/types/Float.md | 16 + resources/gens/markdown/types/Integer.md | 16 + resources/gens/markdown/types/Jsonpath.md | 11 + resources/gens/markdown/types/Jsonpointer.md | 11 + resources/gens/markdown/types/Ncname.md | 11 + .../gens/markdown/types/Nodeidentifier.md | 11 + .../gens/markdown/types/Objectidentifier.md | 17 + resources/gens/markdown/types/Sparqlpath.md | 11 + resources/gens/markdown/types/String.md | 16 + resources/gens/markdown/types/Time.md | 17 + resources/gens/markdown/types/Uri.md | 18 + resources/gens/markdown/types/Uriorcurie.md | 11 + .../gens/markdown/versionInfo__instance.md | 21 + resources/gens/markdown/versionInfo__model.md | 21 + .../gens/owl/thing_description_schema.owl.ttl | 1287 ++++++++ .../gens/protobuf/thing_description_schema.js | 162 ++ .../shacl/thing_description_schema.shacl.ttl | 696 +++++ .../gens/shex/thing_description_schema.shex | 225 ++ .../typescript/thing_description_schema.js | 300 ++ 208 files changed, 21325 insertions(+) create mode 100644 resources/gens/docs/@type.md create mode 100644 resources/gens/docs/ActionAffordance.md create mode 100644 resources/gens/docs/AdditionalExpectedResponse.md create mode 100644 resources/gens/docs/AnyUri.md create mode 100644 resources/gens/docs/Boolean.md create mode 100644 resources/gens/docs/Curie.md create mode 100644 resources/gens/docs/DataSchema.md create mode 100644 resources/gens/docs/Date.md create mode 100644 resources/gens/docs/DateOrDatetime.md create mode 100644 resources/gens/docs/Datetime.md create mode 100644 resources/gens/docs/Decimal.md create mode 100644 resources/gens/docs/Double.md create mode 100644 resources/gens/docs/EventAffordance.md create mode 100644 resources/gens/docs/ExpectedResponse.md create mode 100644 resources/gens/docs/Float.md create mode 100644 resources/gens/docs/Form.md create mode 100644 resources/gens/docs/Integer.md create mode 100644 resources/gens/docs/InteractionAffordance.md create mode 100644 resources/gens/docs/Jsonpath.md create mode 100644 resources/gens/docs/Jsonpointer.md create mode 100644 resources/gens/docs/Link.md create mode 100644 resources/gens/docs/MultiLanguage.md create mode 100644 resources/gens/docs/Ncname.md create mode 100644 resources/gens/docs/Nodeidentifier.md create mode 100644 resources/gens/docs/Objectidentifier.md create mode 100644 resources/gens/docs/OperationTypes.md create mode 100644 resources/gens/docs/PropertyAffordance.md create mode 100644 resources/gens/docs/SecurityScheme.md create mode 100644 resources/gens/docs/SecuritySchemeType.md create mode 100644 resources/gens/docs/Sparqlpath.md create mode 100644 resources/gens/docs/String.md create mode 100644 resources/gens/docs/Thing.md create mode 100644 resources/gens/docs/Time.md create mode 100644 resources/gens/docs/Uri.md create mode 100644 resources/gens/docs/Uriorcurie.md create mode 100644 resources/gens/docs/VersionInfo.md create mode 100644 resources/gens/docs/about.md create mode 100644 resources/gens/docs/actions.md create mode 100644 resources/gens/docs/additionalOutputSchema.md create mode 100644 resources/gens/docs/additionalReturns.md create mode 100644 resources/gens/docs/anchor.md create mode 100644 resources/gens/docs/base.md create mode 100644 resources/gens/docs/cancellation.md create mode 100644 resources/gens/docs/contentCoding.md create mode 100644 resources/gens/docs/contentType.md create mode 100644 resources/gens/docs/created.md create mode 100644 resources/gens/docs/description.md create mode 100644 resources/gens/docs/descriptionInLanguage.md create mode 100644 resources/gens/docs/descriptions.md create mode 100644 resources/gens/docs/events.md create mode 100644 resources/gens/docs/forms.md create mode 100644 resources/gens/docs/hintsAtMediaType.md create mode 100644 resources/gens/docs/href.md create mode 100644 resources/gens/docs/hreflang.md create mode 100644 resources/gens/docs/id.md create mode 100644 resources/gens/docs/idempotent.md create mode 100644 resources/gens/docs/index.md create mode 100644 resources/gens/docs/input.md create mode 100644 resources/gens/docs/instance.md create mode 100644 resources/gens/docs/key.md create mode 100644 resources/gens/docs/links.md create mode 100644 resources/gens/docs/model.md create mode 100644 resources/gens/docs/modified.md create mode 100644 resources/gens/docs/name.md create mode 100644 resources/gens/docs/notification.md create mode 100644 resources/gens/docs/notificationResponse.md create mode 100644 resources/gens/docs/observable.md create mode 100644 resources/gens/docs/operationType.md create mode 100644 resources/gens/docs/output.md create mode 100644 resources/gens/docs/profile.md create mode 100644 resources/gens/docs/properties.md create mode 100644 resources/gens/docs/propertyName.md create mode 100644 resources/gens/docs/proxy.md create mode 100644 resources/gens/docs/readonly.md create mode 100644 resources/gens/docs/relation.md create mode 100644 resources/gens/docs/returns.md create mode 100644 resources/gens/docs/safe.md create mode 100644 resources/gens/docs/schema.md create mode 100644 resources/gens/docs/schemaDefinitions.md create mode 100644 resources/gens/docs/scheme.md create mode 100644 resources/gens/docs/scopes.md create mode 100644 resources/gens/docs/security.md create mode 100644 resources/gens/docs/securityDefinitions.md create mode 100644 resources/gens/docs/sizes.md create mode 100644 resources/gens/docs/subprotocol.md create mode 100644 resources/gens/docs/subscription.md create mode 100644 resources/gens/docs/success.md create mode 100644 resources/gens/docs/supportContact.md create mode 100644 resources/gens/docs/synchronous.md create mode 100644 resources/gens/docs/target.md create mode 100644 resources/gens/docs/thing-description-schema.md create mode 100644 resources/gens/docs/title.md create mode 100644 resources/gens/docs/titleInLanguage.md create mode 100644 resources/gens/docs/titles.md create mode 100644 resources/gens/docs/type.md create mode 100644 resources/gens/docs/uriVariables.md create mode 100644 resources/gens/docs/version.md create mode 100644 resources/gens/docs/writeOnly.md create mode 100644 resources/gens/jsonld/thing_description_schema.jsonld create mode 100644 resources/gens/jsonldcontext/thing_description_schema.context.jsonld create mode 100644 resources/gens/jsonschema/thing_description_schema.json create mode 100644 resources/gens/markdown/@type.md create mode 100644 resources/gens/markdown/ActionAffordance.md create mode 100644 resources/gens/markdown/AdditionalExpectedResponse.md create mode 100644 resources/gens/markdown/DataSchema.md create mode 100644 resources/gens/markdown/EventAffordance.md create mode 100644 resources/gens/markdown/ExpectedResponse.md create mode 100644 resources/gens/markdown/Form.md create mode 100644 resources/gens/markdown/InteractionAffordance.md create mode 100644 resources/gens/markdown/Link.md create mode 100644 resources/gens/markdown/MultiLanguage.md create mode 100644 resources/gens/markdown/OperationTypes.md create mode 100644 resources/gens/markdown/PropertyAffordance.md create mode 100644 resources/gens/markdown/SecurityScheme.md create mode 100644 resources/gens/markdown/SecuritySchemeType.md create mode 100644 resources/gens/markdown/Thing.md create mode 100644 resources/gens/markdown/VersionInfo.md create mode 100644 resources/gens/markdown/actionAffordance__idempotent.md create mode 100644 resources/gens/markdown/actionAffordance__input.md create mode 100644 resources/gens/markdown/actionAffordance__output.md create mode 100644 resources/gens/markdown/actionAffordance__safe.md create mode 100644 resources/gens/markdown/actionAffordance__synchronous.md create mode 100644 resources/gens/markdown/additionalExpectedResponse__additionalOutputSchema.md create mode 100644 resources/gens/markdown/additionalExpectedResponse__schema.md create mode 100644 resources/gens/markdown/additionalExpectedResponse__success.md create mode 100644 resources/gens/markdown/dataSchema__propertyName.md create mode 100644 resources/gens/markdown/dataSchema__readonly.md create mode 100644 resources/gens/markdown/dataSchema__writeOnly.md create mode 100644 resources/gens/markdown/description.md create mode 100644 resources/gens/markdown/descriptionInLanguage.md create mode 100644 resources/gens/markdown/descriptions.md create mode 100644 resources/gens/markdown/eventAffordance__cancellation.md create mode 100644 resources/gens/markdown/eventAffordance__notification.md create mode 100644 resources/gens/markdown/eventAffordance__notificationResponse.md create mode 100644 resources/gens/markdown/eventAffordance__subscription.md create mode 100644 resources/gens/markdown/expectedResponse__contentType.md create mode 100644 resources/gens/markdown/form__additionalReturns.md create mode 100644 resources/gens/markdown/form__contentCoding.md create mode 100644 resources/gens/markdown/form__contentType.md create mode 100644 resources/gens/markdown/form__href.md create mode 100644 resources/gens/markdown/form__operationType.md create mode 100644 resources/gens/markdown/form__returns.md create mode 100644 resources/gens/markdown/form__scopes.md create mode 100644 resources/gens/markdown/form__securityDefinitions.md create mode 100644 resources/gens/markdown/form__subprotocol.md create mode 100644 resources/gens/markdown/id.md create mode 100644 resources/gens/markdown/index.md create mode 100644 resources/gens/markdown/interactionAffordance__forms.md create mode 100644 resources/gens/markdown/interactionAffordance__name.md create mode 100644 resources/gens/markdown/interactionAffordance__uriVariables.md create mode 100644 resources/gens/markdown/link__anchor.md create mode 100644 resources/gens/markdown/link__hintsAtMediaType.md create mode 100644 resources/gens/markdown/link__hreflang.md create mode 100644 resources/gens/markdown/link__relation.md create mode 100644 resources/gens/markdown/link__sizes.md create mode 100644 resources/gens/markdown/link__type.md create mode 100644 resources/gens/markdown/multiLanguage__key.md create mode 100644 resources/gens/markdown/propertyAffordance__observable.md create mode 100644 resources/gens/markdown/securityScheme__description.md create mode 100644 resources/gens/markdown/securityScheme__proxy.md create mode 100644 resources/gens/markdown/securityScheme__scheme.md create mode 100644 resources/gens/markdown/target.md create mode 100644 resources/gens/markdown/thing__actions.md create mode 100644 resources/gens/markdown/thing__base.md create mode 100644 resources/gens/markdown/thing__created.md create mode 100644 resources/gens/markdown/thing__events.md create mode 100644 resources/gens/markdown/thing__forms.md create mode 100644 resources/gens/markdown/thing__instance.md create mode 100644 resources/gens/markdown/thing__links.md create mode 100644 resources/gens/markdown/thing__modified.md create mode 100644 resources/gens/markdown/thing__profile.md create mode 100644 resources/gens/markdown/thing__properties.md create mode 100644 resources/gens/markdown/thing__schemaDefinitions.md create mode 100644 resources/gens/markdown/thing__security.md create mode 100644 resources/gens/markdown/thing__securityDefinitions.md create mode 100644 resources/gens/markdown/thing__supportContact.md create mode 100644 resources/gens/markdown/thing__version.md create mode 100644 resources/gens/markdown/thing_description_schema.md create mode 100644 resources/gens/markdown/title.md create mode 100644 resources/gens/markdown/titleInLanguage.md create mode 100644 resources/gens/markdown/titles.md create mode 100644 resources/gens/markdown/types/AnyUri.md create mode 100644 resources/gens/markdown/types/Boolean.md create mode 100644 resources/gens/markdown/types/Curie.md create mode 100644 resources/gens/markdown/types/Date.md create mode 100644 resources/gens/markdown/types/DateOrDatetime.md create mode 100644 resources/gens/markdown/types/Datetime.md create mode 100644 resources/gens/markdown/types/Decimal.md create mode 100644 resources/gens/markdown/types/Double.md create mode 100644 resources/gens/markdown/types/Float.md create mode 100644 resources/gens/markdown/types/Integer.md create mode 100644 resources/gens/markdown/types/Jsonpath.md create mode 100644 resources/gens/markdown/types/Jsonpointer.md create mode 100644 resources/gens/markdown/types/Ncname.md create mode 100644 resources/gens/markdown/types/Nodeidentifier.md create mode 100644 resources/gens/markdown/types/Objectidentifier.md create mode 100644 resources/gens/markdown/types/Sparqlpath.md create mode 100644 resources/gens/markdown/types/String.md create mode 100644 resources/gens/markdown/types/Time.md create mode 100644 resources/gens/markdown/types/Uri.md create mode 100644 resources/gens/markdown/types/Uriorcurie.md create mode 100644 resources/gens/markdown/versionInfo__instance.md create mode 100644 resources/gens/markdown/versionInfo__model.md create mode 100644 resources/gens/owl/thing_description_schema.owl.ttl create mode 100644 resources/gens/protobuf/thing_description_schema.js create mode 100644 resources/gens/shacl/thing_description_schema.shacl.ttl create mode 100644 resources/gens/shex/thing_description_schema.shex create mode 100644 resources/gens/typescript/thing_description_schema.js diff --git a/resources/gens/docs/@type.md b/resources/gens/docs/@type.md new file mode 100644 index 0000000..8c36b3e --- /dev/null +++ b/resources/gens/docs/@type.md @@ -0,0 +1,69 @@ + + +# Slot: @type + +URI: [td:@type](https://www.w3.org/2019/wot/td#@type) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [SecurityScheme](SecurityScheme.md) | | no | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: '@type' +from_schema: td +rank: 1000 +multivalued: true +alias: '@type' +domain_of: +- SecurityScheme +- Thing +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/ActionAffordance.md b/resources/gens/docs/ActionAffordance.md new file mode 100644 index 0000000..b560458 --- /dev/null +++ b/resources/gens/docs/ActionAffordance.md @@ -0,0 +1,459 @@ + + +# Class: ActionAffordance + + +_An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time)._ + + + + + +URI: [td:ActionAffordance](https://www.w3.org/2019/wot/td#ActionAffordance) + + + + + + +```mermaid + classDiagram + class ActionAffordance + click ActionAffordance href "../ActionAffordance" + InteractionAffordance <|-- ActionAffordance + click InteractionAffordance href "../InteractionAffordance" + + ActionAffordance : description + + + + + ActionAffordance --> "0..1" MultiLanguage : description + click MultiLanguage href "../MultiLanguage" + + + ActionAffordance : descriptionInLanguage + + + + + ActionAffordance --> "0..1" MultiLanguage : descriptionInLanguage + click MultiLanguage href "../MultiLanguage" + + + ActionAffordance : descriptions + + + + + ActionAffordance --> "*" MultiLanguage : descriptions + click MultiLanguage href "../MultiLanguage" + + + ActionAffordance : forms + + + + + ActionAffordance --> "*" Form : forms + click Form href "../Form" + + + ActionAffordance : idempotent + + ActionAffordance : input + + + + + ActionAffordance --> "0..1" DataSchema : input + click DataSchema href "../DataSchema" + + + ActionAffordance : name + + ActionAffordance : output + + + + + ActionAffordance --> "0..1" DataSchema : output + click DataSchema href "../DataSchema" + + + ActionAffordance : safe + + ActionAffordance : synchronous + + ActionAffordance : title + + + + + ActionAffordance --> "0..1" MultiLanguage : title + click MultiLanguage href "../MultiLanguage" + + + ActionAffordance : titleInLanguage + + + + + ActionAffordance --> "0..1" MultiLanguage : titleInLanguage + click MultiLanguage href "../MultiLanguage" + + + ActionAffordance : titles + + + + + ActionAffordance --> "*" MultiLanguage : titles + click MultiLanguage href "../MultiLanguage" + + + ActionAffordance : uriVariables + + + + + ActionAffordance --> "*" DataSchema : uriVariables + click DataSchema href "../DataSchema" + + + +``` + + + + + +## Inheritance +* [InteractionAffordance](InteractionAffordance.md) + * **ActionAffordance** + + + +## Slots + +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [safe](safe.md) | 0..1 <br/> [Boolean](Boolean.md) | Signals if the action is safe (=true) or not | direct | +| [synchronous](synchronous.md) | 0..1 <br/> [Boolean](Boolean.md) | Indicates whether the action is synchronous (=true) or not | direct | +| [idempotent](idempotent.md) | 0..1 <br/> [Boolean](Boolean.md) | Indicates whether the action is idempotent (=true) or not | direct | +| [input](input.md) | 0..1 <br/> [DataSchema](DataSchema.md) | Used to define the input data schema of the action | direct | +| [output](output.md) | 0..1 <br/> [DataSchema](DataSchema.md) | Used to define the output data schema of the action | direct | +| [titles](titles.md) | * <br/> [MultiLanguage](MultiLanguage.md) | | [InteractionAffordance](InteractionAffordance.md) | +| [descriptions](descriptions.md) | * <br/> [MultiLanguage](MultiLanguage.md) | TODO, check, according to the description a description should not contain a ... | [InteractionAffordance](InteractionAffordance.md) | +| [title](title.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | Provides a human-readable title (e | [InteractionAffordance](InteractionAffordance.md) | +| [description](description.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | | [InteractionAffordance](InteractionAffordance.md) | +| [titleInLanguage](titleInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | [InteractionAffordance](InteractionAffordance.md) | +| [descriptionInLanguage](descriptionInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | [InteractionAffordance](InteractionAffordance.md) | +| [name](name.md) | 1 <br/> [String](String.md) | Indexing property to store entity names when serializing them in a JSON-LD @i... | [InteractionAffordance](InteractionAffordance.md) | +| [uriVariables](uriVariables.md) | * <br/> [DataSchema](DataSchema.md) | Define URI template variables according to RFC6570 as collection based on sch... | [InteractionAffordance](InteractionAffordance.md) | +| [forms](forms.md) | * <br/> [Form](Form.md) | Set of form hypermedia controls that describe how an operation can be perform... | [InteractionAffordance](InteractionAffordance.md) | + + + + + +## Usages + +| used by | used in | type | used | +| --- | --- | --- | --- | +| [Thing](Thing.md) | [actions](actions.md) | range | [ActionAffordance](ActionAffordance.md) | + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | td:ActionAffordance | +| native | td:ActionAffordance | + + + + + +## LinkML Source + +<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> + +### Direct + +<details> +```yaml +name: ActionAffordance +description: An Interaction Affordance that allows to invoke a function of the Thing, + which manipulates state (e.g., toggling a lamp on or off) or triggers a process + on the Thing (e.g., dim a lamp over time). +from_schema: td +rank: 1000 +is_a: InteractionAffordance +attributes: + safe: + name: safe + description: Signals if the action is safe (=true) or not. Used to signal if there + is no internal state (cf. resource state) is changed when invoking an Action. + from_schema: td + rank: 1000 + domain_of: + - ActionAffordance + range: boolean + synchronous: + name: synchronous + description: Indicates whether the action is synchronous (=true) or not. A synchronous + action means that the response of action contains all the information about + the result of the action and no further querying about the status of the action + is needed. Lack of this keyword means that no claim on the synchronicity of + the action can be made. + from_schema: td + rank: 1000 + domain_of: + - ActionAffordance + range: boolean + idempotent: + name: idempotent + description: Indicates whether the action is idempotent (=true) or not. Informs + whether the action can be called repeatedly with the same results, if present, + based on the same input. + from_schema: td + rank: 1000 + domain_of: + - ActionAffordance + range: boolean + input: + name: input + description: Used to define the input data schema of the action. + from_schema: td + rank: 1000 + domain_of: + - ActionAffordance + range: DataSchema + output: + name: output + description: Used to define the output data schema of the action. + from_schema: td + rank: 1000 + domain_of: + - ActionAffordance + range: DataSchema +class_uri: td:ActionAffordance + +``` +</details> + +### Induced + +<details> +```yaml +name: ActionAffordance +description: An Interaction Affordance that allows to invoke a function of the Thing, + which manipulates state (e.g., toggling a lamp on or off) or triggers a process + on the Thing (e.g., dim a lamp over time). +from_schema: td +rank: 1000 +is_a: InteractionAffordance +attributes: + safe: + name: safe + description: Signals if the action is safe (=true) or not. Used to signal if there + is no internal state (cf. resource state) is changed when invoking an Action. + from_schema: td + rank: 1000 + alias: safe + owner: ActionAffordance + domain_of: + - ActionAffordance + range: boolean + synchronous: + name: synchronous + description: Indicates whether the action is synchronous (=true) or not. A synchronous + action means that the response of action contains all the information about + the result of the action and no further querying about the status of the action + is needed. Lack of this keyword means that no claim on the synchronicity of + the action can be made. + from_schema: td + rank: 1000 + alias: synchronous + owner: ActionAffordance + domain_of: + - ActionAffordance + range: boolean + idempotent: + name: idempotent + description: Indicates whether the action is idempotent (=true) or not. Informs + whether the action can be called repeatedly with the same results, if present, + based on the same input. + from_schema: td + rank: 1000 + alias: idempotent + owner: ActionAffordance + domain_of: + - ActionAffordance + range: boolean + input: + name: input + description: Used to define the input data schema of the action. + from_schema: td + rank: 1000 + alias: input + owner: ActionAffordance + domain_of: + - ActionAffordance + range: DataSchema + output: + name: output + description: Used to define the output data schema of the action. + from_schema: td + rank: 1000 + alias: output + owner: ActionAffordance + domain_of: + - ActionAffordance + range: DataSchema + titles: + name: titles + from_schema: td + rank: 1000 + multivalued: true + alias: titles + owner: ActionAffordance + domain_of: + - InteractionAffordance + - Thing + range: MultiLanguage + inlined: true + descriptions: + name: descriptions + description: TODO, check, according to the description a description should not + contain a lang tag. + from_schema: td + rank: 1000 + multivalued: true + alias: descriptions + owner: ActionAffordance + domain_of: + - SecurityScheme + - InteractionAffordance + - Thing + range: MultiLanguage + inlined: true + title: + name: title + description: Provides a human-readable title (e.g., display a text for UI representation) + based on a default language. + from_schema: td + rank: 1000 + slot_uri: td:title + alias: title + owner: ActionAffordance + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + description: + name: description + from_schema: td + rank: 1000 + alias: description + owner: ActionAffordance + domain_of: + - SecurityScheme + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + titleInLanguage: + name: titleInLanguage + description: title of the TD element (Thing, interaction affordance, security + scheme or data scheme) with language tag. By convention, a language tag must + be added to the object of descriptionInLanguage. Otherwise use description. + from_schema: td + rank: 1000 + alias: titleInLanguage + owner: ActionAffordance + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + descriptionInLanguage: + name: descriptionInLanguage + description: description of the TD element (Thing, interaction affordance, security + scheme or data scheme) with language tag. By convention, a language tag must + be added to the object of descriptionInLanguage. Otherwise use description. + from_schema: td + rank: 1000 + alias: descriptionInLanguage + owner: ActionAffordance + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + name: + name: name + description: Indexing property to store entity names when serializing them in + a JSON-LD @index container. + from_schema: td + rank: 1000 + identifier: true + alias: name + owner: ActionAffordance + domain_of: + - InteractionAffordance + range: string + required: true + uriVariables: + name: uriVariables + description: 'Define URI template variables according to RFC6570 as collection + based on schema specifications. The individual variables DataSchema cannot be + an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.' + from_schema: td + rank: 1000 + multivalued: true + alias: uriVariables + owner: ActionAffordance + domain_of: + - InteractionAffordance + range: DataSchema + forms: + name: forms + description: Set of form hypermedia controls that describe how an operation can + be performed. + from_schema: td + rank: 1000 + multivalued: true + alias: forms + owner: ActionAffordance + domain_of: + - InteractionAffordance + - Thing + range: Form +class_uri: td:ActionAffordance + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/AdditionalExpectedResponse.md b/resources/gens/docs/AdditionalExpectedResponse.md new file mode 100644 index 0000000..a4394a9 --- /dev/null +++ b/resources/gens/docs/AdditionalExpectedResponse.md @@ -0,0 +1,203 @@ + + +# Class: AdditionalExpectedResponse + + +_Communication metadata describing the expected response message for additional responses._ + + + + + +URI: [hctl:AdditionalExpectedResponse](https://www.w3.org/2019/wot/hypermedia#AdditionalExpectedResponse) + + + + + + +```mermaid + classDiagram + class AdditionalExpectedResponse + click AdditionalExpectedResponse href "../AdditionalExpectedResponse" + ExpectedResponse <|-- AdditionalExpectedResponse + click ExpectedResponse href "../ExpectedResponse" + + AdditionalExpectedResponse : additionalOutputSchema + + AdditionalExpectedResponse : contentType + + AdditionalExpectedResponse : schema + + AdditionalExpectedResponse : success + + +``` + + + + + +## Inheritance +* [ExpectedResponse](ExpectedResponse.md) + * **AdditionalExpectedResponse** + + + +## Slots + +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [additionalOutputSchema](additionalOutputSchema.md) | 0..1 <br/> [String](String.md) | This optional term can be used to define a data schema for an additional resp... | direct | +| [success](success.md) | 0..1 <br/> [Boolean](Boolean.md) | Signals if the additional response should not be considered an error | direct | +| [schema](schema.md) | 0..1 <br/> [String](String.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | direct | +| [contentType](contentType.md) | 1 <br/> [String](String.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | [ExpectedResponse](ExpectedResponse.md) | + + + + + +## Usages + +| used by | used in | type | used | +| --- | --- | --- | --- | +| [Form](Form.md) | [additionalReturns](additionalReturns.md) | range | [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | hctl:AdditionalExpectedResponse | +| native | td:AdditionalExpectedResponse | + + + + + +## LinkML Source + +<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> + +### Direct + +<details> +```yaml +name: AdditionalExpectedResponse +description: Communication metadata describing the expected response message for additional + responses. +from_schema: td +rank: 1000 +is_a: ExpectedResponse +attributes: + additionalOutputSchema: + name: additionalOutputSchema + description: This optional term can be used to define a data schema for an additional + response if it differs from the default output data schema. Rather than a DataSchema + object, the name of a previous definition given in a SchemaDefinitions map must + be used. + from_schema: td + rank: 1000 + domain_of: + - AdditionalExpectedResponse + success: + name: success + description: Signals if the additional response should not be considered an error. + from_schema: td + rank: 1000 + domain_of: + - AdditionalExpectedResponse + range: boolean + schema: + name: schema + description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + from_schema: td + rank: 1000 + domain_of: + - AdditionalExpectedResponse +class_uri: hctl:AdditionalExpectedResponse + +``` +</details> + +### Induced + +<details> +```yaml +name: AdditionalExpectedResponse +description: Communication metadata describing the expected response message for additional + responses. +from_schema: td +rank: 1000 +is_a: ExpectedResponse +attributes: + additionalOutputSchema: + name: additionalOutputSchema + description: This optional term can be used to define a data schema for an additional + response if it differs from the default output data schema. Rather than a DataSchema + object, the name of a previous definition given in a SchemaDefinitions map must + be used. + from_schema: td + rank: 1000 + alias: additionalOutputSchema + owner: AdditionalExpectedResponse + domain_of: + - AdditionalExpectedResponse + range: string + success: + name: success + description: Signals if the additional response should not be considered an error. + from_schema: td + rank: 1000 + alias: success + owner: AdditionalExpectedResponse + domain_of: + - AdditionalExpectedResponse + range: boolean + schema: + name: schema + description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + from_schema: td + rank: 1000 + alias: schema + owner: AdditionalExpectedResponse + domain_of: + - AdditionalExpectedResponse + range: string + contentType: + name: contentType + description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + from_schema: td + rank: 1000 + alias: contentType + owner: AdditionalExpectedResponse + domain_of: + - ExpectedResponse + - Form + range: string + required: true +class_uri: hctl:AdditionalExpectedResponse + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/AnyUri.md b/resources/gens/docs/AnyUri.md new file mode 100644 index 0000000..e0c2eed --- /dev/null +++ b/resources/gens/docs/AnyUri.md @@ -0,0 +1,38 @@ +# Type: AnyUri + + + + +_a complete URI_ + + + +URI: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI) + +* [base](https://w3id.org/linkml/base): URI + +* [uri](https://w3id.org/linkml/uri): xsd:anyURI + + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/Boolean.md b/resources/gens/docs/Boolean.md new file mode 100644 index 0000000..8753cd0 --- /dev/null +++ b/resources/gens/docs/Boolean.md @@ -0,0 +1,39 @@ +# Type: Boolean + + + + +_A binary (true or false) value_ + + + +URI: [xsd:boolean](http://www.w3.org/2001/XMLSchema#boolean) + +* [base](https://w3id.org/linkml/base): Bool + +* [uri](https://w3id.org/linkml/uri): xsd:boolean + +* [repr](https://w3id.org/linkml/repr): bool + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/Curie.md b/resources/gens/docs/Curie.md new file mode 100644 index 0000000..a09ae77 --- /dev/null +++ b/resources/gens/docs/Curie.md @@ -0,0 +1,44 @@ +# Type: Curie + + + + +_a compact URI_ + + + +URI: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +* [base](https://w3id.org/linkml/base): Curie + +* [uri](https://w3id.org/linkml/uri): xsd:string + +* [repr](https://w3id.org/linkml/repr): str + + + + + + + + +## Comments + +* in RDF serializations this MUST be expanded to a URI +* in non-RDF serializations MAY be serialized as the compact representation + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/DataSchema.md b/resources/gens/docs/DataSchema.md new file mode 100644 index 0000000..e4a85a0 --- /dev/null +++ b/resources/gens/docs/DataSchema.md @@ -0,0 +1,288 @@ + + +# Class: DataSchema + + +_Metadata that describes the data format used. It can be used for validation._ + + + + + +URI: [jsonschema:DataSchema](https://www.w3.org/2019/wot/json-schema#DataSchema) + + + + + + +```mermaid + classDiagram + class DataSchema + click DataSchema href "../DataSchema" + DataSchema <|-- PropertyAffordance + click PropertyAffordance href "../PropertyAffordance" + + DataSchema : description + + + + + DataSchema --> "0..1" MultiLanguage : description + click MultiLanguage href "../MultiLanguage" + + + DataSchema : descriptionInLanguage + + + + + DataSchema --> "0..1" MultiLanguage : descriptionInLanguage + click MultiLanguage href "../MultiLanguage" + + + DataSchema : propertyName + + DataSchema : readonly + + DataSchema : title + + + + + DataSchema --> "0..1" MultiLanguage : title + click MultiLanguage href "../MultiLanguage" + + + DataSchema : titleInLanguage + + + + + DataSchema --> "0..1" MultiLanguage : titleInLanguage + click MultiLanguage href "../MultiLanguage" + + + DataSchema : writeOnly + + +``` + + + + +<!-- no inheritance hierarchy --> + + +## Slots + +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [description](description.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | | direct | +| [title](title.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | Provides a human-readable title (e | direct | +| [titleInLanguage](titleInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | direct | +| [descriptionInLanguage](descriptionInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | direct | +| [propertyName](propertyName.md) | 0..1 <br/> [String](String.md) | Used to store the indexing name in the parent object when this schema appears... | direct | +| [writeOnly](writeOnly.md) | 0..1 <br/> [String](String.md) | Boolean value that is a hint to indicate whether a property interaction/value... | direct | +| [readonly](readonly.md) | 0..1 <br/> [String](String.md) | Boolean value that is a hint to indicate whether a property interaction/value... | direct | + + + + + +## Usages + +| used by | used in | type | used | +| --- | --- | --- | --- | +| [InteractionAffordance](InteractionAffordance.md) | [uriVariables](uriVariables.md) | range | [DataSchema](DataSchema.md) | +| [PropertyAffordance](PropertyAffordance.md) | [uriVariables](uriVariables.md) | range | [DataSchema](DataSchema.md) | +| [ActionAffordance](ActionAffordance.md) | [input](input.md) | range | [DataSchema](DataSchema.md) | +| [ActionAffordance](ActionAffordance.md) | [output](output.md) | range | [DataSchema](DataSchema.md) | +| [ActionAffordance](ActionAffordance.md) | [uriVariables](uriVariables.md) | range | [DataSchema](DataSchema.md) | +| [EventAffordance](EventAffordance.md) | [subscription](subscription.md) | range | [DataSchema](DataSchema.md) | +| [EventAffordance](EventAffordance.md) | [cancellation](cancellation.md) | range | [DataSchema](DataSchema.md) | +| [EventAffordance](EventAffordance.md) | [notification](notification.md) | range | [DataSchema](DataSchema.md) | +| [EventAffordance](EventAffordance.md) | [notificationResponse](notificationResponse.md) | range | [DataSchema](DataSchema.md) | +| [EventAffordance](EventAffordance.md) | [uriVariables](uriVariables.md) | range | [DataSchema](DataSchema.md) | +| [Thing](Thing.md) | [schemaDefinitions](schemaDefinitions.md) | range | [DataSchema](DataSchema.md) | + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | jsonschema:DataSchema | +| native | td:DataSchema | + + + + + +## LinkML Source + +<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> + +### Direct + +<details> +```yaml +name: DataSchema +description: Metadata that describes the data format used. It can be used for validation. +from_schema: td +rank: 1000 +slots: +- description +- title +- titleInLanguage +- descriptionInLanguage +attributes: + propertyName: + name: propertyName + description: Used to store the indexing name in the parent object when this schema + appears as a property of an object schema. + from_schema: td + rank: 1000 + domain_of: + - DataSchema + writeOnly: + name: writeOnly + description: Boolean value that is a hint to indicate whether a property interaction/value + is write only (=true) or not (=false). + from_schema: td + rank: 1000 + domain_of: + - DataSchema + readonly: + name: readonly + description: Boolean value that is a hint to indicate whether a property interaction/value + is read only (=true) or not (=false). + from_schema: td + rank: 1000 + domain_of: + - DataSchema +class_uri: jsonschema:DataSchema + +``` +</details> + +### Induced + +<details> +```yaml +name: DataSchema +description: Metadata that describes the data format used. It can be used for validation. +from_schema: td +rank: 1000 +attributes: + propertyName: + name: propertyName + description: Used to store the indexing name in the parent object when this schema + appears as a property of an object schema. + from_schema: td + rank: 1000 + alias: propertyName + owner: DataSchema + domain_of: + - DataSchema + range: string + writeOnly: + name: writeOnly + description: Boolean value that is a hint to indicate whether a property interaction/value + is write only (=true) or not (=false). + from_schema: td + rank: 1000 + alias: writeOnly + owner: DataSchema + domain_of: + - DataSchema + range: string + readonly: + name: readonly + description: Boolean value that is a hint to indicate whether a property interaction/value + is read only (=true) or not (=false). + from_schema: td + rank: 1000 + alias: readonly + owner: DataSchema + domain_of: + - DataSchema + range: string + description: + name: description + from_schema: td + rank: 1000 + alias: description + owner: DataSchema + domain_of: + - SecurityScheme + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + title: + name: title + description: Provides a human-readable title (e.g., display a text for UI representation) + based on a default language. + from_schema: td + rank: 1000 + slot_uri: td:title + alias: title + owner: DataSchema + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + titleInLanguage: + name: titleInLanguage + description: title of the TD element (Thing, interaction affordance, security + scheme or data scheme) with language tag. By convention, a language tag must + be added to the object of descriptionInLanguage. Otherwise use description. + from_schema: td + rank: 1000 + alias: titleInLanguage + owner: DataSchema + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + descriptionInLanguage: + name: descriptionInLanguage + description: description of the TD element (Thing, interaction affordance, security + scheme or data scheme) with language tag. By convention, a language tag must + be added to the object of descriptionInLanguage. Otherwise use description. + from_schema: td + rank: 1000 + alias: descriptionInLanguage + owner: DataSchema + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage +class_uri: jsonschema:DataSchema + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/Date.md b/resources/gens/docs/Date.md new file mode 100644 index 0000000..d9a40e8 --- /dev/null +++ b/resources/gens/docs/Date.md @@ -0,0 +1,39 @@ +# Type: Date + + + + +_a date (year, month and day) in an idealized calendar_ + + + +URI: [xsd:date](http://www.w3.org/2001/XMLSchema#date) + +* [base](https://w3id.org/linkml/base): XSDDate + +* [uri](https://w3id.org/linkml/uri): xsd:date + +* [repr](https://w3id.org/linkml/repr): str + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/DateOrDatetime.md b/resources/gens/docs/DateOrDatetime.md new file mode 100644 index 0000000..c72f04c --- /dev/null +++ b/resources/gens/docs/DateOrDatetime.md @@ -0,0 +1,39 @@ +# Type: DateOrDatetime + + + + +_Either a date or a datetime_ + + + +URI: [linkml:DateOrDatetime](https://w3id.org/linkml/DateOrDatetime) + +* [base](https://w3id.org/linkml/base): str + +* [uri](https://w3id.org/linkml/uri): linkml:DateOrDatetime + +* [repr](https://w3id.org/linkml/repr): str + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/Datetime.md b/resources/gens/docs/Datetime.md new file mode 100644 index 0000000..ff9343d --- /dev/null +++ b/resources/gens/docs/Datetime.md @@ -0,0 +1,39 @@ +# Type: Datetime + + + + +_The combination of a date and time_ + + + +URI: [xsd:dateTime](http://www.w3.org/2001/XMLSchema#dateTime) + +* [base](https://w3id.org/linkml/base): XSDDateTime + +* [uri](https://w3id.org/linkml/uri): xsd:dateTime + +* [repr](https://w3id.org/linkml/repr): str + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/Decimal.md b/resources/gens/docs/Decimal.md new file mode 100644 index 0000000..b28e415 --- /dev/null +++ b/resources/gens/docs/Decimal.md @@ -0,0 +1,38 @@ +# Type: Decimal + + + + +_A real number with arbitrary precision that conforms to the xsd:decimal specification_ + + + +URI: [xsd:decimal](http://www.w3.org/2001/XMLSchema#decimal) + +* [base](https://w3id.org/linkml/base): Decimal + +* [uri](https://w3id.org/linkml/uri): xsd:decimal + + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/Double.md b/resources/gens/docs/Double.md new file mode 100644 index 0000000..17cc6bf --- /dev/null +++ b/resources/gens/docs/Double.md @@ -0,0 +1,38 @@ +# Type: Double + + + + +_A real number that conforms to the xsd:double specification_ + + + +URI: [xsd:double](http://www.w3.org/2001/XMLSchema#double) + +* [base](https://w3id.org/linkml/base): float + +* [uri](https://w3id.org/linkml/uri): xsd:double + + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/EventAffordance.md b/resources/gens/docs/EventAffordance.md new file mode 100644 index 0000000..b1ccc60 --- /dev/null +++ b/resources/gens/docs/EventAffordance.md @@ -0,0 +1,444 @@ + + +# Class: EventAffordance + + +_An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts)._ + + + + + +URI: [td:EventAffordance](https://www.w3.org/2019/wot/td#EventAffordance) + + + + + + +```mermaid + classDiagram + class EventAffordance + click EventAffordance href "../EventAffordance" + InteractionAffordance <|-- EventAffordance + click InteractionAffordance href "../InteractionAffordance" + + EventAffordance : cancellation + + + + + EventAffordance --> "0..1" DataSchema : cancellation + click DataSchema href "../DataSchema" + + + EventAffordance : description + + + + + EventAffordance --> "0..1" MultiLanguage : description + click MultiLanguage href "../MultiLanguage" + + + EventAffordance : descriptionInLanguage + + + + + EventAffordance --> "0..1" MultiLanguage : descriptionInLanguage + click MultiLanguage href "../MultiLanguage" + + + EventAffordance : descriptions + + + + + EventAffordance --> "*" MultiLanguage : descriptions + click MultiLanguage href "../MultiLanguage" + + + EventAffordance : forms + + + + + EventAffordance --> "*" Form : forms + click Form href "../Form" + + + EventAffordance : name + + EventAffordance : notification + + + + + EventAffordance --> "0..1" DataSchema : notification + click DataSchema href "../DataSchema" + + + EventAffordance : notificationResponse + + + + + EventAffordance --> "0..1" DataSchema : notificationResponse + click DataSchema href "../DataSchema" + + + EventAffordance : subscription + + + + + EventAffordance --> "0..1" DataSchema : subscription + click DataSchema href "../DataSchema" + + + EventAffordance : title + + + + + EventAffordance --> "0..1" MultiLanguage : title + click MultiLanguage href "../MultiLanguage" + + + EventAffordance : titleInLanguage + + + + + EventAffordance --> "0..1" MultiLanguage : titleInLanguage + click MultiLanguage href "../MultiLanguage" + + + EventAffordance : titles + + + + + EventAffordance --> "*" MultiLanguage : titles + click MultiLanguage href "../MultiLanguage" + + + EventAffordance : uriVariables + + + + + EventAffordance --> "*" DataSchema : uriVariables + click DataSchema href "../DataSchema" + + + +``` + + + + + +## Inheritance +* [InteractionAffordance](InteractionAffordance.md) + * **EventAffordance** + + + +## Slots + +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [subscription](subscription.md) | 0..1 <br/> [DataSchema](DataSchema.md) | Defines data that needs to be passed upon subscription, e | direct | +| [cancellation](cancellation.md) | 0..1 <br/> [DataSchema](DataSchema.md) | Defines any data that needs to be passed to cancel a subscription, e | direct | +| [notification](notification.md) | 0..1 <br/> [DataSchema](DataSchema.md) | Defines the data schema of the Event instance messages pushed by the Thing | direct | +| [notificationResponse](notificationResponse.md) | 0..1 <br/> [DataSchema](DataSchema.md) | Defines the data schema of the Event response messages sent by the consumer i... | direct | +| [titles](titles.md) | * <br/> [MultiLanguage](MultiLanguage.md) | | [InteractionAffordance](InteractionAffordance.md) | +| [descriptions](descriptions.md) | * <br/> [MultiLanguage](MultiLanguage.md) | TODO, check, according to the description a description should not contain a ... | [InteractionAffordance](InteractionAffordance.md) | +| [title](title.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | Provides a human-readable title (e | [InteractionAffordance](InteractionAffordance.md) | +| [description](description.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | | [InteractionAffordance](InteractionAffordance.md) | +| [titleInLanguage](titleInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | [InteractionAffordance](InteractionAffordance.md) | +| [descriptionInLanguage](descriptionInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | [InteractionAffordance](InteractionAffordance.md) | +| [name](name.md) | 1 <br/> [String](String.md) | Indexing property to store entity names when serializing them in a JSON-LD @i... | [InteractionAffordance](InteractionAffordance.md) | +| [uriVariables](uriVariables.md) | * <br/> [DataSchema](DataSchema.md) | Define URI template variables according to RFC6570 as collection based on sch... | [InteractionAffordance](InteractionAffordance.md) | +| [forms](forms.md) | * <br/> [Form](Form.md) | Set of form hypermedia controls that describe how an operation can be perform... | [InteractionAffordance](InteractionAffordance.md) | + + + + + +## Usages + +| used by | used in | type | used | +| --- | --- | --- | --- | +| [Thing](Thing.md) | [events](events.md) | range | [EventAffordance](EventAffordance.md) | + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | td:EventAffordance | +| native | td:EventAffordance | + + + + + +## LinkML Source + +<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> + +### Direct + +<details> +```yaml +name: EventAffordance +description: An Interaction Affordance that describes an event source, which asynchronously + pushes event data to Consumers (e.g., overhearing alerts). +from_schema: td +rank: 1000 +is_a: InteractionAffordance +attributes: + subscription: + name: subscription + description: Defines data that needs to be passed upon subscription, e.g., filters + or message format for setting up Webhooks. + from_schema: td + rank: 1000 + domain_of: + - EventAffordance + range: DataSchema + cancellation: + name: cancellation + description: Defines any data that needs to be passed to cancel a subscription, + e.g., a specific message to remove a Webhook. + from_schema: td + rank: 1000 + domain_of: + - EventAffordance + range: DataSchema + notification: + name: notification + description: Defines the data schema of the Event instance messages pushed by + the Thing. + from_schema: td + rank: 1000 + domain_of: + - EventAffordance + range: DataSchema + notificationResponse: + name: notificationResponse + description: Defines the data schema of the Event response messages sent by the + consumer in a response to a data message. + from_schema: td + rank: 1000 + domain_of: + - EventAffordance + range: DataSchema +class_uri: td:EventAffordance + +``` +</details> + +### Induced + +<details> +```yaml +name: EventAffordance +description: An Interaction Affordance that describes an event source, which asynchronously + pushes event data to Consumers (e.g., overhearing alerts). +from_schema: td +rank: 1000 +is_a: InteractionAffordance +attributes: + subscription: + name: subscription + description: Defines data that needs to be passed upon subscription, e.g., filters + or message format for setting up Webhooks. + from_schema: td + rank: 1000 + alias: subscription + owner: EventAffordance + domain_of: + - EventAffordance + range: DataSchema + cancellation: + name: cancellation + description: Defines any data that needs to be passed to cancel a subscription, + e.g., a specific message to remove a Webhook. + from_schema: td + rank: 1000 + alias: cancellation + owner: EventAffordance + domain_of: + - EventAffordance + range: DataSchema + notification: + name: notification + description: Defines the data schema of the Event instance messages pushed by + the Thing. + from_schema: td + rank: 1000 + alias: notification + owner: EventAffordance + domain_of: + - EventAffordance + range: DataSchema + notificationResponse: + name: notificationResponse + description: Defines the data schema of the Event response messages sent by the + consumer in a response to a data message. + from_schema: td + rank: 1000 + alias: notificationResponse + owner: EventAffordance + domain_of: + - EventAffordance + range: DataSchema + titles: + name: titles + from_schema: td + rank: 1000 + multivalued: true + alias: titles + owner: EventAffordance + domain_of: + - InteractionAffordance + - Thing + range: MultiLanguage + inlined: true + descriptions: + name: descriptions + description: TODO, check, according to the description a description should not + contain a lang tag. + from_schema: td + rank: 1000 + multivalued: true + alias: descriptions + owner: EventAffordance + domain_of: + - SecurityScheme + - InteractionAffordance + - Thing + range: MultiLanguage + inlined: true + title: + name: title + description: Provides a human-readable title (e.g., display a text for UI representation) + based on a default language. + from_schema: td + rank: 1000 + slot_uri: td:title + alias: title + owner: EventAffordance + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + description: + name: description + from_schema: td + rank: 1000 + alias: description + owner: EventAffordance + domain_of: + - SecurityScheme + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + titleInLanguage: + name: titleInLanguage + description: title of the TD element (Thing, interaction affordance, security + scheme or data scheme) with language tag. By convention, a language tag must + be added to the object of descriptionInLanguage. Otherwise use description. + from_schema: td + rank: 1000 + alias: titleInLanguage + owner: EventAffordance + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + descriptionInLanguage: + name: descriptionInLanguage + description: description of the TD element (Thing, interaction affordance, security + scheme or data scheme) with language tag. By convention, a language tag must + be added to the object of descriptionInLanguage. Otherwise use description. + from_schema: td + rank: 1000 + alias: descriptionInLanguage + owner: EventAffordance + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + name: + name: name + description: Indexing property to store entity names when serializing them in + a JSON-LD @index container. + from_schema: td + rank: 1000 + identifier: true + alias: name + owner: EventAffordance + domain_of: + - InteractionAffordance + range: string + required: true + uriVariables: + name: uriVariables + description: 'Define URI template variables according to RFC6570 as collection + based on schema specifications. The individual variables DataSchema cannot be + an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.' + from_schema: td + rank: 1000 + multivalued: true + alias: uriVariables + owner: EventAffordance + domain_of: + - InteractionAffordance + range: DataSchema + forms: + name: forms + description: Set of form hypermedia controls that describe how an operation can + be performed. + from_schema: td + rank: 1000 + multivalued: true + alias: forms + owner: EventAffordance + domain_of: + - InteractionAffordance + - Thing + range: Form +class_uri: td:EventAffordance + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/ExpectedResponse.md b/resources/gens/docs/ExpectedResponse.md new file mode 100644 index 0000000..d1b14d7 --- /dev/null +++ b/resources/gens/docs/ExpectedResponse.md @@ -0,0 +1,143 @@ + + +# Class: ExpectedResponse + + +_Communication metadata describing the expected response message for the primary response._ + + + + + +URI: [hctl:ExpectedResponse](https://www.w3.org/2019/wot/hypermedia#ExpectedResponse) + + + + + + +```mermaid + classDiagram + class ExpectedResponse + click ExpectedResponse href "../ExpectedResponse" + ExpectedResponse <|-- AdditionalExpectedResponse + click AdditionalExpectedResponse href "../AdditionalExpectedResponse" + + ExpectedResponse : contentType + + +``` + + + + + +## Inheritance +* **ExpectedResponse** + * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) + + + +## Slots + +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [contentType](contentType.md) | 1 <br/> [String](String.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | direct | + + + + + +## Usages + +| used by | used in | type | used | +| --- | --- | --- | --- | +| [Form](Form.md) | [returns](returns.md) | range | [ExpectedResponse](ExpectedResponse.md) | + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | hctl:ExpectedResponse | +| native | td:ExpectedResponse | + + + + + +## LinkML Source + +<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> + +### Direct + +<details> +```yaml +name: ExpectedResponse +description: Communication metadata describing the expected response message for the + primary response. +from_schema: td +rank: 1000 +attributes: + contentType: + name: contentType + description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + from_schema: td + rank: 1000 + domain_of: + - ExpectedResponse + - Form + required: true +class_uri: hctl:ExpectedResponse + +``` +</details> + +### Induced + +<details> +```yaml +name: ExpectedResponse +description: Communication metadata describing the expected response message for the + primary response. +from_schema: td +rank: 1000 +attributes: + contentType: + name: contentType + description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + from_schema: td + rank: 1000 + alias: contentType + owner: ExpectedResponse + domain_of: + - ExpectedResponse + - Form + range: string + required: true +class_uri: hctl:ExpectedResponse + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/Float.md b/resources/gens/docs/Float.md new file mode 100644 index 0000000..86a2288 --- /dev/null +++ b/resources/gens/docs/Float.md @@ -0,0 +1,38 @@ +# Type: Float + + + + +_A real number that conforms to the xsd:float specification_ + + + +URI: [xsd:float](http://www.w3.org/2001/XMLSchema#float) + +* [base](https://w3id.org/linkml/base): float + +* [uri](https://w3id.org/linkml/uri): xsd:float + + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/Form.md b/resources/gens/docs/Form.md new file mode 100644 index 0000000..8543253 --- /dev/null +++ b/resources/gens/docs/Form.md @@ -0,0 +1,379 @@ + + +# Class: Form + + +_A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions._ + + + + + +URI: [hctl:Form](https://www.w3.org/2019/wot/hypermedia#Form) + + + + + + +```mermaid + classDiagram + class Form + click Form href "../Form" + Form : additionalReturns + + + + + Form --> "*" AdditionalExpectedResponse : additionalReturns + click AdditionalExpectedResponse href "../AdditionalExpectedResponse" + + + Form : contentCoding + + Form : contentType + + Form : href + + Form : operationType + + + + + Form --> "*" OperationTypes : operationType + click OperationTypes href "../OperationTypes" + + + Form : returns + + + + + Form --> "0..1" ExpectedResponse : returns + click ExpectedResponse href "../ExpectedResponse" + + + Form : scopes + + Form : securityDefinitions + + Form : subprotocol + + Form : target + + +``` + + + + +<!-- no inheritance hierarchy --> + + +## Slots + +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [target](target.md) | 1 <br/> [AnyUri](AnyUri.md) | Target IRI of a link or submission target of a Form | direct | +| [href](href.md) | 1 <br/> [AnyUri](AnyUri.md) | | direct | +| [contentType](contentType.md) | 0..1 <br/> [String](String.md) | Assign a content type based on a media type IANA-MEDIA-TYPES (e | direct | +| [contentCoding](contentCoding.md) | 0..1 <br/> [String](String.md) | Content coding values indicate an encoding transformation that has been or ca... | direct | +| [securityDefinitions](securityDefinitions.md) | 0..1 <br/> [String](String.md) | A security schema applied to a (set of) affordance(s) | direct | +| [scopes](scopes.md) | 0..1 <br/> [String](String.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | direct | +| [returns](returns.md) | 0..1 <br/> [ExpectedResponse](ExpectedResponse.md) | This optional term can be used if, e | direct | +| [additionalReturns](additionalReturns.md) | * <br/> [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | This optional term can be used if additional expected responses are possible,... | direct | +| [subprotocol](subprotocol.md) | 0..1 <br/> [String](String.md) | Indicates the exact mechanism by which an interaction will be accomplished fo... | direct | +| [operationType](operationType.md) | * <br/> [OperationTypes](OperationTypes.md) | Indicates the semantic intention of performing the operation(s) described by ... | direct | + + + + + +## Usages + +| used by | used in | type | used | +| --- | --- | --- | --- | +| [InteractionAffordance](InteractionAffordance.md) | [forms](forms.md) | range | [Form](Form.md) | +| [PropertyAffordance](PropertyAffordance.md) | [forms](forms.md) | range | [Form](Form.md) | +| [ActionAffordance](ActionAffordance.md) | [forms](forms.md) | range | [Form](Form.md) | +| [EventAffordance](EventAffordance.md) | [forms](forms.md) | range | [Form](Form.md) | +| [Thing](Thing.md) | [forms](forms.md) | range | [Form](Form.md) | + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | hctl:Form | +| native | td:Form | + + + + + +## LinkML Source + +<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> + +### Direct + +<details> +```yaml +name: Form +description: A form can be viewed as a statement of to perform an operation type on + form context, make a request method to submission target, where the optional form + fields may further describe the required request. In Thing Descriptions, the form + context is the surrounding Object, such as Properties, Actions, and Events or the + Thing itself for meta-interactions. +from_schema: td +rank: 1000 +slots: +- target +attributes: + href: + name: href + from_schema: td + rank: 1000 + domain_of: + - Form + range: anyUri + required: true + contentType: + name: contentType + description: Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., + 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media + type. + from_schema: td + domain_of: + - ExpectedResponse + - Form + contentCoding: + name: contentCoding + description: Content coding values indicate an encoding transformation that has + been or can be applied to a representation. Content codings are primarily used + to allow a representation to be compressed or otherwise usefully transformed without + losing the identity of its underlying media type and without loss of information. + Examples of content coding include \"gzip\", \"deflate\", etc. + from_schema: td + rank: 1000 + domain_of: + - Form + securityDefinitions: + name: securityDefinitions + description: A security schema applied to a (set of) affordance(s). + from_schema: td + rank: 1000 + domain_of: + - Form + - Thing + scopes: + name: scopes + description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + from_schema: td + rank: 1000 + domain_of: + - Form + returns: + name: returns + description: This optional term can be used if, e.g., the output communication + metadata differ from input metadata (e.g., output contentType differ from the + input contentType). The response name contains metadata that is only valid for + the response messages. + from_schema: td + rank: 1000 + domain_of: + - Form + range: ExpectedResponse + additionalReturns: + name: additionalReturns + description: This optional term can be used if additional expected responses are + possible, e.g. for error reporting. Each additional response needs to be distinguished + from others in some way (for example, by specifying a protocol-specific response + code), and may also have its own data schema. + from_schema: td + rank: 1000 + multivalued: true + domain_of: + - Form + range: AdditionalExpectedResponse + subprotocol: + name: subprotocol + description: Indicates the exact mechanism by which an interaction will be accomplished + for a given protocol when there are multiple options. + from_schema: td + rank: 1000 + domain_of: + - Form + operationType: + name: operationType + description: Indicates the semantic intention of performing the operation(s) described + by the form. + from_schema: td + rank: 1000 + multivalued: true + domain_of: + - Form + range: OperationTypes +class_uri: hctl:Form + +``` +</details> + +### Induced + +<details> +```yaml +name: Form +description: A form can be viewed as a statement of to perform an operation type on + form context, make a request method to submission target, where the optional form + fields may further describe the required request. In Thing Descriptions, the form + context is the surrounding Object, such as Properties, Actions, and Events or the + Thing itself for meta-interactions. +from_schema: td +rank: 1000 +attributes: + href: + name: href + from_schema: td + rank: 1000 + alias: href + owner: Form + domain_of: + - Form + range: anyUri + required: true + contentType: + name: contentType + description: Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., + 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media + type. + from_schema: td + alias: contentType + owner: Form + domain_of: + - ExpectedResponse + - Form + range: string + contentCoding: + name: contentCoding + description: Content coding values indicate an encoding transformation that has + been or can be applied to a representation. Content codings are primarily used + to allow a representation to be compressed or otherwise usefully transformed without + losing the identity of its underlying media type and without loss of information. + Examples of content coding include \"gzip\", \"deflate\", etc. + from_schema: td + rank: 1000 + alias: contentCoding + owner: Form + domain_of: + - Form + range: string + securityDefinitions: + name: securityDefinitions + description: A security schema applied to a (set of) affordance(s). + from_schema: td + rank: 1000 + alias: securityDefinitions + owner: Form + domain_of: + - Form + - Thing + range: string + scopes: + name: scopes + description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + from_schema: td + rank: 1000 + alias: scopes + owner: Form + domain_of: + - Form + range: string + returns: + name: returns + description: This optional term can be used if, e.g., the output communication + metadata differ from input metadata (e.g., output contentType differ from the + input contentType). The response name contains metadata that is only valid for + the response messages. + from_schema: td + rank: 1000 + alias: returns + owner: Form + domain_of: + - Form + range: ExpectedResponse + additionalReturns: + name: additionalReturns + description: This optional term can be used if additional expected responses are + possible, e.g. for error reporting. Each additional response needs to be distinguished + from others in some way (for example, by specifying a protocol-specific response + code), and may also have its own data schema. + from_schema: td + rank: 1000 + multivalued: true + alias: additionalReturns + owner: Form + domain_of: + - Form + range: AdditionalExpectedResponse + subprotocol: + name: subprotocol + description: Indicates the exact mechanism by which an interaction will be accomplished + for a given protocol when there are multiple options. + from_schema: td + rank: 1000 + alias: subprotocol + owner: Form + domain_of: + - Form + range: string + operationType: + name: operationType + description: Indicates the semantic intention of performing the operation(s) described + by the form. + from_schema: td + rank: 1000 + multivalued: true + alias: operationType + owner: Form + domain_of: + - Form + range: OperationTypes + target: + name: target + description: Target IRI of a link or submission target of a Form + from_schema: td + rank: 1000 + slot_uri: hctl:target + alias: target + owner: Form + domain_of: + - Link + - Form + range: anyUri + required: true +class_uri: hctl:Form + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/Integer.md b/resources/gens/docs/Integer.md new file mode 100644 index 0000000..5f18f94 --- /dev/null +++ b/resources/gens/docs/Integer.md @@ -0,0 +1,38 @@ +# Type: Integer + + + + +_An integer_ + + + +URI: [xsd:integer](http://www.w3.org/2001/XMLSchema#integer) + +* [base](https://w3id.org/linkml/base): int + +* [uri](https://w3id.org/linkml/uri): xsd:integer + + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/InteractionAffordance.md b/resources/gens/docs/InteractionAffordance.md new file mode 100644 index 0000000..5769ebb --- /dev/null +++ b/resources/gens/docs/InteractionAffordance.md @@ -0,0 +1,358 @@ + + +# Class: InteractionAffordance + + +_TOOD_ + + + + + +URI: [td:InteractionAffordance](https://www.w3.org/2019/wot/td#InteractionAffordance) + + + + + + +```mermaid + classDiagram + class InteractionAffordance + click InteractionAffordance href "../InteractionAffordance" + InteractionAffordance <|-- PropertyAffordance + click PropertyAffordance href "../PropertyAffordance" + InteractionAffordance <|-- ActionAffordance + click ActionAffordance href "../ActionAffordance" + InteractionAffordance <|-- EventAffordance + click EventAffordance href "../EventAffordance" + + InteractionAffordance : description + + + + + InteractionAffordance --> "0..1" MultiLanguage : description + click MultiLanguage href "../MultiLanguage" + + + InteractionAffordance : descriptionInLanguage + + + + + InteractionAffordance --> "0..1" MultiLanguage : descriptionInLanguage + click MultiLanguage href "../MultiLanguage" + + + InteractionAffordance : descriptions + + + + + InteractionAffordance --> "*" MultiLanguage : descriptions + click MultiLanguage href "../MultiLanguage" + + + InteractionAffordance : forms + + + + + InteractionAffordance --> "*" Form : forms + click Form href "../Form" + + + InteractionAffordance : name + + InteractionAffordance : title + + + + + InteractionAffordance --> "0..1" MultiLanguage : title + click MultiLanguage href "../MultiLanguage" + + + InteractionAffordance : titleInLanguage + + + + + InteractionAffordance --> "0..1" MultiLanguage : titleInLanguage + click MultiLanguage href "../MultiLanguage" + + + InteractionAffordance : titles + + + + + InteractionAffordance --> "*" MultiLanguage : titles + click MultiLanguage href "../MultiLanguage" + + + InteractionAffordance : uriVariables + + + + + InteractionAffordance --> "*" DataSchema : uriVariables + click DataSchema href "../DataSchema" + + + +``` + + + + + +## Inheritance +* **InteractionAffordance** + * [PropertyAffordance](PropertyAffordance.md) [ [DataSchema](DataSchema.md)] + * [ActionAffordance](ActionAffordance.md) + * [EventAffordance](EventAffordance.md) + + + +## Slots + +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [titles](titles.md) | * <br/> [MultiLanguage](MultiLanguage.md) | | direct | +| [descriptions](descriptions.md) | * <br/> [MultiLanguage](MultiLanguage.md) | TODO, check, according to the description a description should not contain a ... | direct | +| [title](title.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | Provides a human-readable title (e | direct | +| [description](description.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | | direct | +| [titleInLanguage](titleInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | direct | +| [descriptionInLanguage](descriptionInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | direct | +| [name](name.md) | 1 <br/> [String](String.md) | Indexing property to store entity names when serializing them in a JSON-LD @i... | direct | +| [uriVariables](uriVariables.md) | * <br/> [DataSchema](DataSchema.md) | Define URI template variables according to RFC6570 as collection based on sch... | direct | +| [forms](forms.md) | * <br/> [Form](Form.md) | Set of form hypermedia controls that describe how an operation can be perform... | direct | + + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | td:InteractionAffordance | +| native | td:InteractionAffordance | + + + + + +## LinkML Source + +<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> + +### Direct + +<details> +```yaml +name: InteractionAffordance +description: TOOD +from_schema: td +rank: 1000 +slots: +- titles +- descriptions +- title +- description +- titleInLanguage +- descriptionInLanguage +attributes: + name: + name: name + description: Indexing property to store entity names when serializing them in + a JSON-LD @index container. + from_schema: td + rank: 1000 + identifier: true + domain_of: + - InteractionAffordance + required: true + uriVariables: + name: uriVariables + description: 'Define URI template variables according to RFC6570 as collection + based on schema specifications. The individual variables DataSchema cannot be + an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.' + from_schema: td + rank: 1000 + multivalued: true + domain_of: + - InteractionAffordance + range: DataSchema + forms: + name: forms + description: Set of form hypermedia controls that describe how an operation can + be performed. + from_schema: td + rank: 1000 + multivalued: true + domain_of: + - InteractionAffordance + - Thing + range: Form +class_uri: td:InteractionAffordance + +``` +</details> + +### Induced + +<details> +```yaml +name: InteractionAffordance +description: TOOD +from_schema: td +rank: 1000 +attributes: + name: + name: name + description: Indexing property to store entity names when serializing them in + a JSON-LD @index container. + from_schema: td + rank: 1000 + identifier: true + alias: name + owner: InteractionAffordance + domain_of: + - InteractionAffordance + range: string + required: true + uriVariables: + name: uriVariables + description: 'Define URI template variables according to RFC6570 as collection + based on schema specifications. The individual variables DataSchema cannot be + an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.' + from_schema: td + rank: 1000 + multivalued: true + alias: uriVariables + owner: InteractionAffordance + domain_of: + - InteractionAffordance + range: DataSchema + forms: + name: forms + description: Set of form hypermedia controls that describe how an operation can + be performed. + from_schema: td + rank: 1000 + multivalued: true + alias: forms + owner: InteractionAffordance + domain_of: + - InteractionAffordance + - Thing + range: Form + titles: + name: titles + from_schema: td + rank: 1000 + multivalued: true + alias: titles + owner: InteractionAffordance + domain_of: + - InteractionAffordance + - Thing + range: MultiLanguage + inlined: true + descriptions: + name: descriptions + description: TODO, check, according to the description a description should not + contain a lang tag. + from_schema: td + rank: 1000 + multivalued: true + alias: descriptions + owner: InteractionAffordance + domain_of: + - SecurityScheme + - InteractionAffordance + - Thing + range: MultiLanguage + inlined: true + title: + name: title + description: Provides a human-readable title (e.g., display a text for UI representation) + based on a default language. + from_schema: td + rank: 1000 + slot_uri: td:title + alias: title + owner: InteractionAffordance + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + description: + name: description + from_schema: td + rank: 1000 + alias: description + owner: InteractionAffordance + domain_of: + - SecurityScheme + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + titleInLanguage: + name: titleInLanguage + description: title of the TD element (Thing, interaction affordance, security + scheme or data scheme) with language tag. By convention, a language tag must + be added to the object of descriptionInLanguage. Otherwise use description. + from_schema: td + rank: 1000 + alias: titleInLanguage + owner: InteractionAffordance + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + descriptionInLanguage: + name: descriptionInLanguage + description: description of the TD element (Thing, interaction affordance, security + scheme or data scheme) with language tag. By convention, a language tag must + be added to the object of descriptionInLanguage. Otherwise use description. + from_schema: td + rank: 1000 + alias: descriptionInLanguage + owner: InteractionAffordance + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage +class_uri: td:InteractionAffordance + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/Jsonpath.md b/resources/gens/docs/Jsonpath.md new file mode 100644 index 0000000..17af831 --- /dev/null +++ b/resources/gens/docs/Jsonpath.md @@ -0,0 +1,39 @@ +# Type: Jsonpath + + + + +_A string encoding a JSON Path. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded in tree form._ + + + +URI: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +* [base](https://w3id.org/linkml/base): str + +* [uri](https://w3id.org/linkml/uri): xsd:string + +* [repr](https://w3id.org/linkml/repr): str + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/Jsonpointer.md b/resources/gens/docs/Jsonpointer.md new file mode 100644 index 0000000..7280725 --- /dev/null +++ b/resources/gens/docs/Jsonpointer.md @@ -0,0 +1,39 @@ +# Type: Jsonpointer + + + + +_A string encoding a JSON Pointer. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to a valid object within the current instance document when encoded in tree form._ + + + +URI: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +* [base](https://w3id.org/linkml/base): str + +* [uri](https://w3id.org/linkml/uri): xsd:string + +* [repr](https://w3id.org/linkml/repr): str + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/Link.md b/resources/gens/docs/Link.md new file mode 100644 index 0000000..8233eee --- /dev/null +++ b/resources/gens/docs/Link.md @@ -0,0 +1,265 @@ + + +# Class: Link + + +_A link can be viewed as a statement of the form link context that has a relation type resource at link target", where the optional target attributes may further describe the resource._ + + + + + +URI: [hctl:Link](https://www.w3.org/2019/wot/hypermedia#Link) + + + + + + +```mermaid + classDiagram + class Link + click Link href "../Link" + Link : anchor + + Link : hintsAtMediaType + + Link : hreflang + + Link : relation + + Link : sizes + + Link : target + + Link : type + + +``` + + + + +<!-- no inheritance hierarchy --> + + +## Slots + +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [target](target.md) | 1 <br/> [AnyUri](AnyUri.md) | Target IRI of a link or submission target of a Form | direct | +| [hintsAtMediaType](hintsAtMediaType.md) | 0..1 <br/> [String](String.md) | Target attribute providing a hint indicating what the media type [IANA-MEDIA-... | direct | +| [type](type.md) | 0..1 <br/> [String](String.md) | | direct | +| [relation](relation.md) | 0..1 <br/> [String](String.md) | A link relation type identifies the semantics of a link | direct | +| [anchor](anchor.md) | 0..1 <br/> [AnyUri](AnyUri.md) | By default, the context, or anchor, of a link conveyed in the Link header fie... | direct | +| [sizes](sizes.md) | 0..1 <br/> [String](String.md) | Target attribute that specifies one or more sizes for the referenced icon | direct | +| [hreflang](hreflang.md) | 0..1 <br/> [String](String.md) | The hreflang attribute specifies the language of a linked document | direct | + + + + + +## Usages + +| used by | used in | type | used | +| --- | --- | --- | --- | +| [Thing](Thing.md) | [links](links.md) | range | [Link](Link.md) | + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | hctl:Link | +| native | td:Link | + + + + + +## LinkML Source + +<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> + +### Direct + +<details> +```yaml +name: Link +description: A link can be viewed as a statement of the form link context that has + a relation type resource at link target", where the optional target attributes may + further describe the resource. +from_schema: td +rank: 1000 +slots: +- target +attributes: + hintsAtMediaType: + name: hintsAtMediaType + description: Target attribute providing a hint indicating what the media type + [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. + from_schema: td + rank: 1000 + domain_of: + - Link + type: + name: type + from_schema: td + rank: 1000 + domain_of: + - Link + relation: + name: relation + description: A link relation type identifies the semantics of a link. + from_schema: td + rank: 1000 + domain_of: + - Link + anchor: + name: anchor + description: By default, the context, or anchor, of a link conveyed in the Link + header field is the URL of the representation it is associated with, as defined + in RFC7231, Section 3.1.4.1, and is serialized as a URI. + from_schema: td + rank: 1000 + domain_of: + - Link + range: anyUri + sizes: + name: sizes + description: Target attribute that specifies one or more sizes for the referenced + icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} + (e.g., \"16x16\", \"16x16 32x32\"). + from_schema: td + rank: 1000 + domain_of: + - Link + hreflang: + name: hreflang + description: The hreflang attribute specifies the language of a linked document. + The value of this must be a valid language tag [[BCP47]]. + from_schema: td + rank: 1000 + domain_of: + - Link + pattern: ^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ +class_uri: hctl:Link + +``` +</details> + +### Induced + +<details> +```yaml +name: Link +description: A link can be viewed as a statement of the form link context that has + a relation type resource at link target", where the optional target attributes may + further describe the resource. +from_schema: td +rank: 1000 +attributes: + hintsAtMediaType: + name: hintsAtMediaType + description: Target attribute providing a hint indicating what the media type + [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. + from_schema: td + rank: 1000 + alias: hintsAtMediaType + owner: Link + domain_of: + - Link + range: string + type: + name: type + from_schema: td + rank: 1000 + alias: type + owner: Link + domain_of: + - Link + range: string + relation: + name: relation + description: A link relation type identifies the semantics of a link. + from_schema: td + rank: 1000 + alias: relation + owner: Link + domain_of: + - Link + range: string + anchor: + name: anchor + description: By default, the context, or anchor, of a link conveyed in the Link + header field is the URL of the representation it is associated with, as defined + in RFC7231, Section 3.1.4.1, and is serialized as a URI. + from_schema: td + rank: 1000 + alias: anchor + owner: Link + domain_of: + - Link + range: anyUri + sizes: + name: sizes + description: Target attribute that specifies one or more sizes for the referenced + icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} + (e.g., \"16x16\", \"16x16 32x32\"). + from_schema: td + rank: 1000 + alias: sizes + owner: Link + domain_of: + - Link + range: string + hreflang: + name: hreflang + description: The hreflang attribute specifies the language of a linked document. + The value of this must be a valid language tag [[BCP47]]. + from_schema: td + rank: 1000 + alias: hreflang + owner: Link + domain_of: + - Link + range: string + pattern: ^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ + target: + name: target + description: Target IRI of a link or submission target of a Form + from_schema: td + rank: 1000 + slot_uri: hctl:target + alias: target + owner: Link + domain_of: + - Link + - Form + range: anyUri + required: true +class_uri: hctl:Link + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/MultiLanguage.md b/resources/gens/docs/MultiLanguage.md new file mode 100644 index 0000000..976fbc5 --- /dev/null +++ b/resources/gens/docs/MultiLanguage.md @@ -0,0 +1,159 @@ + + +# Class: MultiLanguage + + + +URI: [td:MultiLanguage](https://www.w3.org/2019/wot/td#MultiLanguage) + + + + + + +```mermaid + classDiagram + class MultiLanguage + click MultiLanguage href "../MultiLanguage" + MultiLanguage : key + + +``` + + + + +<!-- no inheritance hierarchy --> + + +## Slots + +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [key](key.md) | 1 <br/> [String](String.md) | | direct | + + + + + +## Usages + +| used by | used in | type | used | +| --- | --- | --- | --- | +| [SecurityScheme](SecurityScheme.md) | [descriptions](descriptions.md) | range | [MultiLanguage](MultiLanguage.md) | +| [DataSchema](DataSchema.md) | [description](description.md) | range | [MultiLanguage](MultiLanguage.md) | +| [DataSchema](DataSchema.md) | [title](title.md) | range | [MultiLanguage](MultiLanguage.md) | +| [DataSchema](DataSchema.md) | [titleInLanguage](titleInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | +| [DataSchema](DataSchema.md) | [descriptionInLanguage](descriptionInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | +| [InteractionAffordance](InteractionAffordance.md) | [titles](titles.md) | range | [MultiLanguage](MultiLanguage.md) | +| [InteractionAffordance](InteractionAffordance.md) | [descriptions](descriptions.md) | range | [MultiLanguage](MultiLanguage.md) | +| [InteractionAffordance](InteractionAffordance.md) | [title](title.md) | range | [MultiLanguage](MultiLanguage.md) | +| [InteractionAffordance](InteractionAffordance.md) | [description](description.md) | range | [MultiLanguage](MultiLanguage.md) | +| [InteractionAffordance](InteractionAffordance.md) | [titleInLanguage](titleInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | +| [InteractionAffordance](InteractionAffordance.md) | [descriptionInLanguage](descriptionInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | +| [PropertyAffordance](PropertyAffordance.md) | [description](description.md) | range | [MultiLanguage](MultiLanguage.md) | +| [PropertyAffordance](PropertyAffordance.md) | [title](title.md) | range | [MultiLanguage](MultiLanguage.md) | +| [PropertyAffordance](PropertyAffordance.md) | [titleInLanguage](titleInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | +| [PropertyAffordance](PropertyAffordance.md) | [descriptionInLanguage](descriptionInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | +| [PropertyAffordance](PropertyAffordance.md) | [titles](titles.md) | range | [MultiLanguage](MultiLanguage.md) | +| [PropertyAffordance](PropertyAffordance.md) | [descriptions](descriptions.md) | range | [MultiLanguage](MultiLanguage.md) | +| [ActionAffordance](ActionAffordance.md) | [titles](titles.md) | range | [MultiLanguage](MultiLanguage.md) | +| [ActionAffordance](ActionAffordance.md) | [descriptions](descriptions.md) | range | [MultiLanguage](MultiLanguage.md) | +| [ActionAffordance](ActionAffordance.md) | [title](title.md) | range | [MultiLanguage](MultiLanguage.md) | +| [ActionAffordance](ActionAffordance.md) | [description](description.md) | range | [MultiLanguage](MultiLanguage.md) | +| [ActionAffordance](ActionAffordance.md) | [titleInLanguage](titleInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | +| [ActionAffordance](ActionAffordance.md) | [descriptionInLanguage](descriptionInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | +| [EventAffordance](EventAffordance.md) | [titles](titles.md) | range | [MultiLanguage](MultiLanguage.md) | +| [EventAffordance](EventAffordance.md) | [descriptions](descriptions.md) | range | [MultiLanguage](MultiLanguage.md) | +| [EventAffordance](EventAffordance.md) | [title](title.md) | range | [MultiLanguage](MultiLanguage.md) | +| [EventAffordance](EventAffordance.md) | [description](description.md) | range | [MultiLanguage](MultiLanguage.md) | +| [EventAffordance](EventAffordance.md) | [titleInLanguage](titleInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | +| [EventAffordance](EventAffordance.md) | [descriptionInLanguage](descriptionInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | +| [Thing](Thing.md) | [title](title.md) | range | [MultiLanguage](MultiLanguage.md) | +| [Thing](Thing.md) | [description](description.md) | range | [MultiLanguage](MultiLanguage.md) | +| [Thing](Thing.md) | [titles](titles.md) | range | [MultiLanguage](MultiLanguage.md) | +| [Thing](Thing.md) | [descriptions](descriptions.md) | range | [MultiLanguage](MultiLanguage.md) | +| [Thing](Thing.md) | [titleInLanguage](titleInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | +| [Thing](Thing.md) | [descriptionInLanguage](descriptionInLanguage.md) | range | [MultiLanguage](MultiLanguage.md) | + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | td:MultiLanguage | +| native | td:MultiLanguage | + + + + + +## LinkML Source + +<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> + +### Direct + +<details> +```yaml +name: MultiLanguage +from_schema: td +rank: 1000 +attributes: + key: + name: key + from_schema: td + rank: 1000 + identifier: true + domain_of: + - MultiLanguage + required: true + pattern: ^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ + +``` +</details> + +### Induced + +<details> +```yaml +name: MultiLanguage +from_schema: td +rank: 1000 +attributes: + key: + name: key + from_schema: td + rank: 1000 + identifier: true + alias: key + owner: MultiLanguage + domain_of: + - MultiLanguage + range: string + required: true + pattern: ^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/Ncname.md b/resources/gens/docs/Ncname.md new file mode 100644 index 0000000..9e4032e --- /dev/null +++ b/resources/gens/docs/Ncname.md @@ -0,0 +1,39 @@ +# Type: Ncname + + + + +_Prefix part of CURIE_ + + + +URI: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +* [base](https://w3id.org/linkml/base): NCName + +* [uri](https://w3id.org/linkml/uri): xsd:string + +* [repr](https://w3id.org/linkml/repr): str + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/Nodeidentifier.md b/resources/gens/docs/Nodeidentifier.md new file mode 100644 index 0000000..bce8d34 --- /dev/null +++ b/resources/gens/docs/Nodeidentifier.md @@ -0,0 +1,39 @@ +# Type: Nodeidentifier + + + + +_A URI, CURIE or BNODE that represents a node in a model._ + + + +URI: [shex:nonLiteral](http://www.w3.org/ns/shex#nonLiteral) + +* [base](https://w3id.org/linkml/base): NodeIdentifier + +* [uri](https://w3id.org/linkml/uri): shex:nonLiteral + +* [repr](https://w3id.org/linkml/repr): str + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/Objectidentifier.md b/resources/gens/docs/Objectidentifier.md new file mode 100644 index 0000000..50423e5 --- /dev/null +++ b/resources/gens/docs/Objectidentifier.md @@ -0,0 +1,43 @@ +# Type: Objectidentifier + + + + +_A URI or CURIE that represents an object in the model._ + + + +URI: [shex:iri](http://www.w3.org/ns/shex#iri) + +* [base](https://w3id.org/linkml/base): ElementIdentifier + +* [uri](https://w3id.org/linkml/uri): shex:iri + +* [repr](https://w3id.org/linkml/repr): str + + + + + + + + +## Comments + +* Used for inheritance and type checking + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/OperationTypes.md b/resources/gens/docs/OperationTypes.md new file mode 100644 index 0000000..91a1b25 --- /dev/null +++ b/resources/gens/docs/OperationTypes.md @@ -0,0 +1,167 @@ +# Enum: OperationTypes + + + + +_Enumerations of well-known operation types necessary to implement the WoT interaction model._ + + + +URI: [OperationTypes](OperationTypes.md) + +## Permissible Values + +| Value | Meaning | Description | +| --- | --- | --- | +| readproperty | td:readProperty | Identifies the read operation on Property Affordances to retrieve the corresp... | +| writeproperty | td:writeProperty | Identifies the write operation on Property Affordances to update the correspo... | +| observeproperty | td:observeProperty | Identifies the observe operation on Property Affordances to be notified with ... | +| unobserveproperty | td:unobserveProperty | Identifies the unobserve operation on Property Affordances to stop the corres... | +| invokeaction | td:invokeAction | Identifies the invoke operation on Action Affordances to perform the correspo... | +| queryaction | td:queryAction | Identifies the querying operation on Action Affordances to get the status of ... | +| cancelaction | td:cancelAction | Identifies the cancel operation on Action Affordances to cancel the ongoing c... | +| subscribeevent | td:subscribeEvent | Identifies the subscribe operation on Event Affordances to be notified by the... | +| unsubscribeevent | td:unsubscribeEvent | Identifies the unsubscribe operation on Event Affordances to stop the corresp... | +| readallproperties | td:readAllProperties | Identifies the readallproperties operation on a Thing to retrieve the data of... | +| writeallproperties | writeAllProperties | Identifies the writeallproperties operation on a Thing to update the data of ... | +| readmultipleproperties | td:readMultipleProperties | Identifies the readmultipleproperties operation on a Thing to retrieve the da... | +| writemultipleproperties | td:writeMultipleProperties | Identifies the writemultipleproperties operation on a Thing to update the dat... | +| observeallproperties | td:observeAllProperties | Identifies the observeallproperties operation on Properties to be notified wi... | +| unobserveallproperties | td:unobserveAllProperties | Identifies the unobserveallproperties operation on Properties to stop notific... | +| subscribeallevents | td:subscribeAllEvents | Identifies the subscribeallevents operation on Events to subscribe to notific... | +| unsubscribeallevents | td:unsubscribeAllEvents | Identifies the unsubscribeallevents operation on Events to unsubscribe from n... | +| queryallactions | td:queryAllActions | Identifies the queryallactions operation on a Thing to get the status of all ... | + + + + +## Slots + +| Name | Description | +| --- | --- | +| [operationType](operationType.md) | Indicates the semantic intention of performing the operation(s) described by ... | + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: OperationTypes +description: Enumerations of well-known operation types necessary to implement the + WoT interaction model. +from_schema: td +rank: 1000 +permissible_values: + readproperty: + text: readproperty + description: Identifies the read operation on Property Affordances to retrieve + the corresponding data. + meaning: td:readProperty + writeproperty: + text: writeproperty + description: Identifies the write operation on Property Affordances to update + the corresponding data. + meaning: td:writeProperty + observeproperty: + text: observeproperty + description: Identifies the observe operation on Property Affordances to be notified + with the new data when the Property is updated. + meaning: td:observeProperty + unobserveproperty: + text: unobserveproperty + description: Identifies the unobserve operation on Property Affordances to stop + the corresponding notifications. + meaning: td:unobserveProperty + invokeaction: + text: invokeaction + description: Identifies the invoke operation on Action Affordances to perform + the corresponding action. + meaning: td:invokeAction + queryaction: + text: queryaction + description: Identifies the querying operation on Action Affordances to get the + status of the corresponding action. + meaning: td:queryAction + cancelaction: + text: cancelaction + description: Identifies the cancel operation on Action Affordances to cancel the + ongoing corresponding action. + meaning: td:cancelAction + subscribeevent: + text: subscribeevent + description: Identifies the subscribe operation on Event Affordances to be notified + by the Thing when the event occurs. + meaning: td:subscribeEvent + unsubscribeevent: + text: unsubscribeevent + description: Identifies the unsubscribe operation on Event Affordances to stop + the corresponding notifications. + meaning: td:unsubscribeEvent + readallproperties: + text: readallproperties + description: Identifies the readallproperties operation on a Thing to retrieve + the data of all Properties in a single interaction. + meaning: td:readAllProperties + writeallproperties: + text: writeallproperties + description: Identifies the writeallproperties operation on a Thing to update + the data of all writable Properties in a single interaction. + meaning: writeAllProperties + readmultipleproperties: + text: readmultipleproperties + description: Identifies the readmultipleproperties operation on a Thing to retrieve + the data of selected Properties in a single interaction. + meaning: td:readMultipleProperties + writemultipleproperties: + text: writemultipleproperties + description: Identifies the writemultipleproperties operation on a Thing to update + the data of selected writable Properties in a single interaction. + meaning: td:writeMultipleProperties + observeallproperties: + text: observeallproperties + description: Identifies the observeallproperties operation on Properties to be + notified with new data when any Property is updated. + meaning: td:observeAllProperties + unobserveallproperties: + text: unobserveallproperties + description: Identifies the unobserveallproperties operation on Properties to + stop notifications from all Properties in a single interaction. + meaning: td:unobserveAllProperties + subscribeallevents: + text: subscribeallevents + description: Identifies the subscribeallevents operation on Events to subscribe + to notifications from all Events in a single interaction. + meaning: td:subscribeAllEvents + unsubscribeallevents: + text: unsubscribeallevents + description: Identifies the unsubscribeallevents operation on Events to unsubscribe + from notifications from all Events in a single interaction. + meaning: td:unsubscribeAllEvents + queryallactions: + text: queryallactions + description: Identifies the queryallactions operation on a Thing to get the status + of all Actions in a single interaction. + meaning: td:queryAllActions + +``` +</details> diff --git a/resources/gens/docs/PropertyAffordance.md b/resources/gens/docs/PropertyAffordance.md new file mode 100644 index 0000000..ac0201e --- /dev/null +++ b/resources/gens/docs/PropertyAffordance.md @@ -0,0 +1,397 @@ + + +# Class: PropertyAffordance + + +_An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated._ + + + + + +URI: [td:PropertyAffordance](https://www.w3.org/2019/wot/td#PropertyAffordance) + + + + + + +```mermaid + classDiagram + class PropertyAffordance + click PropertyAffordance href "../PropertyAffordance" + DataSchema <|-- PropertyAffordance + click DataSchema href "../DataSchema" + InteractionAffordance <|-- PropertyAffordance + click InteractionAffordance href "../InteractionAffordance" + + PropertyAffordance : description + + + + + PropertyAffordance --> "0..1" MultiLanguage : description + click MultiLanguage href "../MultiLanguage" + + + PropertyAffordance : descriptionInLanguage + + + + + PropertyAffordance --> "0..1" MultiLanguage : descriptionInLanguage + click MultiLanguage href "../MultiLanguage" + + + PropertyAffordance : descriptions + + + + + PropertyAffordance --> "*" MultiLanguage : descriptions + click MultiLanguage href "../MultiLanguage" + + + PropertyAffordance : forms + + + + + PropertyAffordance --> "*" Form : forms + click Form href "../Form" + + + PropertyAffordance : name + + PropertyAffordance : observable + + PropertyAffordance : propertyName + + PropertyAffordance : readonly + + PropertyAffordance : title + + + + + PropertyAffordance --> "0..1" MultiLanguage : title + click MultiLanguage href "../MultiLanguage" + + + PropertyAffordance : titleInLanguage + + + + + PropertyAffordance --> "0..1" MultiLanguage : titleInLanguage + click MultiLanguage href "../MultiLanguage" + + + PropertyAffordance : titles + + + + + PropertyAffordance --> "*" MultiLanguage : titles + click MultiLanguage href "../MultiLanguage" + + + PropertyAffordance : uriVariables + + + + + PropertyAffordance --> "*" DataSchema : uriVariables + click DataSchema href "../DataSchema" + + + PropertyAffordance : writeOnly + + +``` + + + + + +## Inheritance +* [InteractionAffordance](InteractionAffordance.md) + * **PropertyAffordance** [ [DataSchema](DataSchema.md)] + + + +## Slots + +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [observable](observable.md) | 0..1 <br/> [Boolean](Boolean.md) | A hint that indicates whether Servients hosting the Thing and Intermediaries ... | direct | +| [description](description.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | | [DataSchema](DataSchema.md), [InteractionAffordance](InteractionAffordance.md) | +| [title](title.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | Provides a human-readable title (e | [DataSchema](DataSchema.md), [InteractionAffordance](InteractionAffordance.md) | +| [titleInLanguage](titleInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | [DataSchema](DataSchema.md), [InteractionAffordance](InteractionAffordance.md) | +| [descriptionInLanguage](descriptionInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | [DataSchema](DataSchema.md), [InteractionAffordance](InteractionAffordance.md) | +| [propertyName](propertyName.md) | 0..1 <br/> [String](String.md) | Used to store the indexing name in the parent object when this schema appears... | [DataSchema](DataSchema.md) | +| [writeOnly](writeOnly.md) | 0..1 <br/> [String](String.md) | Boolean value that is a hint to indicate whether a property interaction/value... | [DataSchema](DataSchema.md) | +| [readonly](readonly.md) | 0..1 <br/> [String](String.md) | Boolean value that is a hint to indicate whether a property interaction/value... | [DataSchema](DataSchema.md) | +| [titles](titles.md) | * <br/> [MultiLanguage](MultiLanguage.md) | | [InteractionAffordance](InteractionAffordance.md) | +| [descriptions](descriptions.md) | * <br/> [MultiLanguage](MultiLanguage.md) | TODO, check, according to the description a description should not contain a ... | [InteractionAffordance](InteractionAffordance.md) | +| [name](name.md) | 1 <br/> [String](String.md) | Indexing property to store entity names when serializing them in a JSON-LD @i... | [InteractionAffordance](InteractionAffordance.md) | +| [uriVariables](uriVariables.md) | * <br/> [DataSchema](DataSchema.md) | Define URI template variables according to RFC6570 as collection based on sch... | [InteractionAffordance](InteractionAffordance.md) | +| [forms](forms.md) | * <br/> [Form](Form.md) | Set of form hypermedia controls that describe how an operation can be perform... | [InteractionAffordance](InteractionAffordance.md) | + + + + + +## Usages + +| used by | used in | type | used | +| --- | --- | --- | --- | +| [Thing](Thing.md) | [properties](properties.md) | range | [PropertyAffordance](PropertyAffordance.md) | + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | td:PropertyAffordance | +| native | td:PropertyAffordance | + + + + + +## LinkML Source + +<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> + +### Direct + +<details> +```yaml +name: PropertyAffordance +description: An Interaction Affordance that exposes state of the Thing. This state + can be retrieved (read) and/or updated. +from_schema: td +rank: 1000 +is_a: InteractionAffordance +mixins: +- DataSchema +attributes: + observable: + name: observable + description: A hint that indicates whether Servients hosting the Thing and Intermediaries + should probide a Protocol Binding that supports the observeproperty and unobserveproperty + operations for this Property. + from_schema: td + rank: 1000 + domain_of: + - PropertyAffordance + range: boolean +class_uri: td:PropertyAffordance + +``` +</details> + +### Induced + +<details> +```yaml +name: PropertyAffordance +description: An Interaction Affordance that exposes state of the Thing. This state + can be retrieved (read) and/or updated. +from_schema: td +rank: 1000 +is_a: InteractionAffordance +mixins: +- DataSchema +attributes: + observable: + name: observable + description: A hint that indicates whether Servients hosting the Thing and Intermediaries + should probide a Protocol Binding that supports the observeproperty and unobserveproperty + operations for this Property. + from_schema: td + rank: 1000 + alias: observable + owner: PropertyAffordance + domain_of: + - PropertyAffordance + range: boolean + description: + name: description + from_schema: td + rank: 1000 + alias: description + owner: PropertyAffordance + domain_of: + - SecurityScheme + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + title: + name: title + description: Provides a human-readable title (e.g., display a text for UI representation) + based on a default language. + from_schema: td + rank: 1000 + slot_uri: td:title + alias: title + owner: PropertyAffordance + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + titleInLanguage: + name: titleInLanguage + description: title of the TD element (Thing, interaction affordance, security + scheme or data scheme) with language tag. By convention, a language tag must + be added to the object of descriptionInLanguage. Otherwise use description. + from_schema: td + rank: 1000 + alias: titleInLanguage + owner: PropertyAffordance + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + descriptionInLanguage: + name: descriptionInLanguage + description: description of the TD element (Thing, interaction affordance, security + scheme or data scheme) with language tag. By convention, a language tag must + be added to the object of descriptionInLanguage. Otherwise use description. + from_schema: td + rank: 1000 + alias: descriptionInLanguage + owner: PropertyAffordance + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + propertyName: + name: propertyName + description: Used to store the indexing name in the parent object when this schema + appears as a property of an object schema. + from_schema: td + rank: 1000 + alias: propertyName + owner: PropertyAffordance + domain_of: + - DataSchema + range: string + writeOnly: + name: writeOnly + description: Boolean value that is a hint to indicate whether a property interaction/value + is write only (=true) or not (=false). + from_schema: td + rank: 1000 + alias: writeOnly + owner: PropertyAffordance + domain_of: + - DataSchema + range: string + readonly: + name: readonly + description: Boolean value that is a hint to indicate whether a property interaction/value + is read only (=true) or not (=false). + from_schema: td + rank: 1000 + alias: readonly + owner: PropertyAffordance + domain_of: + - DataSchema + range: string + titles: + name: titles + from_schema: td + rank: 1000 + multivalued: true + alias: titles + owner: PropertyAffordance + domain_of: + - InteractionAffordance + - Thing + range: MultiLanguage + inlined: true + descriptions: + name: descriptions + description: TODO, check, according to the description a description should not + contain a lang tag. + from_schema: td + rank: 1000 + multivalued: true + alias: descriptions + owner: PropertyAffordance + domain_of: + - SecurityScheme + - InteractionAffordance + - Thing + range: MultiLanguage + inlined: true + name: + name: name + description: Indexing property to store entity names when serializing them in + a JSON-LD @index container. + from_schema: td + rank: 1000 + identifier: true + alias: name + owner: PropertyAffordance + domain_of: + - InteractionAffordance + range: string + required: true + uriVariables: + name: uriVariables + description: 'Define URI template variables according to RFC6570 as collection + based on schema specifications. The individual variables DataSchema cannot be + an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.' + from_schema: td + rank: 1000 + multivalued: true + alias: uriVariables + owner: PropertyAffordance + domain_of: + - InteractionAffordance + range: DataSchema + forms: + name: forms + description: Set of form hypermedia controls that describe how an operation can + be performed. + from_schema: td + rank: 1000 + multivalued: true + alias: forms + owner: PropertyAffordance + domain_of: + - InteractionAffordance + - Thing + range: Form +class_uri: td:PropertyAffordance + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/SecurityScheme.md b/resources/gens/docs/SecurityScheme.md new file mode 100644 index 0000000..5dc0094 --- /dev/null +++ b/resources/gens/docs/SecurityScheme.md @@ -0,0 +1,209 @@ + + +# Class: SecurityScheme + + + +URI: [td:SecurityScheme](https://www.w3.org/2019/wot/td#SecurityScheme) + + + + + + +```mermaid + classDiagram + class SecurityScheme + click SecurityScheme href "../SecurityScheme" + SecurityScheme : @type + + SecurityScheme : description + + SecurityScheme : descriptions + + + + + SecurityScheme --> "*" MultiLanguage : descriptions + click MultiLanguage href "../MultiLanguage" + + + SecurityScheme : proxy + + SecurityScheme : scheme + + + + + SecurityScheme --> "1" SecuritySchemeType : scheme + click SecuritySchemeType href "../SecuritySchemeType" + + + +``` + + + + +<!-- no inheritance hierarchy --> + + +## Slots + +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [@type](@type.md) | * <br/> [String](String.md) | | direct | +| [descriptions](descriptions.md) | * <br/> [MultiLanguage](MultiLanguage.md) | TODO, check, according to the description a description should not contain a ... | direct | +| [description](description.md) | 0..1 <br/> [String](String.md) | | direct | +| [proxy](proxy.md) | 0..1 <br/> [AnyUri](AnyUri.md) | URI of the proxy server this security configuration provides access to | direct | +| [scheme](scheme.md) | 1 <br/> [SecuritySchemeType](SecuritySchemeType.md) | | direct | + + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | td:SecurityScheme | +| native | td:SecurityScheme | + + + + + +## LinkML Source + +<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> + +### Direct + +<details> +```yaml +name: SecurityScheme +from_schema: td +rank: 1000 +slots: +- '@type' +- descriptions +attributes: + description: + name: description + from_schema: td + domain_of: + - SecurityScheme + - DataSchema + - InteractionAffordance + - Thing + proxy: + name: proxy + description: URI of the proxy server this security configuration provides access + to. If not given, the corresponding security configuration is for the endpoint. + from_schema: td + rank: 1000 + domain_of: + - SecurityScheme + range: anyUri + scheme: + name: scheme + from_schema: td + rank: 1000 + domain_of: + - SecurityScheme + range: SecuritySchemeType + required: true + +``` +</details> + +### Induced + +<details> +```yaml +name: SecurityScheme +from_schema: td +rank: 1000 +attributes: + description: + name: description + from_schema: td + alias: description + owner: SecurityScheme + domain_of: + - SecurityScheme + - DataSchema + - InteractionAffordance + - Thing + range: string + proxy: + name: proxy + description: URI of the proxy server this security configuration provides access + to. If not given, the corresponding security configuration is for the endpoint. + from_schema: td + rank: 1000 + alias: proxy + owner: SecurityScheme + domain_of: + - SecurityScheme + range: anyUri + scheme: + name: scheme + from_schema: td + rank: 1000 + alias: scheme + owner: SecurityScheme + domain_of: + - SecurityScheme + range: SecuritySchemeType + required: true + '@type': + name: '@type' + from_schema: td + rank: 1000 + multivalued: true + alias: '@type' + owner: SecurityScheme + domain_of: + - SecurityScheme + - Thing + range: string + descriptions: + name: descriptions + description: TODO, check, according to the description a description should not + contain a lang tag. + from_schema: td + rank: 1000 + multivalued: true + alias: descriptions + owner: SecurityScheme + domain_of: + - SecurityScheme + - InteractionAffordance + - Thing + range: MultiLanguage + inlined: true + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/SecuritySchemeType.md b/resources/gens/docs/SecuritySchemeType.md new file mode 100644 index 0000000..1bd064e --- /dev/null +++ b/resources/gens/docs/SecuritySchemeType.md @@ -0,0 +1,106 @@ +# Enum: SecuritySchemeType + + + +URI: [SecuritySchemeType](SecuritySchemeType.md) + +## Permissible Values + +| Value | Meaning | Description | +| --- | --- | --- | +| nosec | wotsec:NoSecurityScheme | A security configuration corresponding to identified by the Vocabulary Term n... | +| combo | wotsec:ComboSecurityScheme | Elements of this scheme define various ways in which other named schemes defi... | +| basic | wotsec:BasicSecurityScheme | Uses an unencrypted username and password | +| digest | wotsec:DigestSecurityScheme | This scheme is similar to basic authentication but with added features to avo... | +| bearer | wotsec:BearerSecurityScheme | Bearer tokens are used independently of OAuth2 | +| psk | wotsec:PSKSecurityScheme | This is meant to identify that a standard is used for pre-shared keys such as... | +| oauth2 | wotsec:OAuth2SecurityScheme | OAuth 2 | +| apikey | wotsec:APIKeySecurityScheme | This scheme is to be used when the access token is opaque | +| auto | wotsec:AutoSecurityScheme | This scheme indicates that the security parameters are going to be negotiated... | + + + + +## Slots + +| Name | Description | +| --- | --- | +| [scheme](scheme.md) | | + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: SecuritySchemeType +from_schema: td +rank: 1000 +permissible_values: + nosec: + text: nosec + description: A security configuration corresponding to identified by the Vocabulary + Term nosec, indicating there is no authentication or other mechanism required + to access the resource. + meaning: wotsec:NoSecurityScheme + combo: + text: combo + description: Elements of this scheme define various ways in which other named + schemes defined in securityDefinitions, including other ComboSecurityScheme + definitions, are to be combined to create a new scheme definition. + meaning: wotsec:ComboSecurityScheme + basic: + text: basic + description: Uses an unencrypted username and password. + meaning: wotsec:BasicSecurityScheme + digest: + text: digest + description: This scheme is similar to basic authentication but with added features + to avoid man-in-the-middle attacks. + meaning: wotsec:DigestSecurityScheme + bearer: + text: bearer + description: Bearer tokens are used independently of OAuth2. + meaning: wotsec:BearerSecurityScheme + psk: + text: psk + description: This is meant to identify that a standard is used for pre-shared + keys such as TLS-PSK [RFC4279], and that the ciphersuite used for keys will + be established during protocol negotiation. + meaning: wotsec:PSKSecurityScheme + oauth2: + text: oauth2 + description: OAuth 2.0 authentication security configuration for systems conformant + with [RFC6749] and [RFC8252]. + meaning: wotsec:OAuth2SecurityScheme + apikey: + text: apikey + description: This scheme is to be used when the access token is opaque. + meaning: wotsec:APIKeySecurityScheme + auto: + text: auto + description: This scheme indicates that the security parameters are going to be + negotiated by the underlying protocols at runtime + meaning: wotsec:AutoSecurityScheme + +``` +</details> diff --git a/resources/gens/docs/Sparqlpath.md b/resources/gens/docs/Sparqlpath.md new file mode 100644 index 0000000..e9429a2 --- /dev/null +++ b/resources/gens/docs/Sparqlpath.md @@ -0,0 +1,39 @@ +# Type: Sparqlpath + + + + +_A string encoding a SPARQL Property Path. The value of the string MUST conform to SPARQL syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded as RDF._ + + + +URI: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +* [base](https://w3id.org/linkml/base): str + +* [uri](https://w3id.org/linkml/uri): xsd:string + +* [repr](https://w3id.org/linkml/repr): str + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/String.md b/resources/gens/docs/String.md new file mode 100644 index 0000000..f4ee52a --- /dev/null +++ b/resources/gens/docs/String.md @@ -0,0 +1,38 @@ +# Type: String + + + + +_A character string_ + + + +URI: [xsd:string](http://www.w3.org/2001/XMLSchema#string) + +* [base](https://w3id.org/linkml/base): str + +* [uri](https://w3id.org/linkml/uri): xsd:string + + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/Thing.md b/resources/gens/docs/Thing.md new file mode 100644 index 0000000..f9fb3a2 --- /dev/null +++ b/resources/gens/docs/Thing.md @@ -0,0 +1,690 @@ + + +# Class: Thing + + +_An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things._ + + + + + +URI: [td:Thing](https://www.w3.org/2019/wot/td#Thing) + + + + + + +```mermaid + classDiagram + class Thing + click Thing href "../Thing" + Thing : @type + + Thing : actions + + + + + Thing --> "*" ActionAffordance : actions + click ActionAffordance href "../ActionAffordance" + + + Thing : base + + Thing : created + + Thing : description + + + + + Thing --> "0..1" MultiLanguage : description + click MultiLanguage href "../MultiLanguage" + + + Thing : descriptionInLanguage + + + + + Thing --> "0..1" MultiLanguage : descriptionInLanguage + click MultiLanguage href "../MultiLanguage" + + + Thing : descriptions + + + + + Thing --> "*" MultiLanguage : descriptions + click MultiLanguage href "../MultiLanguage" + + + Thing : events + + + + + Thing --> "*" EventAffordance : events + click EventAffordance href "../EventAffordance" + + + Thing : forms + + + + + Thing --> "*" Form : forms + click Form href "../Form" + + + Thing : id + + Thing : instance + + Thing : links + + + + + Thing --> "*" Link : links + click Link href "../Link" + + + Thing : modified + + Thing : profile + + Thing : properties + + + + + Thing --> "*" PropertyAffordance : properties + click PropertyAffordance href "../PropertyAffordance" + + + Thing : schemaDefinitions + + + + + Thing --> "*" DataSchema : schemaDefinitions + click DataSchema href "../DataSchema" + + + Thing : security + + Thing : securityDefinitions + + Thing : supportContact + + Thing : title + + + + + Thing --> "0..1" MultiLanguage : title + click MultiLanguage href "../MultiLanguage" + + + Thing : titleInLanguage + + + + + Thing --> "0..1" MultiLanguage : titleInLanguage + click MultiLanguage href "../MultiLanguage" + + + Thing : titles + + + + + Thing --> "*" MultiLanguage : titles + click MultiLanguage href "../MultiLanguage" + + + Thing : version + + + + + Thing --> "0..1" VersionInfo : version + click VersionInfo href "../VersionInfo" + + + +``` + + + + +<!-- no inheritance hierarchy --> + + +## Slots + +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [id](id.md) | 1 <br/> [AnyUri](AnyUri.md) | TODO | direct | +| [title](title.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | Provides a human-readable title (e | direct | +| [description](description.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | | direct | +| [titles](titles.md) | * <br/> [MultiLanguage](MultiLanguage.md) | | direct | +| [descriptions](descriptions.md) | * <br/> [MultiLanguage](MultiLanguage.md) | TODO, check, according to the description a description should not contain a ... | direct | +| [@type](@type.md) | * <br/> [String](String.md) | | direct | +| [titleInLanguage](titleInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | direct | +| [descriptionInLanguage](descriptionInLanguage.md) | 0..1 <br/> [MultiLanguage](MultiLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | direct | +| [securityDefinitions](securityDefinitions.md) | * <br/> [String](String.md) or <br />[String](String.md) or <br />[SecuritySchemeType](SecuritySchemeType.md) | A security scheme applied to a (set of) affordance(s) | direct | +| [security](security.md) | * <br/> [String](String.md) | A Thing may define abstract security schemes, used to configure the secure ac... | direct | +| [schemaDefinitions](schemaDefinitions.md) | * <br/> [DataSchema](DataSchema.md) | TODO CHECK | direct | +| [profile](profile.md) | * <br/> [AnyUri](AnyUri.md) | Indicates the WoT Profile mechanisms followed by this Thing Description and t... | direct | +| [instance](instance.md) | 0..1 <br/> [String](String.md) | Provides a version identicator of this TD instance | direct | +| [created](created.md) | 0..1 <br/> [Datetime](Datetime.md) | Provides information when the TD instance was created | direct | +| [modified](modified.md) | 0..1 <br/> [Datetime](Datetime.md) | Provides information when the TD instance was last modified | direct | +| [supportContact](supportContact.md) | 0..1 <br/> [AnyUri](AnyUri.md) | Provides information about the TD maintainer as URI scheme (e | direct | +| [base](base.md) | 0..1 <br/> [AnyUri](AnyUri.md) | Define the base URI that is used for all relative URI references throughout a... | direct | +| [version](version.md) | 0..1 <br/> [VersionInfo](VersionInfo.md) | | direct | +| [forms](forms.md) | * <br/> [Form](Form.md) | Set of form hypermedia controls that describe how an operation can be perform... | direct | +| [links](links.md) | * <br/> [Link](Link.md) | Provides Web links to arbitrary resources that relate to the specified Thing ... | direct | +| [properties](properties.md) | * <br/> [PropertyAffordance](PropertyAffordance.md) | All Property-based interaction affordances of the Thing | direct | +| [actions](actions.md) | * <br/> [ActionAffordance](ActionAffordance.md) | All Action-based interaction affordances of the Thing | direct | +| [events](events.md) | * <br/> [EventAffordance](EventAffordance.md) | All Event-based interaction affordances of the Thing | direct | + + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | td:Thing | +| native | td:Thing | + + + + + +## LinkML Source + +<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> + +### Direct + +<details> +```yaml +name: Thing +description: An abstraction of a physical or a virtual entity whose metadata and interfaces + are described by a WoT Thing Description, whereas a virtual entity is the composition + of one or more Things. +from_schema: td +rank: 1000 +slots: +- id +- title +- description +- titles +- descriptions +- '@type' +- titleInLanguage +- descriptionInLanguage +attributes: + securityDefinitions: + name: securityDefinitions + description: A security scheme applied to a (set of) affordance(s). TODO check + from_schema: td + multivalued: true + domain_of: + - Form + - Thing + any_of: + - range: string + - range: SecuritySchemeType + security: + name: security + description: 'A Thing may define abstract security schemes, used to configure + the secure access of (a set of) affordance(s). TODO: check' + from_schema: td + rank: 1000 + multivalued: true + domain_of: + - Thing + schemaDefinitions: + name: schemaDefinitions + description: TODO CHECK + from_schema: td + rank: 1000 + multivalued: true + domain_of: + - Thing + range: DataSchema + profile: + name: profile + description: Indicates the WoT Profile mechanisms followed by this Thing Description + and the corresponding Thing implementation. + from_schema: td + rank: 1000 + multivalued: true + domain_of: + - Thing + range: anyUri + instance: + name: instance + description: Provides a version identicator of this TD instance. + from_schema: td + domain_of: + - VersionInfo + - Thing + created: + name: created + description: Provides information when the TD instance was created. + from_schema: td + rank: 1000 + domain_of: + - Thing + range: datetime + modified: + name: modified + description: Provides information when the TD instance was last modified. + from_schema: td + rank: 1000 + domain_of: + - Thing + range: datetime + supportContact: + name: supportContact + description: Provides information about the TD maintainer as URI scheme (e.g., + <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> + [[RFC9112]]). + from_schema: td + rank: 1000 + domain_of: + - Thing + range: anyUri + base: + name: base + description: Define the base URI that is used for all relative URI references + throughout a TD document. + from_schema: td + rank: 1000 + domain_of: + - Thing + range: anyUri + version: + name: version + from_schema: td + rank: 1000 + domain_of: + - Thing + range: VersionInfo + forms: + name: forms + description: Set of form hypermedia controls that describe how an operation can + be performed. Forms are serializations of Protocol Bindings. + from_schema: td + multivalued: true + domain_of: + - InteractionAffordance + - Thing + range: Form + links: + name: links + description: Provides Web links to arbitrary resources that relate to the specified + Thing Description. + from_schema: td + rank: 1000 + multivalued: true + domain_of: + - Thing + range: Link + properties: + name: properties + description: All Property-based interaction affordances of the Thing. + from_schema: td + rank: 1000 + multivalued: true + domain_of: + - Thing + range: PropertyAffordance + inlined: true + actions: + name: actions + description: All Action-based interaction affordances of the Thing. + from_schema: td + rank: 1000 + multivalued: true + domain_of: + - Thing + range: ActionAffordance + inlined: true + events: + name: events + description: All Event-based interaction affordances of the Thing. + from_schema: td + rank: 1000 + multivalued: true + domain_of: + - Thing + range: EventAffordance + inlined: true +class_uri: td:Thing + +``` +</details> + +### Induced + +<details> +```yaml +name: Thing +description: An abstraction of a physical or a virtual entity whose metadata and interfaces + are described by a WoT Thing Description, whereas a virtual entity is the composition + of one or more Things. +from_schema: td +rank: 1000 +attributes: + securityDefinitions: + name: securityDefinitions + description: A security scheme applied to a (set of) affordance(s). TODO check + from_schema: td + multivalued: true + alias: securityDefinitions + owner: Thing + domain_of: + - Form + - Thing + range: string + any_of: + - range: string + - range: SecuritySchemeType + security: + name: security + description: 'A Thing may define abstract security schemes, used to configure + the secure access of (a set of) affordance(s). TODO: check' + from_schema: td + rank: 1000 + multivalued: true + alias: security + owner: Thing + domain_of: + - Thing + range: string + schemaDefinitions: + name: schemaDefinitions + description: TODO CHECK + from_schema: td + rank: 1000 + multivalued: true + alias: schemaDefinitions + owner: Thing + domain_of: + - Thing + range: DataSchema + profile: + name: profile + description: Indicates the WoT Profile mechanisms followed by this Thing Description + and the corresponding Thing implementation. + from_schema: td + rank: 1000 + multivalued: true + alias: profile + owner: Thing + domain_of: + - Thing + range: anyUri + instance: + name: instance + description: Provides a version identicator of this TD instance. + from_schema: td + alias: instance + owner: Thing + domain_of: + - VersionInfo + - Thing + range: string + created: + name: created + description: Provides information when the TD instance was created. + from_schema: td + rank: 1000 + alias: created + owner: Thing + domain_of: + - Thing + range: datetime + modified: + name: modified + description: Provides information when the TD instance was last modified. + from_schema: td + rank: 1000 + alias: modified + owner: Thing + domain_of: + - Thing + range: datetime + supportContact: + name: supportContact + description: Provides information about the TD maintainer as URI scheme (e.g., + <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> + [[RFC9112]]). + from_schema: td + rank: 1000 + alias: supportContact + owner: Thing + domain_of: + - Thing + range: anyUri + base: + name: base + description: Define the base URI that is used for all relative URI references + throughout a TD document. + from_schema: td + rank: 1000 + alias: base + owner: Thing + domain_of: + - Thing + range: anyUri + version: + name: version + from_schema: td + rank: 1000 + alias: version + owner: Thing + domain_of: + - Thing + range: VersionInfo + forms: + name: forms + description: Set of form hypermedia controls that describe how an operation can + be performed. Forms are serializations of Protocol Bindings. + from_schema: td + multivalued: true + alias: forms + owner: Thing + domain_of: + - InteractionAffordance + - Thing + range: Form + links: + name: links + description: Provides Web links to arbitrary resources that relate to the specified + Thing Description. + from_schema: td + rank: 1000 + multivalued: true + alias: links + owner: Thing + domain_of: + - Thing + range: Link + properties: + name: properties + description: All Property-based interaction affordances of the Thing. + from_schema: td + rank: 1000 + multivalued: true + alias: properties + owner: Thing + domain_of: + - Thing + range: PropertyAffordance + inlined: true + actions: + name: actions + description: All Action-based interaction affordances of the Thing. + from_schema: td + rank: 1000 + multivalued: true + alias: actions + owner: Thing + domain_of: + - Thing + range: ActionAffordance + inlined: true + events: + name: events + description: All Event-based interaction affordances of the Thing. + from_schema: td + rank: 1000 + multivalued: true + alias: events + owner: Thing + domain_of: + - Thing + range: EventAffordance + inlined: true + id: + name: id + description: TODO + from_schema: td + rank: 1000 + slot_uri: td:id + identifier: true + alias: id + owner: Thing + domain_of: + - Thing + range: anyUri + required: true + title: + name: title + description: Provides a human-readable title (e.g., display a text for UI representation) + based on a default language. + from_schema: td + rank: 1000 + slot_uri: td:title + alias: title + owner: Thing + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + description: + name: description + from_schema: td + rank: 1000 + alias: description + owner: Thing + domain_of: + - SecurityScheme + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + titles: + name: titles + from_schema: td + rank: 1000 + multivalued: true + alias: titles + owner: Thing + domain_of: + - InteractionAffordance + - Thing + range: MultiLanguage + inlined: true + descriptions: + name: descriptions + description: TODO, check, according to the description a description should not + contain a lang tag. + from_schema: td + rank: 1000 + multivalued: true + alias: descriptions + owner: Thing + domain_of: + - SecurityScheme + - InteractionAffordance + - Thing + range: MultiLanguage + inlined: true + '@type': + name: '@type' + from_schema: td + rank: 1000 + multivalued: true + alias: '@type' + owner: Thing + domain_of: + - SecurityScheme + - Thing + range: string + titleInLanguage: + name: titleInLanguage + description: title of the TD element (Thing, interaction affordance, security + scheme or data scheme) with language tag. By convention, a language tag must + be added to the object of descriptionInLanguage. Otherwise use description. + from_schema: td + rank: 1000 + alias: titleInLanguage + owner: Thing + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage + descriptionInLanguage: + name: descriptionInLanguage + description: description of the TD element (Thing, interaction affordance, security + scheme or data scheme) with language tag. By convention, a language tag must + be added to the object of descriptionInLanguage. Otherwise use description. + from_schema: td + rank: 1000 + alias: descriptionInLanguage + owner: Thing + domain_of: + - DataSchema + - InteractionAffordance + - Thing + range: MultiLanguage +class_uri: td:Thing + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/Time.md b/resources/gens/docs/Time.md new file mode 100644 index 0000000..5b549ef --- /dev/null +++ b/resources/gens/docs/Time.md @@ -0,0 +1,39 @@ +# Type: Time + + + + +_A time object represents a (local) time of day, independent of any particular day_ + + + +URI: [xsd:time](http://www.w3.org/2001/XMLSchema#time) + +* [base](https://w3id.org/linkml/base): XSDTime + +* [uri](https://w3id.org/linkml/uri): xsd:time + +* [repr](https://w3id.org/linkml/repr): str + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/Uri.md b/resources/gens/docs/Uri.md new file mode 100644 index 0000000..fd0d161 --- /dev/null +++ b/resources/gens/docs/Uri.md @@ -0,0 +1,43 @@ +# Type: Uri + + + + +_a complete URI_ + + + +URI: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI) + +* [base](https://w3id.org/linkml/base): URI + +* [uri](https://w3id.org/linkml/uri): xsd:anyURI + +* [repr](https://w3id.org/linkml/repr): str + + + + + + + + +## Comments + +* in RDF serializations a slot with range of uri is treated as a literal or type xsd:anyURI unless it is an identifier or a reference to an identifier, in which case it is translated directly to a node + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/Uriorcurie.md b/resources/gens/docs/Uriorcurie.md new file mode 100644 index 0000000..2b3f34f --- /dev/null +++ b/resources/gens/docs/Uriorcurie.md @@ -0,0 +1,39 @@ +# Type: Uriorcurie + + + + +_a URI or a CURIE_ + + + +URI: [xsd:anyURI](http://www.w3.org/2001/XMLSchema#anyURI) + +* [base](https://w3id.org/linkml/base): URIorCURIE + +* [uri](https://w3id.org/linkml/uri): xsd:anyURI + +* [repr](https://w3id.org/linkml/repr): str + + + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + diff --git a/resources/gens/docs/VersionInfo.md b/resources/gens/docs/VersionInfo.md new file mode 100644 index 0000000..835f12e --- /dev/null +++ b/resources/gens/docs/VersionInfo.md @@ -0,0 +1,150 @@ + + +# Class: VersionInfo + + +_Provides version information._ + + + + + +URI: [schema:version](http://schema.org/version) + + + + + + +```mermaid + classDiagram + class VersionInfo + click VersionInfo href "../VersionInfo" + VersionInfo : instance + + VersionInfo : model + + +``` + + + + +<!-- no inheritance hierarchy --> + + +## Slots + +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [instance](instance.md) | 1 <br/> [String](String.md) | | direct | +| [model](model.md) | 0..1 <br/> [String](String.md) | | direct | + + + + + +## Usages + +| used by | used in | type | used | +| --- | --- | --- | --- | +| [Thing](Thing.md) | [version](version.md) | range | [VersionInfo](VersionInfo.md) | + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | schema:version | +| native | td:VersionInfo | + + + + + +## LinkML Source + +<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> + +### Direct + +<details> +```yaml +name: VersionInfo +description: Provides version information. +from_schema: td +rank: 1000 +attributes: + instance: + name: instance + from_schema: td + rank: 1000 + domain_of: + - VersionInfo + - Thing + required: true + model: + name: model + from_schema: td + rank: 1000 + domain_of: + - VersionInfo +class_uri: schema:version + +``` +</details> + +### Induced + +<details> +```yaml +name: VersionInfo +description: Provides version information. +from_schema: td +rank: 1000 +attributes: + instance: + name: instance + from_schema: td + rank: 1000 + alias: instance + owner: VersionInfo + domain_of: + - VersionInfo + - Thing + range: string + required: true + model: + name: model + from_schema: td + rank: 1000 + alias: model + owner: VersionInfo + domain_of: + - VersionInfo + range: string +class_uri: schema:version + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/about.md b/resources/gens/docs/about.md new file mode 100644 index 0000000..bd22788 --- /dev/null +++ b/resources/gens/docs/about.md @@ -0,0 +1,3 @@ +# thing-description-schema + +Thing Description Standard diff --git a/resources/gens/docs/actions.md b/resources/gens/docs/actions.md new file mode 100644 index 0000000..26245c3 --- /dev/null +++ b/resources/gens/docs/actions.md @@ -0,0 +1,75 @@ + + +# Slot: actions + + +_All Action-based interaction affordances of the Thing._ + + + +URI: [td:actions](https://www.w3.org/2019/wot/td#actions) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [ActionAffordance](ActionAffordance.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: actions +description: All Action-based interaction affordances of the Thing. +from_schema: td +rank: 1000 +multivalued: true +alias: actions +owner: Thing +domain_of: +- Thing +range: ActionAffordance +inlined: true + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/additionalOutputSchema.md b/resources/gens/docs/additionalOutputSchema.md new file mode 100644 index 0000000..48c7bc5 --- /dev/null +++ b/resources/gens/docs/additionalOutputSchema.md @@ -0,0 +1,74 @@ + + +# Slot: additionalOutputSchema + + +_This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used._ + + + +URI: [td:additionalOutputSchema](https://www.w3.org/2019/wot/td#additionalOutputSchema) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | Communication metadata describing the expected response message for additiona... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: additionalOutputSchema +description: This optional term can be used to define a data schema for an additional + response if it differs from the default output data schema. Rather than a DataSchema + object, the name of a previous definition given in a SchemaDefinitions map must + be used. +from_schema: td +rank: 1000 +alias: additionalOutputSchema +owner: AdditionalExpectedResponse +domain_of: +- AdditionalExpectedResponse +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/additionalReturns.md b/resources/gens/docs/additionalReturns.md new file mode 100644 index 0000000..063739c --- /dev/null +++ b/resources/gens/docs/additionalReturns.md @@ -0,0 +1,77 @@ + + +# Slot: additionalReturns + + +_This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema._ + + + +URI: [td:additionalReturns](https://www.w3.org/2019/wot/td#additionalReturns) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | + + + + + + + +## Properties + +* Range: [AdditionalExpectedResponse](AdditionalExpectedResponse.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: additionalReturns +description: This optional term can be used if additional expected responses are possible, + e.g. for error reporting. Each additional response needs to be distinguished from + others in some way (for example, by specifying a protocol-specific response code), + and may also have its own data schema. +from_schema: td +rank: 1000 +multivalued: true +alias: additionalReturns +owner: Form +domain_of: +- Form +range: AdditionalExpectedResponse + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/anchor.md b/resources/gens/docs/anchor.md new file mode 100644 index 0000000..bc4a52f --- /dev/null +++ b/resources/gens/docs/anchor.md @@ -0,0 +1,73 @@ + + +# Slot: anchor + + +_By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI._ + + + +URI: [td:anchor](https://www.w3.org/2019/wot/td#anchor) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | + + + + + + + +## Properties + +* Range: [AnyUri](AnyUri.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: anchor +description: By default, the context, or anchor, of a link conveyed in the Link header + field is the URL of the representation it is associated with, as defined in RFC7231, + Section 3.1.4.1, and is serialized as a URI. +from_schema: td +rank: 1000 +alias: anchor +owner: Link +domain_of: +- Link +range: anyUri + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/base.md b/resources/gens/docs/base.md new file mode 100644 index 0000000..e9efb17 --- /dev/null +++ b/resources/gens/docs/base.md @@ -0,0 +1,72 @@ + + +# Slot: base + + +_Define the base URI that is used for all relative URI references throughout a TD document._ + + + +URI: [td:base](https://www.w3.org/2019/wot/td#base) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [AnyUri](AnyUri.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: base +description: Define the base URI that is used for all relative URI references throughout + a TD document. +from_schema: td +rank: 1000 +alias: base +owner: Thing +domain_of: +- Thing +range: anyUri + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/cancellation.md b/resources/gens/docs/cancellation.md new file mode 100644 index 0000000..066fb63 --- /dev/null +++ b/resources/gens/docs/cancellation.md @@ -0,0 +1,72 @@ + + +# Slot: cancellation + + +_Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook._ + + + +URI: [td:cancellation](https://www.w3.org/2019/wot/td#cancellation) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | + + + + + + + +## Properties + +* Range: [DataSchema](DataSchema.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: cancellation +description: Defines any data that needs to be passed to cancel a subscription, e.g., + a specific message to remove a Webhook. +from_schema: td +rank: 1000 +alias: cancellation +owner: EventAffordance +domain_of: +- EventAffordance +range: DataSchema + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/contentCoding.md b/resources/gens/docs/contentCoding.md new file mode 100644 index 0000000..a70e716 --- /dev/null +++ b/resources/gens/docs/contentCoding.md @@ -0,0 +1,75 @@ + + +# Slot: contentCoding + + +_Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \"gzip\", \"deflate\", etc._ + + + +URI: [td:contentCoding](https://www.w3.org/2019/wot/td#contentCoding) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: contentCoding +description: Content coding values indicate an encoding transformation that has been + or can be applied to a representation. Content codings are primarily used to allow + a representation to be compressed or otherwise usefully transformed without losing + the identity of its underlying media type and without loss of information. Examples + of content coding include \"gzip\", \"deflate\", etc. +from_schema: td +rank: 1000 +alias: contentCoding +owner: Form +domain_of: +- Form +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/contentType.md b/resources/gens/docs/contentType.md new file mode 100644 index 0000000..9811d2c --- /dev/null +++ b/resources/gens/docs/contentType.md @@ -0,0 +1,58 @@ + + +# Slot: contentType + +URI: [td:contentType](https://www.w3.org/2019/wot/td#contentType) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | +| [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | Communication metadata describing the expected response message for additiona... | no | +| [ExpectedResponse](ExpectedResponse.md) | Communication metadata describing the expected response message for the prima... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + + +## LinkML Source + +<details> +```yaml +name: contentType +alias: contentType +domain_of: +- ExpectedResponse +- Form +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/created.md b/resources/gens/docs/created.md new file mode 100644 index 0000000..3cb5c7d --- /dev/null +++ b/resources/gens/docs/created.md @@ -0,0 +1,71 @@ + + +# Slot: created + + +_Provides information when the TD instance was created._ + + + +URI: [td:created](https://www.w3.org/2019/wot/td#created) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [Datetime](Datetime.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: created +description: Provides information when the TD instance was created. +from_schema: td +rank: 1000 +alias: created +owner: Thing +domain_of: +- Thing +range: datetime + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/description.md b/resources/gens/docs/description.md new file mode 100644 index 0000000..bd5af09 --- /dev/null +++ b/resources/gens/docs/description.md @@ -0,0 +1,73 @@ + + +# Slot: description + +URI: [td:description](https://www.w3.org/2019/wot/td#description) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | +| [SecurityScheme](SecurityScheme.md) | | no | +| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | + + + + + + + +## Properties + +* Range: [MultiLanguage](MultiLanguage.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: description +from_schema: td +rank: 1000 +alias: description +domain_of: +- SecurityScheme +- DataSchema +- InteractionAffordance +- Thing +range: MultiLanguage + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/descriptionInLanguage.md b/resources/gens/docs/descriptionInLanguage.md new file mode 100644 index 0000000..36982ec --- /dev/null +++ b/resources/gens/docs/descriptionInLanguage.md @@ -0,0 +1,79 @@ + + +# Slot: descriptionInLanguage + + +_description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description._ + + + +URI: [td:descriptionInLanguage](https://www.w3.org/2019/wot/td#descriptionInLanguage) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | +| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | + + + + + + + +## Properties + +* Range: [MultiLanguage](MultiLanguage.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: descriptionInLanguage +description: description of the TD element (Thing, interaction affordance, security + scheme or data scheme) with language tag. By convention, a language tag must be + added to the object of descriptionInLanguage. Otherwise use description. +from_schema: td +rank: 1000 +alias: descriptionInLanguage +domain_of: +- DataSchema +- InteractionAffordance +- Thing +range: MultiLanguage + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/descriptions.md b/resources/gens/docs/descriptions.md new file mode 100644 index 0000000..cda2c11 --- /dev/null +++ b/resources/gens/docs/descriptions.md @@ -0,0 +1,82 @@ + + +# Slot: descriptions + + +_TODO, check, according to the description a description should not contain a lang tag._ + + + +URI: [td:descriptions](https://www.w3.org/2019/wot/td#descriptions) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | +| [SecurityScheme](SecurityScheme.md) | | no | +| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | + + + + + + + +## Properties + +* Range: [MultiLanguage](MultiLanguage.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: descriptions +description: TODO, check, according to the description a description should not contain + a lang tag. +from_schema: td +rank: 1000 +multivalued: true +alias: descriptions +domain_of: +- SecurityScheme +- InteractionAffordance +- Thing +range: MultiLanguage +inlined: true + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/events.md b/resources/gens/docs/events.md new file mode 100644 index 0000000..e1144a3 --- /dev/null +++ b/resources/gens/docs/events.md @@ -0,0 +1,75 @@ + + +# Slot: events + + +_All Event-based interaction affordances of the Thing._ + + + +URI: [td:events](https://www.w3.org/2019/wot/td#events) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [EventAffordance](EventAffordance.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: events +description: All Event-based interaction affordances of the Thing. +from_schema: td +rank: 1000 +multivalued: true +alias: events +owner: Thing +domain_of: +- Thing +range: EventAffordance +inlined: true + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/forms.md b/resources/gens/docs/forms.md new file mode 100644 index 0000000..2dadbb5 --- /dev/null +++ b/resources/gens/docs/forms.md @@ -0,0 +1,60 @@ + + +# Slot: forms + +URI: [td:forms](https://www.w3.org/2019/wot/td#forms) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | +| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + + +## LinkML Source + +<details> +```yaml +name: forms +alias: forms +domain_of: +- InteractionAffordance +- Thing +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/hintsAtMediaType.md b/resources/gens/docs/hintsAtMediaType.md new file mode 100644 index 0000000..0f9b41a --- /dev/null +++ b/resources/gens/docs/hintsAtMediaType.md @@ -0,0 +1,72 @@ + + +# Slot: hintsAtMediaType + + +_Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be._ + + + +URI: [td:hintsAtMediaType](https://www.w3.org/2019/wot/td#hintsAtMediaType) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: hintsAtMediaType +description: Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] + of the result of dereferencing the link should be. +from_schema: td +rank: 1000 +alias: hintsAtMediaType +owner: Link +domain_of: +- Link +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/href.md b/resources/gens/docs/href.md new file mode 100644 index 0000000..407d53d --- /dev/null +++ b/resources/gens/docs/href.md @@ -0,0 +1,68 @@ + + +# Slot: href + +URI: [td:href](https://www.w3.org/2019/wot/td#href) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | + + + + + + + +## Properties + +* Range: [AnyUri](AnyUri.md) + +* Required: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: href +from_schema: td +rank: 1000 +alias: href +owner: Form +domain_of: +- Form +range: anyUri +required: true + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/hreflang.md b/resources/gens/docs/hreflang.md new file mode 100644 index 0000000..260d11b --- /dev/null +++ b/resources/gens/docs/hreflang.md @@ -0,0 +1,75 @@ + + +# Slot: hreflang + + +_The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]._ + + + +URI: [td:hreflang](https://www.w3.org/2019/wot/td#hreflang) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + +* Regex pattern: `^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$` + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: hreflang +description: The hreflang attribute specifies the language of a linked document. The + value of this must be a valid language tag [[BCP47]]. +from_schema: td +rank: 1000 +alias: hreflang +owner: Link +domain_of: +- Link +range: string +pattern: ^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/id.md b/resources/gens/docs/id.md new file mode 100644 index 0000000..ac908ff --- /dev/null +++ b/resources/gens/docs/id.md @@ -0,0 +1,75 @@ + + +# Slot: id + + +_TODO_ + + + +URI: [td:id](https://www.w3.org/2019/wot/td#id) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [AnyUri](AnyUri.md) + +* Required: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: id +description: TODO +from_schema: td +rank: 1000 +slot_uri: td:id +identifier: true +alias: id +domain_of: +- Thing +range: anyUri +required: true + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/idempotent.md b/resources/gens/docs/idempotent.md new file mode 100644 index 0000000..ad5cff3 --- /dev/null +++ b/resources/gens/docs/idempotent.md @@ -0,0 +1,73 @@ + + +# Slot: idempotent + + +_Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input._ + + + +URI: [td:idempotent](https://www.w3.org/2019/wot/td#idempotent) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | + + + + + + + +## Properties + +* Range: [Boolean](Boolean.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: idempotent +description: Indicates whether the action is idempotent (=true) or not. Informs whether + the action can be called repeatedly with the same results, if present, based on + the same input. +from_schema: td +rank: 1000 +alias: idempotent +owner: ActionAffordance +domain_of: +- ActionAffordance +range: boolean + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/index.md b/resources/gens/docs/index.md new file mode 100644 index 0000000..93e401a --- /dev/null +++ b/resources/gens/docs/index.md @@ -0,0 +1,135 @@ +# thing-description-schema + +LinkML schema for modelling the W3C Web of Things Thing Description information model. This schema is used to generate +JSON Schema, SHACL shapes, and RDF. + +URI: td + +Name: thing-description-schema + + + +## Classes + +| Class | Description | +| --- | --- | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | +| [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | Communication metadata describing the expected response message for additiona... | +| [DataSchema](DataSchema.md) | Metadata that describes the data format used | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | +| [ExpectedResponse](ExpectedResponse.md) | Communication metadata describing the expected response message for the prima... | +| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | +| [InteractionAffordance](InteractionAffordance.md) | TOOD | +| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | +| [MultiLanguage](MultiLanguage.md) | | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | +| [SecurityScheme](SecurityScheme.md) | | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | +| [VersionInfo](VersionInfo.md) | Provides version information | + + + +## Slots + +| Slot | Description | +| --- | --- | +| [@type](@type.md) | | +| [actions](actions.md) | All Action-based interaction affordances of the Thing | +| [additionalOutputSchema](additionalOutputSchema.md) | This optional term can be used to define a data schema for an additional resp... | +| [additionalReturns](additionalReturns.md) | This optional term can be used if additional expected responses are possible,... | +| [anchor](anchor.md) | By default, the context, or anchor, of a link conveyed in the Link header fie... | +| [base](base.md) | Define the base URI that is used for all relative URI references throughout a... | +| [cancellation](cancellation.md) | Defines any data that needs to be passed to cancel a subscription, e | +| [contentCoding](contentCoding.md) | Content coding values indicate an encoding transformation that has been or ca... | +| [contentType](contentType.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | +| [created](created.md) | Provides information when the TD instance was created | +| [description](description.md) | | +| [descriptionInLanguage](descriptionInLanguage.md) | description of the TD element (Thing, interaction affordance, security scheme... | +| [descriptions](descriptions.md) | TODO, check, according to the description a description should not contain a ... | +| [events](events.md) | All Event-based interaction affordances of the Thing | +| [forms](forms.md) | Set of form hypermedia controls that describe how an operation can be perform... | +| [hintsAtMediaType](hintsAtMediaType.md) | Target attribute providing a hint indicating what the media type [IANA-MEDIA-... | +| [href](href.md) | | +| [hreflang](hreflang.md) | The hreflang attribute specifies the language of a linked document | +| [id](id.md) | TODO | +| [idempotent](idempotent.md) | Indicates whether the action is idempotent (=true) or not | +| [input](input.md) | Used to define the input data schema of the action | +| [instance](instance.md) | | +| [key](key.md) | | +| [links](links.md) | Provides Web links to arbitrary resources that relate to the specified Thing ... | +| [model](model.md) | | +| [modified](modified.md) | Provides information when the TD instance was last modified | +| [name](name.md) | Indexing property to store entity names when serializing them in a JSON-LD @i... | +| [notification](notification.md) | Defines the data schema of the Event instance messages pushed by the Thing | +| [notificationResponse](notificationResponse.md) | Defines the data schema of the Event response messages sent by the consumer i... | +| [observable](observable.md) | A hint that indicates whether Servients hosting the Thing and Intermediaries ... | +| [operationType](operationType.md) | Indicates the semantic intention of performing the operation(s) described by ... | +| [output](output.md) | Used to define the output data schema of the action | +| [profile](profile.md) | Indicates the WoT Profile mechanisms followed by this Thing Description and t... | +| [properties](properties.md) | All Property-based interaction affordances of the Thing | +| [propertyName](propertyName.md) | Used to store the indexing name in the parent object when this schema appears... | +| [proxy](proxy.md) | URI of the proxy server this security configuration provides access to | +| [readonly](readonly.md) | Boolean value that is a hint to indicate whether a property interaction/value... | +| [relation](relation.md) | A link relation type identifies the semantics of a link | +| [returns](returns.md) | This optional term can be used if, e | +| [safe](safe.md) | Signals if the action is safe (=true) or not | +| [schema](schema.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | +| [schemaDefinitions](schemaDefinitions.md) | TODO CHECK | +| [scheme](scheme.md) | | +| [scopes](scopes.md) | TODO Check, was not in hctl ontology, if not could be source of discrepancy | +| [security](security.md) | A Thing may define abstract security schemes, used to configure the secure ac... | +| [securityDefinitions](securityDefinitions.md) | A security schema applied to a (set of) affordance(s) | +| [sizes](sizes.md) | Target attribute that specifies one or more sizes for the referenced icon | +| [subprotocol](subprotocol.md) | Indicates the exact mechanism by which an interaction will be accomplished fo... | +| [subscription](subscription.md) | Defines data that needs to be passed upon subscription, e | +| [success](success.md) | Signals if the additional response should not be considered an error | +| [supportContact](supportContact.md) | Provides information about the TD maintainer as URI scheme (e | +| [synchronous](synchronous.md) | Indicates whether the action is synchronous (=true) or not | +| [target](target.md) | Target IRI of a link or submission target of a Form | +| [title](title.md) | Provides a human-readable title (e | +| [titleInLanguage](titleInLanguage.md) | title of the TD element (Thing, interaction affordance, security scheme or da... | +| [titles](titles.md) | | +| [type](type.md) | | +| [uriVariables](uriVariables.md) | Define URI template variables according to RFC6570 as collection based on sch... | +| [version](version.md) | | +| [writeOnly](writeOnly.md) | Boolean value that is a hint to indicate whether a property interaction/value... | + + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [OperationTypes](OperationTypes.md) | Enumerations of well-known operation types necessary to implement the WoT int... | +| [SecuritySchemeType](SecuritySchemeType.md) | | + + +## Types + +| Type | Description | +| --- | --- | +| [AnyUri](AnyUri.md) | a complete URI | +| [Boolean](Boolean.md) | A binary (true or false) value | +| [Curie](Curie.md) | a compact URI | +| [Date](Date.md) | a date (year, month and day) in an idealized calendar | +| [DateOrDatetime](DateOrDatetime.md) | Either a date or a datetime | +| [Datetime](Datetime.md) | The combination of a date and time | +| [Decimal](Decimal.md) | A real number with arbitrary precision that conforms to the xsd:decimal speci... | +| [Double](Double.md) | A real number that conforms to the xsd:double specification | +| [Float](Float.md) | A real number that conforms to the xsd:float specification | +| [Integer](Integer.md) | An integer | +| [Jsonpath](Jsonpath.md) | A string encoding a JSON Path | +| [Jsonpointer](Jsonpointer.md) | A string encoding a JSON Pointer | +| [Ncname](Ncname.md) | Prefix part of CURIE | +| [Nodeidentifier](Nodeidentifier.md) | A URI, CURIE or BNODE that represents a node in a model | +| [Objectidentifier](Objectidentifier.md) | A URI or CURIE that represents an object in the model | +| [Sparqlpath](Sparqlpath.md) | A string encoding a SPARQL Property Path | +| [String](String.md) | A character string | +| [Time](Time.md) | A time object represents a (local) time of day, independent of any particular... | +| [Uri](Uri.md) | a complete URI | +| [Uriorcurie](Uriorcurie.md) | a URI or a CURIE | + + +## Subsets + +| Subset | Description | +| --- | --- | diff --git a/resources/gens/docs/input.md b/resources/gens/docs/input.md new file mode 100644 index 0000000..0120c04 --- /dev/null +++ b/resources/gens/docs/input.md @@ -0,0 +1,71 @@ + + +# Slot: input + + +_Used to define the input data schema of the action._ + + + +URI: [td:input](https://www.w3.org/2019/wot/td#input) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | + + + + + + + +## Properties + +* Range: [DataSchema](DataSchema.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: input +description: Used to define the input data schema of the action. +from_schema: td +rank: 1000 +alias: input +owner: ActionAffordance +domain_of: +- ActionAffordance +range: DataSchema + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/instance.md b/resources/gens/docs/instance.md new file mode 100644 index 0000000..608bbe3 --- /dev/null +++ b/resources/gens/docs/instance.md @@ -0,0 +1,57 @@ + + +# Slot: instance + +URI: [td:instance](https://www.w3.org/2019/wot/td#instance) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [VersionInfo](VersionInfo.md) | Provides version information | no | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + + +## LinkML Source + +<details> +```yaml +name: instance +alias: instance +domain_of: +- VersionInfo +- Thing +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/key.md b/resources/gens/docs/key.md new file mode 100644 index 0000000..2b8ad23 --- /dev/null +++ b/resources/gens/docs/key.md @@ -0,0 +1,72 @@ + + +# Slot: key + +URI: [td:key](https://www.w3.org/2019/wot/td#key) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [MultiLanguage](MultiLanguage.md) | | no | + + + + + + + +## Properties + +* Range: [String](String.md) + +* Required: True + +* Regex pattern: `^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$` + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: key +from_schema: td +rank: 1000 +identifier: true +alias: key +owner: MultiLanguage +domain_of: +- MultiLanguage +range: string +required: true +pattern: ^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/links.md b/resources/gens/docs/links.md new file mode 100644 index 0000000..44e1875 --- /dev/null +++ b/resources/gens/docs/links.md @@ -0,0 +1,75 @@ + + +# Slot: links + + +_Provides Web links to arbitrary resources that relate to the specified Thing Description._ + + + +URI: [td:links](https://www.w3.org/2019/wot/td#links) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [Link](Link.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: links +description: Provides Web links to arbitrary resources that relate to the specified + Thing Description. +from_schema: td +rank: 1000 +multivalued: true +alias: links +owner: Thing +domain_of: +- Thing +range: Link + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/model.md b/resources/gens/docs/model.md new file mode 100644 index 0000000..126cd46 --- /dev/null +++ b/resources/gens/docs/model.md @@ -0,0 +1,65 @@ + + +# Slot: model + +URI: [td:model](https://www.w3.org/2019/wot/td#model) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [VersionInfo](VersionInfo.md) | Provides version information | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: model +from_schema: td +rank: 1000 +alias: model +owner: VersionInfo +domain_of: +- VersionInfo +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/modified.md b/resources/gens/docs/modified.md new file mode 100644 index 0000000..97e2144 --- /dev/null +++ b/resources/gens/docs/modified.md @@ -0,0 +1,71 @@ + + +# Slot: modified + + +_Provides information when the TD instance was last modified._ + + + +URI: [td:modified](https://www.w3.org/2019/wot/td#modified) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [Datetime](Datetime.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: modified +description: Provides information when the TD instance was last modified. +from_schema: td +rank: 1000 +alias: modified +owner: Thing +domain_of: +- Thing +range: datetime + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/name.md b/resources/gens/docs/name.md new file mode 100644 index 0000000..0ecbd92 --- /dev/null +++ b/resources/gens/docs/name.md @@ -0,0 +1,79 @@ + + +# Slot: name + + +_Indexing property to store entity names when serializing them in a JSON-LD @index container._ + + + +URI: [td:name](https://www.w3.org/2019/wot/td#name) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | +| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + +* Required: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: name +description: Indexing property to store entity names when serializing them in a JSON-LD + @index container. +from_schema: td +rank: 1000 +identifier: true +alias: name +owner: InteractionAffordance +domain_of: +- InteractionAffordance +range: string +required: true + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/notification.md b/resources/gens/docs/notification.md new file mode 100644 index 0000000..7aff397 --- /dev/null +++ b/resources/gens/docs/notification.md @@ -0,0 +1,72 @@ + + +# Slot: notification + + +_Defines the data schema of the Event instance messages pushed by the Thing._ + + + +URI: [td:notification](https://www.w3.org/2019/wot/td#notification) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | + + + + + + + +## Properties + +* Range: [DataSchema](DataSchema.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: notification +description: Defines the data schema of the Event instance messages pushed by the + Thing. +from_schema: td +rank: 1000 +alias: notification +owner: EventAffordance +domain_of: +- EventAffordance +range: DataSchema + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/notificationResponse.md b/resources/gens/docs/notificationResponse.md new file mode 100644 index 0000000..4cb181e --- /dev/null +++ b/resources/gens/docs/notificationResponse.md @@ -0,0 +1,72 @@ + + +# Slot: notificationResponse + + +_Defines the data schema of the Event response messages sent by the consumer in a response to a data message._ + + + +URI: [td:notificationResponse](https://www.w3.org/2019/wot/td#notificationResponse) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | + + + + + + + +## Properties + +* Range: [DataSchema](DataSchema.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: notificationResponse +description: Defines the data schema of the Event response messages sent by the consumer + in a response to a data message. +from_schema: td +rank: 1000 +alias: notificationResponse +owner: EventAffordance +domain_of: +- EventAffordance +range: DataSchema + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/observable.md b/resources/gens/docs/observable.md new file mode 100644 index 0000000..c648302 --- /dev/null +++ b/resources/gens/docs/observable.md @@ -0,0 +1,73 @@ + + +# Slot: observable + + +_A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property._ + + + +URI: [td:observable](https://www.w3.org/2019/wot/td#observable) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | + + + + + + + +## Properties + +* Range: [Boolean](Boolean.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: observable +description: A hint that indicates whether Servients hosting the Thing and Intermediaries + should probide a Protocol Binding that supports the observeproperty and unobserveproperty + operations for this Property. +from_schema: td +rank: 1000 +alias: observable +owner: PropertyAffordance +domain_of: +- PropertyAffordance +range: boolean + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/operationType.md b/resources/gens/docs/operationType.md new file mode 100644 index 0000000..eb3a694 --- /dev/null +++ b/resources/gens/docs/operationType.md @@ -0,0 +1,75 @@ + + +# Slot: operationType + + +_Indicates the semantic intention of performing the operation(s) described by the form._ + + + +URI: [td:operationType](https://www.w3.org/2019/wot/td#operationType) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | + + + + + + + +## Properties + +* Range: [OperationTypes](OperationTypes.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: operationType +description: Indicates the semantic intention of performing the operation(s) described + by the form. +from_schema: td +rank: 1000 +multivalued: true +alias: operationType +owner: Form +domain_of: +- Form +range: OperationTypes + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/output.md b/resources/gens/docs/output.md new file mode 100644 index 0000000..f856185 --- /dev/null +++ b/resources/gens/docs/output.md @@ -0,0 +1,71 @@ + + +# Slot: output + + +_Used to define the output data schema of the action._ + + + +URI: [td:output](https://www.w3.org/2019/wot/td#output) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | + + + + + + + +## Properties + +* Range: [DataSchema](DataSchema.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: output +description: Used to define the output data schema of the action. +from_schema: td +rank: 1000 +alias: output +owner: ActionAffordance +domain_of: +- ActionAffordance +range: DataSchema + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/profile.md b/resources/gens/docs/profile.md new file mode 100644 index 0000000..1a976fd --- /dev/null +++ b/resources/gens/docs/profile.md @@ -0,0 +1,75 @@ + + +# Slot: profile + + +_Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation._ + + + +URI: [td:profile](https://www.w3.org/2019/wot/td#profile) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [AnyUri](AnyUri.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: profile +description: Indicates the WoT Profile mechanisms followed by this Thing Description + and the corresponding Thing implementation. +from_schema: td +rank: 1000 +multivalued: true +alias: profile +owner: Thing +domain_of: +- Thing +range: anyUri + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/properties.md b/resources/gens/docs/properties.md new file mode 100644 index 0000000..96fff72 --- /dev/null +++ b/resources/gens/docs/properties.md @@ -0,0 +1,75 @@ + + +# Slot: properties + + +_All Property-based interaction affordances of the Thing._ + + + +URI: [td:properties](https://www.w3.org/2019/wot/td#properties) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [PropertyAffordance](PropertyAffordance.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: properties +description: All Property-based interaction affordances of the Thing. +from_schema: td +rank: 1000 +multivalued: true +alias: properties +owner: Thing +domain_of: +- Thing +range: PropertyAffordance +inlined: true + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/propertyName.md b/resources/gens/docs/propertyName.md new file mode 100644 index 0000000..b3f2ee5 --- /dev/null +++ b/resources/gens/docs/propertyName.md @@ -0,0 +1,73 @@ + + +# Slot: propertyName + + +_Used to store the indexing name in the parent object when this schema appears as a property of an object schema._ + + + +URI: [td:propertyName](https://www.w3.org/2019/wot/td#propertyName) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: propertyName +description: Used to store the indexing name in the parent object when this schema + appears as a property of an object schema. +from_schema: td +rank: 1000 +alias: propertyName +owner: DataSchema +domain_of: +- DataSchema +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/proxy.md b/resources/gens/docs/proxy.md new file mode 100644 index 0000000..b696b29 --- /dev/null +++ b/resources/gens/docs/proxy.md @@ -0,0 +1,72 @@ + + +# Slot: proxy + + +_URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint._ + + + +URI: [td:proxy](https://www.w3.org/2019/wot/td#proxy) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [SecurityScheme](SecurityScheme.md) | | no | + + + + + + + +## Properties + +* Range: [AnyUri](AnyUri.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: proxy +description: URI of the proxy server this security configuration provides access to. + If not given, the corresponding security configuration is for the endpoint. +from_schema: td +rank: 1000 +alias: proxy +owner: SecurityScheme +domain_of: +- SecurityScheme +range: anyUri + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/readonly.md b/resources/gens/docs/readonly.md new file mode 100644 index 0000000..c263882 --- /dev/null +++ b/resources/gens/docs/readonly.md @@ -0,0 +1,73 @@ + + +# Slot: readonly + + +_Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false)._ + + + +URI: [td:readonly](https://www.w3.org/2019/wot/td#readonly) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: readonly +description: Boolean value that is a hint to indicate whether a property interaction/value + is read only (=true) or not (=false). +from_schema: td +rank: 1000 +alias: readonly +owner: DataSchema +domain_of: +- DataSchema +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/relation.md b/resources/gens/docs/relation.md new file mode 100644 index 0000000..613f0a1 --- /dev/null +++ b/resources/gens/docs/relation.md @@ -0,0 +1,71 @@ + + +# Slot: relation + + +_A link relation type identifies the semantics of a link._ + + + +URI: [td:relation](https://www.w3.org/2019/wot/td#relation) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: relation +description: A link relation type identifies the semantics of a link. +from_schema: td +rank: 1000 +alias: relation +owner: Link +domain_of: +- Link +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/returns.md b/resources/gens/docs/returns.md new file mode 100644 index 0000000..4f4a4a1 --- /dev/null +++ b/resources/gens/docs/returns.md @@ -0,0 +1,73 @@ + + +# Slot: returns + + +_This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages._ + + + +URI: [td:returns](https://www.w3.org/2019/wot/td#returns) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | + + + + + + + +## Properties + +* Range: [ExpectedResponse](ExpectedResponse.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: returns +description: This optional term can be used if, e.g., the output communication metadata + differ from input metadata (e.g., output contentType differ from the input contentType). + The response name contains metadata that is only valid for the response messages. +from_schema: td +rank: 1000 +alias: returns +owner: Form +domain_of: +- Form +range: ExpectedResponse + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/safe.md b/resources/gens/docs/safe.md new file mode 100644 index 0000000..958b463 --- /dev/null +++ b/resources/gens/docs/safe.md @@ -0,0 +1,72 @@ + + +# Slot: safe + + +_Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action._ + + + +URI: [td:safe](https://www.w3.org/2019/wot/td#safe) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | + + + + + + + +## Properties + +* Range: [Boolean](Boolean.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: safe +description: Signals if the action is safe (=true) or not. Used to signal if there + is no internal state (cf. resource state) is changed when invoking an Action. +from_schema: td +rank: 1000 +alias: safe +owner: ActionAffordance +domain_of: +- ActionAffordance +range: boolean + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/schema.md b/resources/gens/docs/schema.md new file mode 100644 index 0000000..e358a79 --- /dev/null +++ b/resources/gens/docs/schema.md @@ -0,0 +1,71 @@ + + +# Slot: schema + + +_TODO Check, was not in hctl ontology, if not could be source of discrepancy_ + + + +URI: [td:schema](https://www.w3.org/2019/wot/td#schema) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | Communication metadata describing the expected response message for additiona... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: schema +description: TODO Check, was not in hctl ontology, if not could be source of discrepancy +from_schema: td +rank: 1000 +alias: schema +owner: AdditionalExpectedResponse +domain_of: +- AdditionalExpectedResponse +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/schemaDefinitions.md b/resources/gens/docs/schemaDefinitions.md new file mode 100644 index 0000000..ab96c70 --- /dev/null +++ b/resources/gens/docs/schemaDefinitions.md @@ -0,0 +1,74 @@ + + +# Slot: schemaDefinitions + + +_TODO CHECK_ + + + +URI: [td:schemaDefinitions](https://www.w3.org/2019/wot/td#schemaDefinitions) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [DataSchema](DataSchema.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: schemaDefinitions +description: TODO CHECK +from_schema: td +rank: 1000 +multivalued: true +alias: schemaDefinitions +owner: Thing +domain_of: +- Thing +range: DataSchema + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/scheme.md b/resources/gens/docs/scheme.md new file mode 100644 index 0000000..bf6ea40 --- /dev/null +++ b/resources/gens/docs/scheme.md @@ -0,0 +1,68 @@ + + +# Slot: scheme + +URI: [td:scheme](https://www.w3.org/2019/wot/td#scheme) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [SecurityScheme](SecurityScheme.md) | | no | + + + + + + + +## Properties + +* Range: [SecuritySchemeType](SecuritySchemeType.md) + +* Required: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: scheme +from_schema: td +rank: 1000 +alias: scheme +owner: SecurityScheme +domain_of: +- SecurityScheme +range: SecuritySchemeType +required: true + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/scopes.md b/resources/gens/docs/scopes.md new file mode 100644 index 0000000..69f6e6a --- /dev/null +++ b/resources/gens/docs/scopes.md @@ -0,0 +1,71 @@ + + +# Slot: scopes + + +_TODO Check, was not in hctl ontology, if not could be source of discrepancy_ + + + +URI: [td:scopes](https://www.w3.org/2019/wot/td#scopes) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: scopes +description: TODO Check, was not in hctl ontology, if not could be source of discrepancy +from_schema: td +rank: 1000 +alias: scopes +owner: Form +domain_of: +- Form +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/security.md b/resources/gens/docs/security.md new file mode 100644 index 0000000..e6d3f53 --- /dev/null +++ b/resources/gens/docs/security.md @@ -0,0 +1,75 @@ + + +# Slot: security + + +_A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check_ + + + +URI: [td:security](https://www.w3.org/2019/wot/td#security) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: security +description: 'A Thing may define abstract security schemes, used to configure the + secure access of (a set of) affordance(s). TODO: check' +from_schema: td +rank: 1000 +multivalued: true +alias: security +owner: Thing +domain_of: +- Thing +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/securityDefinitions.md b/resources/gens/docs/securityDefinitions.md new file mode 100644 index 0000000..b8092cb --- /dev/null +++ b/resources/gens/docs/securityDefinitions.md @@ -0,0 +1,57 @@ + + +# Slot: securityDefinitions + +URI: [td:securityDefinitions](https://www.w3.org/2019/wot/td#securityDefinitions) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + + +## LinkML Source + +<details> +```yaml +name: securityDefinitions +alias: securityDefinitions +domain_of: +- Form +- Thing +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/sizes.md b/resources/gens/docs/sizes.md new file mode 100644 index 0000000..df36fdf --- /dev/null +++ b/resources/gens/docs/sizes.md @@ -0,0 +1,73 @@ + + +# Slot: sizes + + +_Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \"16x16\", \"16x16 32x32\")._ + + + +URI: [td:sizes](https://www.w3.org/2019/wot/td#sizes) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: sizes +description: Target attribute that specifies one or more sizes for the referenced + icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} + (e.g., \"16x16\", \"16x16 32x32\"). +from_schema: td +rank: 1000 +alias: sizes +owner: Link +domain_of: +- Link +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/subprotocol.md b/resources/gens/docs/subprotocol.md new file mode 100644 index 0000000..99621dc --- /dev/null +++ b/resources/gens/docs/subprotocol.md @@ -0,0 +1,72 @@ + + +# Slot: subprotocol + + +_Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options._ + + + +URI: [td:subprotocol](https://www.w3.org/2019/wot/td#subprotocol) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: subprotocol +description: Indicates the exact mechanism by which an interaction will be accomplished + for a given protocol when there are multiple options. +from_schema: td +rank: 1000 +alias: subprotocol +owner: Form +domain_of: +- Form +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/subscription.md b/resources/gens/docs/subscription.md new file mode 100644 index 0000000..e57157e --- /dev/null +++ b/resources/gens/docs/subscription.md @@ -0,0 +1,72 @@ + + +# Slot: subscription + + +_Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks._ + + + +URI: [td:subscription](https://www.w3.org/2019/wot/td#subscription) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | + + + + + + + +## Properties + +* Range: [DataSchema](DataSchema.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: subscription +description: Defines data that needs to be passed upon subscription, e.g., filters + or message format for setting up Webhooks. +from_schema: td +rank: 1000 +alias: subscription +owner: EventAffordance +domain_of: +- EventAffordance +range: DataSchema + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/success.md b/resources/gens/docs/success.md new file mode 100644 index 0000000..371b2ac --- /dev/null +++ b/resources/gens/docs/success.md @@ -0,0 +1,71 @@ + + +# Slot: success + + +_Signals if the additional response should not be considered an error._ + + + +URI: [td:success](https://www.w3.org/2019/wot/td#success) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [AdditionalExpectedResponse](AdditionalExpectedResponse.md) | Communication metadata describing the expected response message for additiona... | no | + + + + + + + +## Properties + +* Range: [Boolean](Boolean.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: success +description: Signals if the additional response should not be considered an error. +from_schema: td +rank: 1000 +alias: success +owner: AdditionalExpectedResponse +domain_of: +- AdditionalExpectedResponse +range: boolean + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/supportContact.md b/resources/gens/docs/supportContact.md new file mode 100644 index 0000000..aa860df --- /dev/null +++ b/resources/gens/docs/supportContact.md @@ -0,0 +1,72 @@ + + +# Slot: supportContact + + +_Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]])._ + + + +URI: [td:supportContact](https://www.w3.org/2019/wot/td#supportContact) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [AnyUri](AnyUri.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: supportContact +description: Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> + [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]). +from_schema: td +rank: 1000 +alias: supportContact +owner: Thing +domain_of: +- Thing +range: anyUri + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/synchronous.md b/resources/gens/docs/synchronous.md new file mode 100644 index 0000000..b3d39f6 --- /dev/null +++ b/resources/gens/docs/synchronous.md @@ -0,0 +1,75 @@ + + +# Slot: synchronous + + +_Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made._ + + + +URI: [td:synchronous](https://www.w3.org/2019/wot/td#synchronous) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | + + + + + + + +## Properties + +* Range: [Boolean](Boolean.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: synchronous +description: Indicates whether the action is synchronous (=true) or not. A synchronous + action means that the response of action contains all the information about the + result of the action and no further querying about the status of the action is needed. + Lack of this keyword means that no claim on the synchronicity of the action can + be made. +from_schema: td +rank: 1000 +alias: synchronous +owner: ActionAffordance +domain_of: +- ActionAffordance +range: boolean + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/target.md b/resources/gens/docs/target.md new file mode 100644 index 0000000..4ba8e42 --- /dev/null +++ b/resources/gens/docs/target.md @@ -0,0 +1,76 @@ + + +# Slot: target + + +_Target IRI of a link or submission target of a Form_ + + + +URI: [hctl:target](https://www.w3.org/2019/wot/hypermedia#target) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Form](Form.md) | A form can be viewed as a statement of to perform an operation type on form c... | no | +| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | + + + + + + + +## Properties + +* Range: [AnyUri](AnyUri.md) + +* Required: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: target +description: Target IRI of a link or submission target of a Form +from_schema: td +rank: 1000 +slot_uri: hctl:target +alias: target +domain_of: +- Link +- Form +range: anyUri +required: true + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/thing-description-schema.md b/resources/gens/docs/thing-description-schema.md new file mode 100644 index 0000000..abd362f --- /dev/null +++ b/resources/gens/docs/thing-description-schema.md @@ -0,0 +1,7 @@ +# thing-description-schema + +LinkML schema for modelling the W3C Web of Things Thing Description information model. This schema is used to generate +JSON Schema, SHACL shapes, and RDF. + +URI: td + diff --git a/resources/gens/docs/title.md b/resources/gens/docs/title.md new file mode 100644 index 0000000..b6798ff --- /dev/null +++ b/resources/gens/docs/title.md @@ -0,0 +1,79 @@ + + +# Slot: title + + +_Provides a human-readable title (e.g., display a text for UI representation) based on a default language._ + + + +URI: [td:title](https://www.w3.org/2019/wot/td#title) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | +| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | + + + + + + + +## Properties + +* Range: [MultiLanguage](MultiLanguage.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: title +description: Provides a human-readable title (e.g., display a text for UI representation) + based on a default language. +from_schema: td +rank: 1000 +slot_uri: td:title +alias: title +domain_of: +- DataSchema +- InteractionAffordance +- Thing +range: MultiLanguage + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/titleInLanguage.md b/resources/gens/docs/titleInLanguage.md new file mode 100644 index 0000000..ea17442 --- /dev/null +++ b/resources/gens/docs/titleInLanguage.md @@ -0,0 +1,79 @@ + + +# Slot: titleInLanguage + + +_title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description._ + + + +URI: [td:titleInLanguage](https://www.w3.org/2019/wot/td#titleInLanguage) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | +| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | + + + + + + + +## Properties + +* Range: [MultiLanguage](MultiLanguage.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: titleInLanguage +description: title of the TD element (Thing, interaction affordance, security scheme + or data scheme) with language tag. By convention, a language tag must be added to + the object of descriptionInLanguage. Otherwise use description. +from_schema: td +rank: 1000 +alias: titleInLanguage +domain_of: +- DataSchema +- InteractionAffordance +- Thing +range: MultiLanguage + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/titles.md b/resources/gens/docs/titles.md new file mode 100644 index 0000000..f9f181f --- /dev/null +++ b/resources/gens/docs/titles.md @@ -0,0 +1,73 @@ + + +# Slot: titles + +URI: [td:titles](https://www.w3.org/2019/wot/td#titles) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | +| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | + + + + + + + +## Properties + +* Range: [MultiLanguage](MultiLanguage.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: titles +from_schema: td +rank: 1000 +multivalued: true +alias: titles +domain_of: +- InteractionAffordance +- Thing +range: MultiLanguage +inlined: true + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/type.md b/resources/gens/docs/type.md new file mode 100644 index 0000000..d319db9 --- /dev/null +++ b/resources/gens/docs/type.md @@ -0,0 +1,65 @@ + + +# Slot: type + +URI: [td:type](https://www.w3.org/2019/wot/td#type) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Link](Link.md) | A link can be viewed as a statement of the form link context that has a relat... | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: type +from_schema: td +rank: 1000 +alias: type +owner: Link +domain_of: +- Link +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/uriVariables.md b/resources/gens/docs/uriVariables.md new file mode 100644 index 0000000..dab5e3b --- /dev/null +++ b/resources/gens/docs/uriVariables.md @@ -0,0 +1,79 @@ + + +# Slot: uriVariables + + +_Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology._ + + + +URI: [td:uriVariables](https://www.w3.org/2019/wot/td#uriVariables) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | +| [InteractionAffordance](InteractionAffordance.md) | TOOD | no | +| [ActionAffordance](ActionAffordance.md) | An Interaction Affordance that allows to invoke a function of the Thing, whic... | no | +| [EventAffordance](EventAffordance.md) | An Interaction Affordance that describes an event source, which asynchronousl... | no | + + + + + + + +## Properties + +* Range: [DataSchema](DataSchema.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: uriVariables +description: 'Define URI template variables according to RFC6570 as collection based + on schema specifications. The individual variables DataSchema cannot be an ObjectSchema + or an ArraySchema. TODO: range is not obvious from the ontology.' +from_schema: td +rank: 1000 +multivalued: true +alias: uriVariables +owner: InteractionAffordance +domain_of: +- InteractionAffordance +range: DataSchema + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/version.md b/resources/gens/docs/version.md new file mode 100644 index 0000000..74d472c --- /dev/null +++ b/resources/gens/docs/version.md @@ -0,0 +1,65 @@ + + +# Slot: version + +URI: [td:version](https://www.w3.org/2019/wot/td#version) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Thing](Thing.md) | An abstraction of a physical or a virtual entity whose metadata and interface... | no | + + + + + + + +## Properties + +* Range: [VersionInfo](VersionInfo.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: version +from_schema: td +rank: 1000 +alias: version +owner: Thing +domain_of: +- Thing +range: VersionInfo + +``` +</details> \ No newline at end of file diff --git a/resources/gens/docs/writeOnly.md b/resources/gens/docs/writeOnly.md new file mode 100644 index 0000000..ddb914f --- /dev/null +++ b/resources/gens/docs/writeOnly.md @@ -0,0 +1,73 @@ + + +# Slot: writeOnly + + +_Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false)._ + + + +URI: [td:writeOnly](https://www.w3.org/2019/wot/td#writeOnly) + + + +<!-- no inheritance hierarchy --> + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [DataSchema](DataSchema.md) | Metadata that describes the data format used | no | +| [PropertyAffordance](PropertyAffordance.md) | An Interaction Affordance that exposes state of the Thing | no | + + + + + + + +## Properties + +* Range: [String](String.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: td + + + + +## LinkML Source + +<details> +```yaml +name: writeOnly +description: Boolean value that is a hint to indicate whether a property interaction/value + is write only (=true) or not (=false). +from_schema: td +rank: 1000 +alias: writeOnly +owner: DataSchema +domain_of: +- DataSchema +range: string + +``` +</details> \ No newline at end of file diff --git a/resources/gens/jsonld/thing_description_schema.jsonld b/resources/gens/jsonld/thing_description_schema.jsonld new file mode 100644 index 0000000..8c019fe --- /dev/null +++ b/resources/gens/jsonld/thing_description_schema.jsonld @@ -0,0 +1,2433 @@ +{ + "name": "thing-description-schema", + "description": "LinkML schema for modelling the W3C Web of Things Thing Description information model. This schema is used to generate\nJSON Schema, SHACL shapes, and RDF.", + "title": "thing-description-schema", + "see_also": [ + "https://www.w3.org/TR/wot-thing-description11/" + ], + "id": "td", + "imports": [ + "linkml:types" + ], + "license": "MIT", + "prefixes": [ + { + "prefix_prefix": "linkml", + "prefix_reference": "https://w3id.org/linkml/" + }, + { + "prefix_prefix": "td", + "prefix_reference": "https://www.w3.org/2019/wot/td#" + }, + { + "prefix_prefix": "jsonschema", + "prefix_reference": "https://www.w3.org/2019/wot/json-schema#" + }, + { + "prefix_prefix": "wotsec", + "prefix_reference": "https://www.w3.org/2019/wot/security#" + }, + { + "prefix_prefix": "hctl", + "prefix_reference": "https://www.w3.org/2019/wot/hypermedia#" + }, + { + "prefix_prefix": "rdfs", + "prefix_reference": "http://www.w3.org/2000/01/rdf-schema#" + }, + { + "prefix_prefix": "rdf", + "prefix_reference": "http://www.w3.org/1999/02/22-rdf-syntax-ns#" + }, + { + "prefix_prefix": "dcterms", + "prefix_reference": "http://purl.org/dc/terms/" + }, + { + "prefix_prefix": "schema", + "prefix_reference": "http://schema.org/" + }, + { + "prefix_prefix": "xsd", + "prefix_reference": "http://www.w3.org/2001/XMLSchema#" + }, + { + "prefix_prefix": "dct", + "prefix_reference": "http://purl.org/dc/terms/" + }, + { + "prefix_prefix": "htv", + "prefix_reference": "http://www.w3.org/2011/http#" + }, + { + "prefix_prefix": "tm", + "prefix_reference": "https://www.w3.org/2019/wot/tm#" + } + ], + "default_prefix": "td", + "default_range": "string", + "types": [ + { + "name": "anyUri", + "definition_uri": "https://www.w3.org/2019/wot/td#AnyUri", + "description": "a complete URI", + "from_schema": "td", + "base": "URI", + "uri": "http://www.w3.org/2001/XMLSchema#anyURI", + "@type": "TypeDefinition" + }, + { + "name": "string", + "definition_uri": "https://w3id.org/linkml/String", + "description": "A character string", + "notes": [ + "In RDF serializations, a slot with range of string is treated as a literal or type xsd:string. If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"string\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "exact_mappings": [ + "schema:Text" + ], + "base": "str", + "uri": "http://www.w3.org/2001/XMLSchema#string", + "@type": "TypeDefinition" + }, + { + "name": "integer", + "definition_uri": "https://w3id.org/linkml/Integer", + "description": "An integer", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"integer\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "exact_mappings": [ + "schema:Integer" + ], + "base": "int", + "uri": "http://www.w3.org/2001/XMLSchema#integer", + "@type": "TypeDefinition" + }, + { + "name": "boolean", + "definition_uri": "https://w3id.org/linkml/Boolean", + "description": "A binary (true or false) value", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"boolean\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "exact_mappings": [ + "schema:Boolean" + ], + "base": "Bool", + "uri": "http://www.w3.org/2001/XMLSchema#boolean", + "repr": "bool", + "@type": "TypeDefinition" + }, + { + "name": "float", + "definition_uri": "https://w3id.org/linkml/Float", + "description": "A real number that conforms to the xsd:float specification", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"float\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "exact_mappings": [ + "schema:Float" + ], + "base": "float", + "uri": "http://www.w3.org/2001/XMLSchema#float", + "@type": "TypeDefinition" + }, + { + "name": "double", + "definition_uri": "https://w3id.org/linkml/Double", + "description": "A real number that conforms to the xsd:double specification", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"double\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "close_mappings": [ + "schema:Float" + ], + "base": "float", + "uri": "http://www.w3.org/2001/XMLSchema#double", + "@type": "TypeDefinition" + }, + { + "name": "decimal", + "definition_uri": "https://w3id.org/linkml/Decimal", + "description": "A real number with arbitrary precision that conforms to the xsd:decimal specification", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"decimal\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "broad_mappings": [ + "schema:Number" + ], + "base": "Decimal", + "uri": "http://www.w3.org/2001/XMLSchema#decimal", + "@type": "TypeDefinition" + }, + { + "name": "time", + "definition_uri": "https://w3id.org/linkml/Time", + "description": "A time object represents a (local) time of day, independent of any particular day", + "notes": [ + "URI is dateTime because OWL reasoners do not work with straight date or time", + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"time\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "exact_mappings": [ + "schema:Time" + ], + "base": "XSDTime", + "uri": "http://www.w3.org/2001/XMLSchema#time", + "repr": "str", + "@type": "TypeDefinition" + }, + { + "name": "date", + "definition_uri": "https://w3id.org/linkml/Date", + "description": "a date (year, month and day) in an idealized calendar", + "notes": [ + "URI is dateTime because OWL reasoners don't work with straight date or time", + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"date\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "exact_mappings": [ + "schema:Date" + ], + "base": "XSDDate", + "uri": "http://www.w3.org/2001/XMLSchema#date", + "repr": "str", + "@type": "TypeDefinition" + }, + { + "name": "datetime", + "definition_uri": "https://w3id.org/linkml/Datetime", + "description": "The combination of a date and time", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"datetime\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "exact_mappings": [ + "schema:DateTime" + ], + "base": "XSDDateTime", + "uri": "http://www.w3.org/2001/XMLSchema#dateTime", + "repr": "str", + "@type": "TypeDefinition" + }, + { + "name": "date_or_datetime", + "definition_uri": "https://w3id.org/linkml/DateOrDatetime", + "description": "Either a date or a datetime", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"date_or_datetime\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "base": "str", + "uri": "https://w3id.org/linkml/DateOrDatetime", + "repr": "str", + "@type": "TypeDefinition" + }, + { + "name": "uriorcurie", + "definition_uri": "https://w3id.org/linkml/Uriorcurie", + "description": "a URI or a CURIE", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"uriorcurie\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "base": "URIorCURIE", + "uri": "http://www.w3.org/2001/XMLSchema#anyURI", + "repr": "str", + "@type": "TypeDefinition" + }, + { + "name": "curie", + "definition_uri": "https://w3id.org/linkml/Curie", + "conforms_to": "https://www.w3.org/TR/curie/", + "description": "a compact URI", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"curie\"." + ], + "comments": [ + "in RDF serializations this MUST be expanded to a URI", + "in non-RDF serializations MAY be serialized as the compact representation" + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "base": "Curie", + "uri": "http://www.w3.org/2001/XMLSchema#string", + "repr": "str", + "@type": "TypeDefinition" + }, + { + "name": "uri", + "definition_uri": "https://w3id.org/linkml/Uri", + "conforms_to": "https://www.ietf.org/rfc/rfc3987.txt", + "description": "a complete URI", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"uri\"." + ], + "comments": [ + "in RDF serializations a slot with range of uri is treated as a literal or type xsd:anyURI unless it is an identifier or a reference to an identifier, in which case it is translated directly to a node" + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "close_mappings": [ + "schema:URL" + ], + "base": "URI", + "uri": "http://www.w3.org/2001/XMLSchema#anyURI", + "repr": "str", + "@type": "TypeDefinition" + }, + { + "name": "ncname", + "definition_uri": "https://w3id.org/linkml/Ncname", + "description": "Prefix part of CURIE", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"ncname\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "base": "NCName", + "uri": "http://www.w3.org/2001/XMLSchema#string", + "repr": "str", + "@type": "TypeDefinition" + }, + { + "name": "objectidentifier", + "definition_uri": "https://w3id.org/linkml/Objectidentifier", + "description": "A URI or CURIE that represents an object in the model.", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"objectidentifier\"." + ], + "comments": [ + "Used for inheritance and type checking" + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "base": "ElementIdentifier", + "uri": "http://www.w3.org/ns/shex#iri", + "repr": "str", + "@type": "TypeDefinition" + }, + { + "name": "nodeidentifier", + "definition_uri": "https://w3id.org/linkml/Nodeidentifier", + "description": "A URI, CURIE or BNODE that represents a node in a model.", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"nodeidentifier\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "base": "NodeIdentifier", + "uri": "http://www.w3.org/ns/shex#nonLiteral", + "repr": "str", + "@type": "TypeDefinition" + }, + { + "name": "jsonpointer", + "definition_uri": "https://w3id.org/linkml/Jsonpointer", + "conforms_to": "https://datatracker.ietf.org/doc/html/rfc6901", + "description": "A string encoding a JSON Pointer. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to a valid object within the current instance document when encoded in tree form.", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"jsonpointer\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "base": "str", + "uri": "http://www.w3.org/2001/XMLSchema#string", + "repr": "str", + "@type": "TypeDefinition" + }, + { + "name": "jsonpath", + "definition_uri": "https://w3id.org/linkml/Jsonpath", + "conforms_to": "https://www.ietf.org/archive/id/draft-goessner-dispatch-jsonpath-00.html", + "description": "A string encoding a JSON Path. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded in tree form.", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"jsonpath\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "base": "str", + "uri": "http://www.w3.org/2001/XMLSchema#string", + "repr": "str", + "@type": "TypeDefinition" + }, + { + "name": "sparqlpath", + "definition_uri": "https://w3id.org/linkml/Sparqlpath", + "conforms_to": "https://www.w3.org/TR/sparql11-query/#propertypaths", + "description": "A string encoding a SPARQL Property Path. The value of the string MUST conform to SPARQL syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded as RDF.", + "notes": [ + "If you are authoring schemas in LinkML YAML, the type is referenced with the lower case \"sparqlpath\"." + ], + "from_schema": "https://w3id.org/linkml/types", + "imported_from": "linkml:types", + "base": "str", + "uri": "http://www.w3.org/2001/XMLSchema#string", + "repr": "str", + "@type": "TypeDefinition" + } + ], + "enums": [ + { + "name": "OperationTypes", + "definition_uri": "https://www.w3.org/2019/wot/td#OperationTypes", + "description": "Enumerations of well-known operation types necessary to implement the WoT interaction model.", + "from_schema": "td", + "permissible_values": [ + { + "text": "readproperty", + "description": "Identifies the read operation on Property Affordances to retrieve the corresponding data.", + "meaning": "td:readProperty" + }, + { + "text": "writeproperty", + "description": "Identifies the write operation on Property Affordances to update the corresponding data.", + "meaning": "td:writeProperty" + }, + { + "text": "observeproperty", + "description": "Identifies the observe operation on Property Affordances to be notified with the new data when the Property is updated.", + "meaning": "td:observeProperty" + }, + { + "text": "unobserveproperty", + "description": "Identifies the unobserve operation on Property Affordances to stop the corresponding notifications.", + "meaning": "td:unobserveProperty" + }, + { + "text": "invokeaction", + "description": "Identifies the invoke operation on Action Affordances to perform the corresponding action.", + "meaning": "td:invokeAction" + }, + { + "text": "queryaction", + "description": "Identifies the querying operation on Action Affordances to get the status of the corresponding action.", + "meaning": "td:queryAction" + }, + { + "text": "cancelaction", + "description": "Identifies the cancel operation on Action Affordances to cancel the ongoing corresponding action.", + "meaning": "td:cancelAction" + }, + { + "text": "subscribeevent", + "description": "Identifies the subscribe operation on Event Affordances to be notified by the Thing when the event occurs.", + "meaning": "td:subscribeEvent" + }, + { + "text": "unsubscribeevent", + "description": "Identifies the unsubscribe operation on Event Affordances to stop the corresponding notifications.", + "meaning": "td:unsubscribeEvent" + }, + { + "text": "readallproperties", + "description": "Identifies the readallproperties operation on a Thing to retrieve the data of all Properties in a single interaction.", + "meaning": "td:readAllProperties" + }, + { + "text": "writeallproperties", + "description": "Identifies the writeallproperties operation on a Thing to update the data of all writable Properties in a single interaction.", + "meaning": "writeAllProperties" + }, + { + "text": "readmultipleproperties", + "description": "Identifies the readmultipleproperties operation on a Thing to retrieve the data of selected Properties in a single interaction.", + "meaning": "td:readMultipleProperties" + }, + { + "text": "writemultipleproperties", + "description": "Identifies the writemultipleproperties operation on a Thing to update the data of selected writable Properties in a single interaction.", + "meaning": "td:writeMultipleProperties" + }, + { + "text": "observeallproperties", + "description": "Identifies the observeallproperties operation on Properties to be notified with new data when any Property is updated.", + "meaning": "td:observeAllProperties" + }, + { + "text": "unobserveallproperties", + "description": "Identifies the unobserveallproperties operation on Properties to stop notifications from all Properties in a single interaction.", + "meaning": "td:unobserveAllProperties" + }, + { + "text": "subscribeallevents", + "description": "Identifies the subscribeallevents operation on Events to subscribe to notifications from all Events in a single interaction.", + "meaning": "td:subscribeAllEvents" + }, + { + "text": "unsubscribeallevents", + "description": "Identifies the unsubscribeallevents operation on Events to unsubscribe from notifications from all Events in a single interaction.", + "meaning": "td:unsubscribeAllEvents" + }, + { + "text": "queryallactions", + "description": "Identifies the queryallactions operation on a Thing to get the status of all Actions in a single interaction.", + "meaning": "td:queryAllActions" + } + ] + }, + { + "name": "SecuritySchemeType", + "definition_uri": "https://www.w3.org/2019/wot/td#SecuritySchemeType", + "from_schema": "td", + "permissible_values": [ + { + "text": "nosec", + "description": "A security configuration corresponding to identified by the Vocabulary Term nosec, indicating there is no authentication or other mechanism required to access the resource.", + "meaning": "wotsec:NoSecurityScheme" + }, + { + "text": "combo", + "description": "Elements of this scheme define various ways in which other named schemes defined in securityDefinitions, including other ComboSecurityScheme definitions, are to be combined to create a new scheme definition.", + "meaning": "wotsec:ComboSecurityScheme" + }, + { + "text": "basic", + "description": "Uses an unencrypted username and password.", + "meaning": "wotsec:BasicSecurityScheme" + }, + { + "text": "digest", + "description": "This scheme is similar to basic authentication but with added features to avoid man-in-the-middle attacks.", + "meaning": "wotsec:DigestSecurityScheme" + }, + { + "text": "bearer", + "description": "Bearer tokens are used independently of OAuth2.", + "meaning": "wotsec:BearerSecurityScheme" + }, + { + "text": "psk", + "description": "This is meant to identify that a standard is used for pre-shared keys such as TLS-PSK [RFC4279], and that the ciphersuite used for keys will be established during protocol negotiation.", + "meaning": "wotsec:PSKSecurityScheme" + }, + { + "text": "oauth2", + "description": "OAuth 2.0 authentication security configuration for systems conformant with [RFC6749] and [RFC8252].", + "meaning": "wotsec:OAuth2SecurityScheme" + }, + { + "text": "apikey", + "description": "This scheme is to be used when the access token is opaque.", + "meaning": "wotsec:APIKeySecurityScheme" + }, + { + "text": "auto", + "description": "This scheme indicates that the security parameters are going to be negotiated by the underlying protocols at runtime", + "meaning": "wotsec:AutoSecurityScheme" + } + ] + } + ], + "slots": [ + { + "name": "id", + "definition_uri": "https://www.w3.org/2019/wot/td#id", + "description": "TODO", + "from_schema": "td", + "mappings": [ + "https://www.w3.org/2019/wot/td#id" + ], + "slot_uri": "https://www.w3.org/2019/wot/td#id", + "identifier": true, + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "anyUri", + "required": true, + "@type": "SlotDefinition" + }, + { + "name": "title", + "definition_uri": "https://www.w3.org/2019/wot/td#title", + "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", + "from_schema": "td", + "mappings": [ + "https://www.w3.org/2019/wot/td#title" + ], + "slot_uri": "https://www.w3.org/2019/wot/td#title", + "owner": "Thing", + "domain_of": [ + "DataSchema", + "InteractionAffordance", + "Thing" + ], + "range": "MultiLanguage", + "@type": "SlotDefinition" + }, + { + "name": "description", + "definition_uri": "https://www.w3.org/2019/wot/td#description", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#description", + "owner": "Thing", + "domain_of": [ + "DataSchema", + "InteractionAffordance", + "Thing" + ], + "range": "MultiLanguage", + "@type": "SlotDefinition" + }, + { + "name": "titles", + "definition_uri": "https://www.w3.org/2019/wot/td#titles", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#titles", + "multivalued": true, + "owner": "Thing", + "domain_of": [ + "InteractionAffordance", + "Thing" + ], + "range": "MultiLanguage", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "descriptions", + "definition_uri": "https://www.w3.org/2019/wot/td#descriptions", + "description": "TODO, check, according to the description a description should not contain a lang tag.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#descriptions", + "multivalued": true, + "owner": "Thing", + "domain_of": [ + "SecurityScheme", + "InteractionAffordance", + "Thing" + ], + "range": "MultiLanguage", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "descriptionInLanguage", + "definition_uri": "https://www.w3.org/2019/wot/td#descriptionInLanguage", + "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#descriptionInLanguage", + "owner": "Thing", + "domain_of": [ + "DataSchema", + "InteractionAffordance", + "Thing" + ], + "range": "MultiLanguage", + "@type": "SlotDefinition" + }, + { + "name": "titleInLanguage", + "definition_uri": "https://www.w3.org/2019/wot/td#titleInLanguage", + "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#titleInLanguage", + "owner": "Thing", + "domain_of": [ + "DataSchema", + "InteractionAffordance", + "Thing" + ], + "range": "MultiLanguage", + "@type": "SlotDefinition" + }, + { + "name": "@type", + "definition_uri": "https://www.w3.org/2019/wot/td#@type", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#@type", + "multivalued": true, + "owner": "Thing", + "domain_of": [ + "SecurityScheme", + "Thing" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "target", + "definition_uri": "https://www.w3.org/2019/wot/td#target", + "description": "Target IRI of a link or submission target of a Form", + "from_schema": "td", + "mappings": [ + "https://www.w3.org/2019/wot/hypermedia#target" + ], + "slot_uri": "https://www.w3.org/2019/wot/hypermedia#target", + "owner": "Form", + "domain_of": [ + "Link", + "Form" + ], + "range": "anyUri", + "required": true, + "@type": "SlotDefinition" + }, + { + "name": "versionInfo__instance", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#instance", + "alias": "instance", + "owner": "VersionInfo", + "domain_of": [ + "VersionInfo" + ], + "range": "string", + "required": true, + "@type": "SlotDefinition" + }, + { + "name": "versionInfo__model", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#model", + "alias": "model", + "owner": "VersionInfo", + "domain_of": [ + "VersionInfo" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "multiLanguage__key", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#key", + "identifier": true, + "alias": "key", + "owner": "MultiLanguage", + "domain_of": [ + "MultiLanguage" + ], + "range": "string", + "required": true, + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", + "@type": "SlotDefinition" + }, + { + "name": "link__hintsAtMediaType", + "description": "Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#hintsAtMediaType", + "alias": "hintsAtMediaType", + "owner": "Link", + "domain_of": [ + "Link" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "link__type", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#type", + "alias": "type", + "owner": "Link", + "domain_of": [ + "Link" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "link__relation", + "description": "A link relation type identifies the semantics of a link.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#relation", + "alias": "relation", + "owner": "Link", + "domain_of": [ + "Link" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "link__anchor", + "description": "By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#anchor", + "alias": "anchor", + "owner": "Link", + "domain_of": [ + "Link" + ], + "range": "anyUri", + "@type": "SlotDefinition" + }, + { + "name": "link__sizes", + "description": "Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \\\"16x16\\\", \\\"16x16 32x32\\\").", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#sizes", + "alias": "sizes", + "owner": "Link", + "domain_of": [ + "Link" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "link__hreflang", + "description": "The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]].", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#hreflang", + "alias": "hreflang", + "owner": "Link", + "domain_of": [ + "Link" + ], + "range": "string", + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", + "@type": "SlotDefinition" + }, + { + "name": "expectedResponse__contentType", + "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#contentType", + "alias": "contentType", + "owner": "ExpectedResponse", + "domain_of": [ + "ExpectedResponse" + ], + "range": "string", + "required": true, + "@type": "SlotDefinition" + }, + { + "name": "additionalExpectedResponse__additionalOutputSchema", + "description": "This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#additionalOutputSchema", + "alias": "additionalOutputSchema", + "owner": "AdditionalExpectedResponse", + "domain_of": [ + "AdditionalExpectedResponse" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "additionalExpectedResponse__success", + "description": "Signals if the additional response should not be considered an error.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#success", + "alias": "success", + "owner": "AdditionalExpectedResponse", + "domain_of": [ + "AdditionalExpectedResponse" + ], + "range": "boolean", + "@type": "SlotDefinition" + }, + { + "name": "additionalExpectedResponse__schema", + "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#schema", + "alias": "schema", + "owner": "AdditionalExpectedResponse", + "domain_of": [ + "AdditionalExpectedResponse" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "form__href", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#href", + "alias": "href", + "owner": "Form", + "domain_of": [ + "Form" + ], + "range": "anyUri", + "required": true, + "@type": "SlotDefinition" + }, + { + "name": "form__contentType", + "description": "Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#contentType", + "alias": "contentType", + "owner": "Form", + "domain_of": [ + "Form" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "form__contentCoding", + "description": "Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \\\"gzip\\\", \\\"deflate\\\", etc.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#contentCoding", + "alias": "contentCoding", + "owner": "Form", + "domain_of": [ + "Form" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "form__securityDefinitions", + "description": "A security schema applied to a (set of) affordance(s).", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#securityDefinitions", + "alias": "securityDefinitions", + "owner": "Form", + "domain_of": [ + "Form" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "form__scopes", + "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#scopes", + "alias": "scopes", + "owner": "Form", + "domain_of": [ + "Form" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "form__returns", + "description": "This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#returns", + "alias": "returns", + "owner": "Form", + "domain_of": [ + "Form" + ], + "range": "ExpectedResponse", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "form__additionalReturns", + "description": "This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#additionalReturns", + "multivalued": true, + "alias": "additionalReturns", + "owner": "Form", + "domain_of": [ + "Form" + ], + "range": "AdditionalExpectedResponse", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "form__subprotocol", + "description": "Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#subprotocol", + "alias": "subprotocol", + "owner": "Form", + "domain_of": [ + "Form" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "form__operationType", + "description": "Indicates the semantic intention of performing the operation(s) described by the form.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#operationType", + "multivalued": true, + "alias": "operationType", + "owner": "Form", + "domain_of": [ + "Form" + ], + "range": "OperationTypes", + "@type": "SlotDefinition" + }, + { + "name": "securityScheme__description", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#description", + "alias": "description", + "owner": "SecurityScheme", + "domain_of": [ + "SecurityScheme" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "securityScheme__proxy", + "description": "URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#proxy", + "alias": "proxy", + "owner": "SecurityScheme", + "domain_of": [ + "SecurityScheme" + ], + "range": "anyUri", + "@type": "SlotDefinition" + }, + { + "name": "securityScheme__scheme", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#scheme", + "alias": "scheme", + "owner": "SecurityScheme", + "domain_of": [ + "SecurityScheme" + ], + "range": "SecuritySchemeType", + "required": true, + "@type": "SlotDefinition" + }, + { + "name": "dataSchema__propertyName", + "description": "Used to store the indexing name in the parent object when this schema appears as a property of an object schema.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#propertyName", + "alias": "propertyName", + "owner": "DataSchema", + "domain_of": [ + "DataSchema" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "dataSchema__writeOnly", + "description": "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false).", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#writeOnly", + "alias": "writeOnly", + "owner": "DataSchema", + "domain_of": [ + "DataSchema" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "dataSchema__readonly", + "description": "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false).", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#readonly", + "alias": "readonly", + "owner": "DataSchema", + "domain_of": [ + "DataSchema" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "interactionAffordance__name", + "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#name", + "identifier": true, + "alias": "name", + "owner": "InteractionAffordance", + "domain_of": [ + "InteractionAffordance" + ], + "range": "string", + "required": true, + "@type": "SlotDefinition" + }, + { + "name": "interactionAffordance__uriVariables", + "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#uriVariables", + "multivalued": true, + "alias": "uriVariables", + "owner": "InteractionAffordance", + "domain_of": [ + "InteractionAffordance" + ], + "range": "DataSchema", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "interactionAffordance__forms", + "description": "Set of form hypermedia controls that describe how an operation can be performed.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#forms", + "multivalued": true, + "alias": "forms", + "owner": "InteractionAffordance", + "domain_of": [ + "InteractionAffordance" + ], + "range": "Form", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "propertyAffordance__observable", + "description": "A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#observable", + "alias": "observable", + "owner": "PropertyAffordance", + "domain_of": [ + "PropertyAffordance" + ], + "range": "boolean", + "@type": "SlotDefinition" + }, + { + "name": "actionAffordance__safe", + "description": "Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#safe", + "alias": "safe", + "owner": "ActionAffordance", + "domain_of": [ + "ActionAffordance" + ], + "range": "boolean", + "@type": "SlotDefinition" + }, + { + "name": "actionAffordance__synchronous", + "description": "Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#synchronous", + "alias": "synchronous", + "owner": "ActionAffordance", + "domain_of": [ + "ActionAffordance" + ], + "range": "boolean", + "@type": "SlotDefinition" + }, + { + "name": "actionAffordance__idempotent", + "description": "Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#idempotent", + "alias": "idempotent", + "owner": "ActionAffordance", + "domain_of": [ + "ActionAffordance" + ], + "range": "boolean", + "@type": "SlotDefinition" + }, + { + "name": "actionAffordance__input", + "description": "Used to define the input data schema of the action.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#input", + "alias": "input", + "owner": "ActionAffordance", + "domain_of": [ + "ActionAffordance" + ], + "range": "DataSchema", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "actionAffordance__output", + "description": "Used to define the output data schema of the action.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#output", + "alias": "output", + "owner": "ActionAffordance", + "domain_of": [ + "ActionAffordance" + ], + "range": "DataSchema", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "eventAffordance__subscription", + "description": "Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#subscription", + "alias": "subscription", + "owner": "EventAffordance", + "domain_of": [ + "EventAffordance" + ], + "range": "DataSchema", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "eventAffordance__cancellation", + "description": "Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#cancellation", + "alias": "cancellation", + "owner": "EventAffordance", + "domain_of": [ + "EventAffordance" + ], + "range": "DataSchema", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "eventAffordance__notification", + "description": "Defines the data schema of the Event instance messages pushed by the Thing.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#notification", + "alias": "notification", + "owner": "EventAffordance", + "domain_of": [ + "EventAffordance" + ], + "range": "DataSchema", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "eventAffordance__notificationResponse", + "description": "Defines the data schema of the Event response messages sent by the consumer in a response to a data message.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#notificationResponse", + "alias": "notificationResponse", + "owner": "EventAffordance", + "domain_of": [ + "EventAffordance" + ], + "range": "DataSchema", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "thing__securityDefinitions", + "description": "A security scheme applied to a (set of) affordance(s). TODO check", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#securityDefinitions", + "multivalued": true, + "alias": "securityDefinitions", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "string", + "any_of": [ + { + "range": "string", + "@type": "AnonymousSlotExpression" + }, + { + "range": "SecuritySchemeType", + "@type": "AnonymousSlotExpression" + } + ], + "@type": "SlotDefinition" + }, + { + "name": "thing__security", + "description": "A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#security", + "multivalued": true, + "alias": "security", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "thing__schemaDefinitions", + "description": "TODO CHECK", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#schemaDefinitions", + "multivalued": true, + "alias": "schemaDefinitions", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "DataSchema", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "thing__profile", + "description": "Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#profile", + "multivalued": true, + "alias": "profile", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "anyUri", + "@type": "SlotDefinition" + }, + { + "name": "thing__instance", + "description": "Provides a version identicator of this TD instance.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#instance", + "alias": "instance", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "string", + "@type": "SlotDefinition" + }, + { + "name": "thing__created", + "description": "Provides information when the TD instance was created.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#created", + "alias": "created", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "datetime", + "@type": "SlotDefinition" + }, + { + "name": "thing__modified", + "description": "Provides information when the TD instance was last modified.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#modified", + "alias": "modified", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "datetime", + "@type": "SlotDefinition" + }, + { + "name": "thing__supportContact", + "description": "Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]).", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#supportContact", + "alias": "supportContact", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "anyUri", + "@type": "SlotDefinition" + }, + { + "name": "thing__base", + "description": "Define the base URI that is used for all relative URI references throughout a TD document.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#base", + "alias": "base", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "anyUri", + "@type": "SlotDefinition" + }, + { + "name": "thing__version", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#version", + "alias": "version", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "VersionInfo", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "thing__forms", + "description": "Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#forms", + "multivalued": true, + "alias": "forms", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "Form", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "thing__links", + "description": "Provides Web links to arbitrary resources that relate to the specified Thing Description.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#links", + "multivalued": true, + "alias": "links", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "Link", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "thing__properties", + "description": "All Property-based interaction affordances of the Thing.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#properties", + "multivalued": true, + "alias": "properties", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "PropertyAffordance", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "thing__actions", + "description": "All Action-based interaction affordances of the Thing.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#actions", + "multivalued": true, + "alias": "actions", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "ActionAffordance", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "thing__events", + "description": "All Event-based interaction affordances of the Thing.", + "from_schema": "td", + "slot_uri": "https://www.w3.org/2019/wot/td#events", + "multivalued": true, + "alias": "events", + "owner": "Thing", + "domain_of": [ + "Thing" + ], + "range": "EventAffordance", + "inlined": true, + "@type": "SlotDefinition" + } + ], + "classes": [ + { + "name": "VersionInfo", + "definition_uri": "https://www.w3.org/2019/wot/td#VersionInfo", + "description": "Provides version information.", + "from_schema": "td", + "mappings": [ + "schema:version" + ], + "slots": [ + "versionInfo__instance", + "versionInfo__model" + ], + "slot_usage": {}, + "attributes": [ + { + "name": "instance", + "required": true, + "@type": "SlotDefinition" + }, + { + "name": "model", + "@type": "SlotDefinition" + } + ], + "class_uri": "http://schema.org/version", + "@type": "ClassDefinition" + }, + { + "name": "MultiLanguage", + "definition_uri": "https://www.w3.org/2019/wot/td#MultiLanguage", + "from_schema": "td", + "slots": [ + "multiLanguage__key" + ], + "slot_usage": {}, + "attributes": [ + { + "name": "key", + "identifier": true, + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", + "@type": "SlotDefinition" + } + ], + "class_uri": "https://www.w3.org/2019/wot/td#MultiLanguage", + "@type": "ClassDefinition" + }, + { + "name": "Link", + "definition_uri": "https://www.w3.org/2019/wot/td#Link", + "description": "A link can be viewed as a statement of the form link context that has a relation type resource at link target\", where the optional target attributes may further describe the resource.", + "from_schema": "td", + "mappings": [ + "hctl:Link" + ], + "slots": [ + "target", + "link__hintsAtMediaType", + "link__type", + "link__relation", + "link__anchor", + "link__sizes", + "link__hreflang" + ], + "slot_usage": {}, + "attributes": [ + { + "name": "hintsAtMediaType", + "description": "Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be.", + "from_schema": "hctl", + "@type": "SlotDefinition" + }, + { + "name": "type", + "@type": "SlotDefinition" + }, + { + "name": "relation", + "description": "A link relation type identifies the semantics of a link.", + "from_schema": "hctl", + "@type": "SlotDefinition" + }, + { + "name": "anchor", + "description": "By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI.", + "from_schema": "hctl", + "range": "anyUri", + "@type": "SlotDefinition" + }, + { + "name": "sizes", + "description": "Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \\\"16x16\\\", \\\"16x16 32x32\\\").", + "from_schema": "hctl", + "@type": "SlotDefinition" + }, + { + "name": "hreflang", + "description": "The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]].", + "from_schema": "hctl", + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", + "@type": "SlotDefinition" + } + ], + "class_uri": "https://www.w3.org/2019/wot/hypermedia#Link", + "@type": "ClassDefinition" + }, + { + "name": "ExpectedResponse", + "definition_uri": "https://www.w3.org/2019/wot/td#ExpectedResponse", + "description": "Communication metadata describing the expected response message for the primary response.", + "from_schema": "td", + "mappings": [ + "hctl:ExpectedResponse" + ], + "slots": [ + "expectedResponse__contentType" + ], + "slot_usage": {}, + "attributes": [ + { + "name": "contentType", + "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", + "required": true, + "@type": "SlotDefinition" + } + ], + "class_uri": "https://www.w3.org/2019/wot/hypermedia#ExpectedResponse", + "@type": "ClassDefinition" + }, + { + "name": "AdditionalExpectedResponse", + "definition_uri": "https://www.w3.org/2019/wot/td#AdditionalExpectedResponse", + "description": "Communication metadata describing the expected response message for additional responses.", + "from_schema": "td", + "mappings": [ + "hctl:AdditionalExpectedResponse" + ], + "is_a": "ExpectedResponse", + "slots": [ + "expectedResponse__contentType", + "additionalExpectedResponse__additionalOutputSchema", + "additionalExpectedResponse__success", + "additionalExpectedResponse__schema" + ], + "slot_usage": {}, + "attributes": [ + { + "name": "additionalOutputSchema", + "description": "This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used.", + "@type": "SlotDefinition" + }, + { + "name": "success", + "description": "Signals if the additional response should not be considered an error.", + "range": "boolean", + "@type": "SlotDefinition" + }, + { + "name": "schema", + "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", + "@type": "SlotDefinition" + } + ], + "class_uri": "https://www.w3.org/2019/wot/hypermedia#AdditionalExpectedResponse", + "@type": "ClassDefinition" + }, + { + "name": "Form", + "definition_uri": "https://www.w3.org/2019/wot/td#Form", + "description": "A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions.", + "from_schema": "td", + "mappings": [ + "hctl:Form" + ], + "slots": [ + "target", + "form__href", + "form__contentType", + "form__contentCoding", + "form__securityDefinitions", + "form__scopes", + "form__returns", + "form__additionalReturns", + "form__subprotocol", + "form__operationType" + ], + "slot_usage": {}, + "attributes": [ + { + "name": "href", + "range": "anyUri", + "required": true, + "@type": "SlotDefinition" + }, + { + "name": "contentType", + "description": "Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type.", + "from_schema": "hctl", + "@type": "SlotDefinition" + }, + { + "name": "contentCoding", + "description": "Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \\\"gzip\\\", \\\"deflate\\\", etc.", + "from_schema": "hctl", + "@type": "SlotDefinition" + }, + { + "name": "securityDefinitions", + "description": "A security schema applied to a (set of) affordance(s).", + "from_schema": "td:hasSecurityConfiguration", + "@type": "SlotDefinition" + }, + { + "name": "scopes", + "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", + "@type": "SlotDefinition" + }, + { + "name": "returns", + "description": "This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages.", + "range": "ExpectedResponse", + "@type": "SlotDefinition" + }, + { + "name": "additionalReturns", + "description": "This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema.", + "from_schema": "hctl", + "multivalued": true, + "range": "AdditionalExpectedResponse", + "@type": "SlotDefinition" + }, + { + "name": "subprotocol", + "description": "Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options.", + "from_schema": "hctl", + "@type": "SlotDefinition" + }, + { + "name": "operationType", + "description": "Indicates the semantic intention of performing the operation(s) described by the form.", + "from_schema": "hctl", + "multivalued": true, + "range": "OperationTypes", + "@type": "SlotDefinition" + } + ], + "class_uri": "https://www.w3.org/2019/wot/hypermedia#Form", + "@type": "ClassDefinition" + }, + { + "name": "SecurityScheme", + "definition_uri": "https://www.w3.org/2019/wot/td#SecurityScheme", + "from_schema": "td", + "slots": [ + "@type", + "descriptions", + "securityScheme__description", + "securityScheme__proxy", + "securityScheme__scheme" + ], + "slot_usage": {}, + "attributes": [ + { + "name": "description", + "@type": "SlotDefinition" + }, + { + "name": "proxy", + "description": "URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint.", + "range": "anyUri", + "@type": "SlotDefinition" + }, + { + "name": "scheme", + "range": "SecuritySchemeType", + "required": true, + "@type": "SlotDefinition" + } + ], + "class_uri": "https://www.w3.org/2019/wot/td#SecurityScheme", + "@type": "ClassDefinition" + }, + { + "name": "DataSchema", + "definition_uri": "https://www.w3.org/2019/wot/td#DataSchema", + "description": "Metadata that describes the data format used. It can be used for validation.", + "from_schema": "td", + "mappings": [ + "jsonschema:DataSchema" + ], + "slots": [ + "description", + "title", + "titleInLanguage", + "descriptionInLanguage", + "dataSchema__propertyName", + "dataSchema__writeOnly", + "dataSchema__readonly" + ], + "slot_usage": {}, + "attributes": [ + { + "name": "propertyName", + "description": "Used to store the indexing name in the parent object when this schema appears as a property of an object schema.", + "@type": "SlotDefinition" + }, + { + "name": "writeOnly", + "description": "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false).", + "@type": "SlotDefinition" + }, + { + "name": "readonly", + "description": "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false).", + "@type": "SlotDefinition" + } + ], + "class_uri": "https://www.w3.org/2019/wot/json-schema#DataSchema", + "@type": "ClassDefinition" + }, + { + "name": "InteractionAffordance", + "definition_uri": "https://www.w3.org/2019/wot/td#InteractionAffordance", + "description": "TOOD", + "from_schema": "td", + "mappings": [ + "td:InteractionAffordance" + ], + "slots": [ + "titles", + "descriptions", + "title", + "description", + "titleInLanguage", + "descriptionInLanguage", + "interactionAffordance__name", + "interactionAffordance__uriVariables", + "interactionAffordance__forms" + ], + "slot_usage": {}, + "attributes": [ + { + "name": "name", + "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", + "identifier": true, + "@type": "SlotDefinition" + }, + { + "name": "uriVariables", + "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", + "from_schema": "td:hasUriTemplateSchema", + "multivalued": true, + "range": "DataSchema", + "@type": "SlotDefinition" + }, + { + "name": "forms", + "description": "Set of form hypermedia controls that describe how an operation can be performed.", + "from_schema": "td:hasForm", + "multivalued": true, + "range": "Form", + "@type": "SlotDefinition" + } + ], + "class_uri": "https://www.w3.org/2019/wot/td#InteractionAffordance", + "@type": "ClassDefinition" + }, + { + "name": "PropertyAffordance", + "definition_uri": "https://www.w3.org/2019/wot/td#PropertyAffordance", + "description": "An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated.", + "from_schema": "td", + "mappings": [ + "td:PropertyAffordance" + ], + "is_a": "InteractionAffordance", + "mixins": [ + "DataSchema" + ], + "slots": [ + "titles", + "descriptions", + "title", + "description", + "titleInLanguage", + "descriptionInLanguage", + "interactionAffordance__name", + "interactionAffordance__uriVariables", + "interactionAffordance__forms", + "propertyAffordance__observable", + "dataSchema__propertyName", + "dataSchema__writeOnly", + "dataSchema__readonly" + ], + "slot_usage": {}, + "attributes": [ + { + "name": "observable", + "description": "A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property.", + "range": "boolean", + "@type": "SlotDefinition" + } + ], + "class_uri": "https://www.w3.org/2019/wot/td#PropertyAffordance", + "@type": "ClassDefinition" + }, + { + "name": "ActionAffordance", + "definition_uri": "https://www.w3.org/2019/wot/td#ActionAffordance", + "description": "An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time).", + "from_schema": "td", + "mappings": [ + "td:ActionAffordance" + ], + "is_a": "InteractionAffordance", + "slots": [ + "titles", + "descriptions", + "title", + "description", + "titleInLanguage", + "descriptionInLanguage", + "interactionAffordance__name", + "interactionAffordance__uriVariables", + "interactionAffordance__forms", + "actionAffordance__safe", + "actionAffordance__synchronous", + "actionAffordance__idempotent", + "actionAffordance__input", + "actionAffordance__output" + ], + "slot_usage": {}, + "attributes": [ + { + "name": "safe", + "description": "Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action.", + "from_schema": "td:isSafe", + "range": "boolean", + "@type": "SlotDefinition" + }, + { + "name": "synchronous", + "description": "Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made.", + "from_schema": "td:isSynchronous", + "range": "boolean", + "@type": "SlotDefinition" + }, + { + "name": "idempotent", + "description": "Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input.", + "from_schema": "td:isIdempotent", + "range": "boolean", + "@type": "SlotDefinition" + }, + { + "name": "input", + "description": "Used to define the input data schema of the action.", + "from_schema": "td:hasInputSchema", + "range": "DataSchema", + "@type": "SlotDefinition" + }, + { + "name": "output", + "description": "Used to define the output data schema of the action.", + "from_schema": "td:hasOutputSchema", + "range": "DataSchema", + "@type": "SlotDefinition" + } + ], + "class_uri": "https://www.w3.org/2019/wot/td#ActionAffordance", + "@type": "ClassDefinition" + }, + { + "name": "EventAffordance", + "definition_uri": "https://www.w3.org/2019/wot/td#EventAffordance", + "description": "An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts).", + "from_schema": "td", + "mappings": [ + "td:EventAffordance" + ], + "is_a": "InteractionAffordance", + "slots": [ + "titles", + "descriptions", + "title", + "description", + "titleInLanguage", + "descriptionInLanguage", + "interactionAffordance__name", + "interactionAffordance__uriVariables", + "interactionAffordance__forms", + "eventAffordance__subscription", + "eventAffordance__cancellation", + "eventAffordance__notification", + "eventAffordance__notificationResponse" + ], + "slot_usage": {}, + "attributes": [ + { + "name": "subscription", + "description": "Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks.", + "from_schema": "td:hasSubscriptionSchema", + "range": "DataSchema", + "@type": "SlotDefinition" + }, + { + "name": "cancellation", + "description": "Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook.", + "from_schema": "td:hasCancellationSchema", + "range": "DataSchema", + "@type": "SlotDefinition" + }, + { + "name": "notification", + "description": "Defines the data schema of the Event instance messages pushed by the Thing.", + "from_schema": "td:hasNotificationSchema", + "range": "DataSchema", + "@type": "SlotDefinition" + }, + { + "name": "notificationResponse", + "description": "Defines the data schema of the Event response messages sent by the consumer in a response to a data message.", + "from_schema": "td:hasNotificationResponseSchema", + "range": "DataSchema", + "@type": "SlotDefinition" + } + ], + "class_uri": "https://www.w3.org/2019/wot/td#EventAffordance", + "@type": "ClassDefinition" + }, + { + "name": "Thing", + "definition_uri": "https://www.w3.org/2019/wot/td#Thing", + "description": "An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things.", + "from_schema": "td", + "mappings": [ + "td:Thing" + ], + "slots": [ + "id", + "title", + "description", + "titles", + "descriptions", + "@type", + "titleInLanguage", + "descriptionInLanguage", + "thing__securityDefinitions", + "thing__security", + "thing__schemaDefinitions", + "thing__profile", + "thing__instance", + "thing__created", + "thing__modified", + "thing__supportContact", + "thing__base", + "thing__version", + "thing__forms", + "thing__links", + "thing__properties", + "thing__actions", + "thing__events" + ], + "slot_usage": {}, + "attributes": [ + { + "name": "securityDefinitions", + "description": "A security scheme applied to a (set of) affordance(s). TODO check", + "from_schema": "td:hasSecurityConfiguration", + "multivalued": true, + "any_of": [ + { + "range": "string", + "@type": "AnonymousSlotExpression" + }, + { + "range": "SecuritySchemeType", + "@type": "AnonymousSlotExpression" + } + ], + "@type": "SlotDefinition" + }, + { + "name": "security", + "description": "A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check", + "from_schema": "td:definesSecurityScheme", + "multivalued": true, + "@type": "SlotDefinition" + }, + { + "name": "schemaDefinitions", + "description": "TODO CHECK", + "multivalued": true, + "range": "DataSchema", + "@type": "SlotDefinition" + }, + { + "name": "profile", + "description": "Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation.", + "from_schema": "td:followsProfile", + "multivalued": true, + "range": "anyUri", + "@type": "SlotDefinition" + }, + { + "name": "instance", + "description": "Provides a version identicator of this TD instance.", + "@type": "SlotDefinition" + }, + { + "name": "created", + "description": "Provides information when the TD instance was created.", + "from_schema": "dcterms", + "range": "datetime", + "@type": "SlotDefinition" + }, + { + "name": "modified", + "description": "Provides information when the TD instance was last modified.", + "from_schema": "dcterms", + "range": "datetime", + "@type": "SlotDefinition" + }, + { + "name": "supportContact", + "description": "Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]).", + "from_schema": "schema:contactPoint", + "range": "anyUri", + "@type": "SlotDefinition" + }, + { + "name": "base", + "description": "Define the base URI that is used for all relative URI references throughout a TD document.", + "from_schema": "td:baseURI", + "range": "anyUri", + "@type": "SlotDefinition" + }, + { + "name": "version", + "range": "VersionInfo", + "@type": "SlotDefinition" + }, + { + "name": "forms", + "description": "Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings.", + "from_schema": "td:hasForm", + "multivalued": true, + "range": "Form", + "@type": "SlotDefinition" + }, + { + "name": "links", + "description": "Provides Web links to arbitrary resources that relate to the specified Thing Description.", + "from_schema": "td:hasLink", + "multivalued": true, + "range": "Link", + "@type": "SlotDefinition" + }, + { + "name": "properties", + "description": "All Property-based interaction affordances of the Thing.", + "from_schema": "td:hasPropertyAffordance", + "multivalued": true, + "range": "PropertyAffordance", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "actions", + "description": "All Action-based interaction affordances of the Thing.", + "from_schema": "td:hasActionAffordance", + "multivalued": true, + "range": "ActionAffordance", + "inlined": true, + "@type": "SlotDefinition" + }, + { + "name": "events", + "description": "All Event-based interaction affordances of the Thing.", + "from_schema": "td:hasEventAffordance", + "multivalued": true, + "range": "EventAffordance", + "inlined": true, + "@type": "SlotDefinition" + } + ], + "class_uri": "https://www.w3.org/2019/wot/td#Thing", + "@type": "ClassDefinition" + } + ], + "metamodel_version": "1.7.0", + "source_file_size": 24232, + "generation_date": "2024-05-29T09:23:59", + "@type": "SchemaDefinition", + "@context": [ + "https://w3id.org/linkml/meta.context.jsonld", + { + "dct": "http://purl.org/dc/terms/", + "dcterms": "http://purl.org/dc/terms/", + "hctl": "https://www.w3.org/2019/wot/hypermedia#", + "htv": "http://www.w3.org/2011/http#", + "jsonschema": "https://www.w3.org/2019/wot/json-schema#", + "linkml": "https://w3id.org/linkml/", + "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#", + "rdfs": "http://www.w3.org/2000/01/rdf-schema#", + "schema": { + "@id": "schema" + }, + "skos": "http://www.w3.org/2004/02/skos/core#", + "td": "https://www.w3.org/2019/wot/td#", + "tm": "https://www.w3.org/2019/wot/tm#", + "wotsec": "https://www.w3.org/2019/wot/security#", + "xsd": "http://www.w3.org/2001/XMLSchema#", + "@vocab": "https://www.w3.org/2019/wot/td#", + "@type": { + "@id": "@type" + }, + "idempotent": { + "@type": "xsd:boolean", + "@id": "idempotent" + }, + "input": { + "@type": "@id", + "@id": "input" + }, + "output": { + "@type": "@id", + "@id": "output" + }, + "safe": { + "@type": "xsd:boolean", + "@id": "safe" + }, + "synchronous": { + "@type": "xsd:boolean", + "@id": "synchronous" + }, + "additionalOutputSchema": { + "@id": "additionalOutputSchema" + }, + "success": { + "@type": "xsd:boolean", + "@id": "success" + }, + "propertyName": { + "@id": "propertyName" + }, + "readonly": { + "@id": "readonly" + }, + "writeOnly": { + "@id": "writeOnly" + }, + "description": { + "@id": "description" + }, + "descriptionInLanguage": { + "@type": "@id", + "@id": "descriptionInLanguage" + }, + "descriptions": { + "@type": "@id", + "@id": "descriptions" + }, + "cancellation": { + "@type": "@id", + "@id": "cancellation" + }, + "notification": { + "@type": "@id", + "@id": "notification" + }, + "notificationResponse": { + "@type": "@id", + "@id": "notificationResponse" + }, + "subscription": { + "@type": "@id", + "@id": "subscription" + }, + "contentType": { + "@id": "contentType" + }, + "additionalReturns": { + "@type": "@id", + "@id": "additionalReturns" + }, + "contentCoding": { + "@id": "contentCoding" + }, + "href": { + "@type": "@id", + "@id": "href" + }, + "operationType": { + "@context": { + "@vocab": "@null", + "text": "skos:notation", + "description": "skos:prefLabel", + "meaning": "@id" + }, + "@id": "operationType" + }, + "returns": { + "@type": "@id", + "@id": "returns" + }, + "scopes": { + "@id": "scopes" + }, + "securityDefinitions": { + "@id": "securityDefinitions" + }, + "subprotocol": { + "@id": "subprotocol" + }, + "id": "@id", + "forms": { + "@type": "@id", + "@id": "forms" + }, + "name": "@id", + "uriVariables": { + "@type": "@id", + "@id": "uriVariables" + }, + "anchor": { + "@type": "@id", + "@id": "anchor" + }, + "hintsAtMediaType": { + "@id": "hintsAtMediaType" + }, + "hreflang": { + "@id": "hreflang" + }, + "relation": { + "@id": "relation" + }, + "sizes": { + "@id": "sizes" + }, + "type": { + "@id": "type" + }, + "key": "@id", + "observable": { + "@type": "xsd:boolean", + "@id": "observable" + }, + "proxy": { + "@type": "@id", + "@id": "proxy" + }, + "scheme": { + "@context": { + "@vocab": "@null", + "text": "skos:notation", + "description": "skos:prefLabel", + "meaning": "@id" + }, + "@id": "scheme" + }, + "target": { + "@type": "@id", + "@id": "hctl:target" + }, + "actions": { + "@type": "@id", + "@id": "actions" + }, + "base": { + "@type": "@id", + "@id": "base" + }, + "created": { + "@type": "xsd:dateTime", + "@id": "created" + }, + "events": { + "@type": "@id", + "@id": "events" + }, + "instance": { + "@id": "instance" + }, + "links": { + "@type": "@id", + "@id": "links" + }, + "modified": { + "@type": "xsd:dateTime", + "@id": "modified" + }, + "profile": { + "@type": "@id", + "@id": "profile" + }, + "properties": { + "@type": "@id", + "@id": "properties" + }, + "schemaDefinitions": { + "@type": "@id", + "@id": "schemaDefinitions" + }, + "security": { + "@id": "security" + }, + "supportContact": { + "@type": "@id", + "@id": "supportContact" + }, + "version": { + "@type": "@id", + "@id": "version" + }, + "title": { + "@type": "@id", + "@id": "title" + }, + "titleInLanguage": { + "@type": "@id", + "@id": "titleInLanguage" + }, + "titles": { + "@type": "@id", + "@id": "titles" + }, + "model": { + "@id": "model" + }, + "ActionAffordance": { + "@id": "ActionAffordance" + }, + "AdditionalExpectedResponse": { + "@id": "hctl:AdditionalExpectedResponse" + }, + "DataSchema": { + "@id": "jsonschema:DataSchema" + }, + "EventAffordance": { + "@id": "EventAffordance" + }, + "ExpectedResponse": { + "@id": "hctl:ExpectedResponse" + }, + "Form": { + "@id": "hctl:Form" + }, + "InteractionAffordance": { + "@id": "InteractionAffordance" + }, + "Link": { + "@id": "hctl:Link" + }, + "MultiLanguage": { + "@id": "MultiLanguage" + }, + "PropertyAffordance": { + "@id": "PropertyAffordance" + }, + "SecurityScheme": { + "@id": "SecurityScheme" + }, + "Thing": { + "@id": "Thing" + }, + "VersionInfo": { + "@id": "schema:version" + } + }, + "https://w3id.org/linkml/types.context.jsonld", + { + "@base": "https://www.w3.org/2019/wot/td#" + } + ] +} diff --git a/resources/gens/jsonldcontext/thing_description_schema.context.jsonld b/resources/gens/jsonldcontext/thing_description_schema.context.jsonld new file mode 100644 index 0000000..230d725 --- /dev/null +++ b/resources/gens/jsonldcontext/thing_description_schema.context.jsonld @@ -0,0 +1,283 @@ +{ + "comments": { + "description": "Auto generated by LinkML jsonld context generator", + "generation_date": "2024-05-29T09:23:59", + "source": null + }, + "@context": { + "dct": "http://purl.org/dc/terms/", + "dcterms": "http://purl.org/dc/terms/", + "hctl": "https://www.w3.org/2019/wot/hypermedia#", + "htv": "http://www.w3.org/2011/http#", + "jsonschema": "https://www.w3.org/2019/wot/json-schema#", + "linkml": "https://w3id.org/linkml/", + "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#", + "rdfs": "http://www.w3.org/2000/01/rdf-schema#", + "schema": { + "@id": "schema" + }, + "skos": "http://www.w3.org/2004/02/skos/core#", + "td": "https://www.w3.org/2019/wot/td#", + "tm": "https://www.w3.org/2019/wot/tm#", + "wotsec": "https://www.w3.org/2019/wot/security#", + "xsd": "http://www.w3.org/2001/XMLSchema#", + "@vocab": "https://www.w3.org/2019/wot/td#", + "@type": { + "@id": "@type" + }, + "idempotent": { + "@type": "xsd:boolean", + "@id": "idempotent" + }, + "input": { + "@type": "@id", + "@id": "input" + }, + "output": { + "@type": "@id", + "@id": "output" + }, + "safe": { + "@type": "xsd:boolean", + "@id": "safe" + }, + "synchronous": { + "@type": "xsd:boolean", + "@id": "synchronous" + }, + "additionalOutputSchema": { + "@id": "additionalOutputSchema" + }, + "success": { + "@type": "xsd:boolean", + "@id": "success" + }, + "propertyName": { + "@id": "propertyName" + }, + "readonly": { + "@id": "readonly" + }, + "writeOnly": { + "@id": "writeOnly" + }, + "description": { + "@id": "description" + }, + "descriptionInLanguage": { + "@type": "@id", + "@id": "descriptionInLanguage" + }, + "descriptions": { + "@type": "@id", + "@id": "descriptions" + }, + "cancellation": { + "@type": "@id", + "@id": "cancellation" + }, + "notification": { + "@type": "@id", + "@id": "notification" + }, + "notificationResponse": { + "@type": "@id", + "@id": "notificationResponse" + }, + "subscription": { + "@type": "@id", + "@id": "subscription" + }, + "contentType": { + "@id": "contentType" + }, + "additionalReturns": { + "@type": "@id", + "@id": "additionalReturns" + }, + "contentCoding": { + "@id": "contentCoding" + }, + "href": { + "@type": "@id", + "@id": "href" + }, + "operationType": { + "@context": { + "@vocab": "@null", + "text": "skos:notation", + "description": "skos:prefLabel", + "meaning": "@id" + }, + "@id": "operationType" + }, + "returns": { + "@type": "@id", + "@id": "returns" + }, + "scopes": { + "@id": "scopes" + }, + "securityDefinitions": { + "@id": "securityDefinitions" + }, + "subprotocol": { + "@id": "subprotocol" + }, + "id": "@id", + "forms": { + "@type": "@id", + "@id": "forms" + }, + "name": "@id", + "uriVariables": { + "@type": "@id", + "@id": "uriVariables" + }, + "anchor": { + "@type": "@id", + "@id": "anchor" + }, + "hintsAtMediaType": { + "@id": "hintsAtMediaType" + }, + "hreflang": { + "@id": "hreflang" + }, + "relation": { + "@id": "relation" + }, + "sizes": { + "@id": "sizes" + }, + "type": { + "@id": "type" + }, + "key": "@id", + "observable": { + "@type": "xsd:boolean", + "@id": "observable" + }, + "proxy": { + "@type": "@id", + "@id": "proxy" + }, + "scheme": { + "@context": { + "@vocab": "@null", + "text": "skos:notation", + "description": "skos:prefLabel", + "meaning": "@id" + }, + "@id": "scheme" + }, + "target": { + "@type": "@id", + "@id": "hctl:target" + }, + "actions": { + "@type": "@id", + "@id": "actions" + }, + "base": { + "@type": "@id", + "@id": "base" + }, + "created": { + "@type": "xsd:dateTime", + "@id": "created" + }, + "events": { + "@type": "@id", + "@id": "events" + }, + "instance": { + "@id": "instance" + }, + "links": { + "@type": "@id", + "@id": "links" + }, + "modified": { + "@type": "xsd:dateTime", + "@id": "modified" + }, + "profile": { + "@type": "@id", + "@id": "profile" + }, + "properties": { + "@type": "@id", + "@id": "properties" + }, + "schemaDefinitions": { + "@type": "@id", + "@id": "schemaDefinitions" + }, + "security": { + "@id": "security" + }, + "supportContact": { + "@type": "@id", + "@id": "supportContact" + }, + "version": { + "@type": "@id", + "@id": "version" + }, + "title": { + "@type": "@id", + "@id": "title" + }, + "titleInLanguage": { + "@type": "@id", + "@id": "titleInLanguage" + }, + "titles": { + "@type": "@id", + "@id": "titles" + }, + "model": { + "@id": "model" + }, + "ActionAffordance": { + "@id": "ActionAffordance" + }, + "AdditionalExpectedResponse": { + "@id": "hctl:AdditionalExpectedResponse" + }, + "DataSchema": { + "@id": "jsonschema:DataSchema" + }, + "EventAffordance": { + "@id": "EventAffordance" + }, + "ExpectedResponse": { + "@id": "hctl:ExpectedResponse" + }, + "Form": { + "@id": "hctl:Form" + }, + "InteractionAffordance": { + "@id": "InteractionAffordance" + }, + "Link": { + "@id": "hctl:Link" + }, + "MultiLanguage": { + "@id": "MultiLanguage" + }, + "PropertyAffordance": { + "@id": "PropertyAffordance" + }, + "SecurityScheme": { + "@id": "SecurityScheme" + }, + "Thing": { + "@id": "Thing" + }, + "VersionInfo": { + "@id": "schema:version" + } + } +} diff --git a/resources/gens/jsonschema/thing_description_schema.json b/resources/gens/jsonschema/thing_description_schema.json new file mode 100644 index 0000000..debbbce --- /dev/null +++ b/resources/gens/jsonschema/thing_description_schema.json @@ -0,0 +1,1086 @@ +{ + "$defs": { + "ActionAffordance": { + "additionalProperties": false, + "description": "An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time).", + "properties": { + "description": { + "type": "string" + }, + "descriptionInLanguage": { + "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "descriptions": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "description": "TODO, check, according to the description a description should not contain a lang tag.", + "type": "object" + }, + "forms": { + "description": "Set of form hypermedia controls that describe how an operation can be performed.", + "items": { + "$ref": "#/$defs/Form" + }, + "type": "array" + }, + "idempotent": { + "description": "Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input.", + "type": "boolean" + }, + "input": { + "$ref": "#/$defs/DataSchema", + "description": "Used to define the input data schema of the action." + }, + "name": { + "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", + "type": "string" + }, + "output": { + "$ref": "#/$defs/DataSchema", + "description": "Used to define the output data schema of the action." + }, + "safe": { + "description": "Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action.", + "type": "boolean" + }, + "synchronous": { + "description": "Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made.", + "type": "boolean" + }, + "title": { + "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", + "type": "string" + }, + "titleInLanguage": { + "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "titles": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "type": "object" + }, + "uriVariables": { + "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", + "items": { + "$ref": "#/$defs/DataSchema" + }, + "type": "array" + } + }, + "required": [ + "name" + ], + "title": "ActionAffordance", + "type": "object" + }, + "ActionAffordance__identifier_optional": { + "additionalProperties": false, + "description": "An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time).", + "properties": { + "description": { + "type": "string" + }, + "descriptionInLanguage": { + "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "descriptions": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "description": "TODO, check, according to the description a description should not contain a lang tag.", + "type": "object" + }, + "forms": { + "description": "Set of form hypermedia controls that describe how an operation can be performed.", + "items": { + "$ref": "#/$defs/Form" + }, + "type": "array" + }, + "idempotent": { + "description": "Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input.", + "type": "boolean" + }, + "input": { + "$ref": "#/$defs/DataSchema", + "description": "Used to define the input data schema of the action." + }, + "name": { + "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", + "type": "string" + }, + "output": { + "$ref": "#/$defs/DataSchema", + "description": "Used to define the output data schema of the action." + }, + "safe": { + "description": "Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action.", + "type": "boolean" + }, + "synchronous": { + "description": "Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made.", + "type": "boolean" + }, + "title": { + "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", + "type": "string" + }, + "titleInLanguage": { + "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "titles": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "type": "object" + }, + "uriVariables": { + "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", + "items": { + "$ref": "#/$defs/DataSchema" + }, + "type": "array" + } + }, + "required": [], + "title": "ActionAffordance", + "type": "object" + }, + "AdditionalExpectedResponse": { + "additionalProperties": false, + "description": "Communication metadata describing the expected response message for additional responses.", + "properties": { + "additionalOutputSchema": { + "description": "This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used.", + "type": "string" + }, + "contentType": { + "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", + "type": "string" + }, + "schema": { + "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", + "type": "string" + }, + "success": { + "description": "Signals if the additional response should not be considered an error.", + "type": "boolean" + } + }, + "required": [ + "contentType" + ], + "title": "AdditionalExpectedResponse", + "type": "object" + }, + "DataSchema": { + "additionalProperties": false, + "description": "Metadata that describes the data format used. It can be used for validation.", + "properties": { + "description": { + "type": "string" + }, + "descriptionInLanguage": { + "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "propertyName": { + "description": "Used to store the indexing name in the parent object when this schema appears as a property of an object schema.", + "type": "string" + }, + "readonly": { + "description": "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false).", + "type": "string" + }, + "title": { + "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", + "type": "string" + }, + "titleInLanguage": { + "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "writeOnly": { + "description": "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false).", + "type": "string" + } + }, + "title": "DataSchema", + "type": "object" + }, + "EventAffordance": { + "additionalProperties": false, + "description": "An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts).", + "properties": { + "cancellation": { + "$ref": "#/$defs/DataSchema", + "description": "Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook." + }, + "description": { + "type": "string" + }, + "descriptionInLanguage": { + "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "descriptions": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "description": "TODO, check, according to the description a description should not contain a lang tag.", + "type": "object" + }, + "forms": { + "description": "Set of form hypermedia controls that describe how an operation can be performed.", + "items": { + "$ref": "#/$defs/Form" + }, + "type": "array" + }, + "name": { + "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", + "type": "string" + }, + "notification": { + "$ref": "#/$defs/DataSchema", + "description": "Defines the data schema of the Event instance messages pushed by the Thing." + }, + "notificationResponse": { + "$ref": "#/$defs/DataSchema", + "description": "Defines the data schema of the Event response messages sent by the consumer in a response to a data message." + }, + "subscription": { + "$ref": "#/$defs/DataSchema", + "description": "Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks." + }, + "title": { + "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", + "type": "string" + }, + "titleInLanguage": { + "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "titles": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "type": "object" + }, + "uriVariables": { + "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", + "items": { + "$ref": "#/$defs/DataSchema" + }, + "type": "array" + } + }, + "required": [ + "name" + ], + "title": "EventAffordance", + "type": "object" + }, + "EventAffordance__identifier_optional": { + "additionalProperties": false, + "description": "An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts).", + "properties": { + "cancellation": { + "$ref": "#/$defs/DataSchema", + "description": "Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook." + }, + "description": { + "type": "string" + }, + "descriptionInLanguage": { + "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "descriptions": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "description": "TODO, check, according to the description a description should not contain a lang tag.", + "type": "object" + }, + "forms": { + "description": "Set of form hypermedia controls that describe how an operation can be performed.", + "items": { + "$ref": "#/$defs/Form" + }, + "type": "array" + }, + "name": { + "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", + "type": "string" + }, + "notification": { + "$ref": "#/$defs/DataSchema", + "description": "Defines the data schema of the Event instance messages pushed by the Thing." + }, + "notificationResponse": { + "$ref": "#/$defs/DataSchema", + "description": "Defines the data schema of the Event response messages sent by the consumer in a response to a data message." + }, + "subscription": { + "$ref": "#/$defs/DataSchema", + "description": "Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks." + }, + "title": { + "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", + "type": "string" + }, + "titleInLanguage": { + "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "titles": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "type": "object" + }, + "uriVariables": { + "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", + "items": { + "$ref": "#/$defs/DataSchema" + }, + "type": "array" + } + }, + "required": [], + "title": "EventAffordance", + "type": "object" + }, + "ExpectedResponse": { + "additionalProperties": false, + "description": "Communication metadata describing the expected response message for the primary response.", + "properties": { + "contentType": { + "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", + "type": "string" + } + }, + "required": [ + "contentType" + ], + "title": "ExpectedResponse", + "type": "object" + }, + "Form": { + "additionalProperties": false, + "description": "A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions.", + "properties": { + "additionalReturns": { + "description": "This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema.", + "items": { + "$ref": "#/$defs/AdditionalExpectedResponse" + }, + "type": "array" + }, + "contentCoding": { + "description": "Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \\\"gzip\\\", \\\"deflate\\\", etc.", + "type": "string" + }, + "contentType": { + "description": "Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type.", + "type": "string" + }, + "href": { + "type": "string" + }, + "operationType": { + "description": "Indicates the semantic intention of performing the operation(s) described by the form.", + "items": { + "$ref": "#/$defs/OperationTypes" + }, + "type": "array" + }, + "returns": { + "$ref": "#/$defs/ExpectedResponse", + "description": "This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages." + }, + "scopes": { + "description": "TODO Check, was not in hctl ontology, if not could be source of discrepancy", + "type": "string" + }, + "securityDefinitions": { + "description": "A security schema applied to a (set of) affordance(s).", + "type": "string" + }, + "subprotocol": { + "description": "Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options.", + "type": "string" + }, + "target": { + "description": "Target IRI of a link or submission target of a Form", + "type": "string" + } + }, + "required": [ + "target", + "href" + ], + "title": "Form", + "type": "object" + }, + "InteractionAffordance": { + "additionalProperties": false, + "description": "TOOD", + "properties": { + "description": { + "type": "string" + }, + "descriptionInLanguage": { + "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "descriptions": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "description": "TODO, check, according to the description a description should not contain a lang tag.", + "type": "object" + }, + "forms": { + "description": "Set of form hypermedia controls that describe how an operation can be performed.", + "items": { + "$ref": "#/$defs/Form" + }, + "type": "array" + }, + "name": { + "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", + "type": "string" + }, + "title": { + "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", + "type": "string" + }, + "titleInLanguage": { + "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "titles": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "type": "object" + }, + "uriVariables": { + "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", + "items": { + "$ref": "#/$defs/DataSchema" + }, + "type": "array" + } + }, + "required": [ + "name" + ], + "title": "InteractionAffordance", + "type": "object" + }, + "Link": { + "additionalProperties": false, + "description": "A link can be viewed as a statement of the form link context that has a relation type resource at link target\", where the optional target attributes may further describe the resource.", + "properties": { + "anchor": { + "description": "By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI.", + "type": "string" + }, + "hintsAtMediaType": { + "description": "Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be.", + "type": "string" + }, + "hreflang": { + "description": "The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]].", + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", + "type": "string" + }, + "relation": { + "description": "A link relation type identifies the semantics of a link.", + "type": "string" + }, + "sizes": { + "description": "Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \\\"16x16\\\", \\\"16x16 32x32\\\").", + "type": "string" + }, + "target": { + "description": "Target IRI of a link or submission target of a Form", + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "target" + ], + "title": "Link", + "type": "object" + }, + "MultiLanguage": { + "additionalProperties": false, + "description": "", + "properties": { + "key": { + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", + "type": "string" + } + }, + "required": [ + "key" + ], + "title": "MultiLanguage", + "type": "object" + }, + "MultiLanguage__identifier_optional": { + "additionalProperties": false, + "description": "", + "properties": { + "key": { + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", + "type": "string" + } + }, + "required": [], + "title": "MultiLanguage", + "type": "object" + }, + "OperationTypes": { + "description": "Enumerations of well-known operation types necessary to implement the WoT interaction model.", + "enum": [ + "readproperty", + "writeproperty", + "observeproperty", + "unobserveproperty", + "invokeaction", + "queryaction", + "cancelaction", + "subscribeevent", + "unsubscribeevent", + "readallproperties", + "writeallproperties", + "readmultipleproperties", + "writemultipleproperties", + "observeallproperties", + "unobserveallproperties", + "subscribeallevents", + "unsubscribeallevents", + "queryallactions" + ], + "title": "OperationTypes", + "type": "string" + }, + "PropertyAffordance": { + "additionalProperties": false, + "description": "An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated.", + "properties": { + "description": { + "type": "string" + }, + "descriptionInLanguage": { + "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "descriptions": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "description": "TODO, check, according to the description a description should not contain a lang tag.", + "type": "object" + }, + "forms": { + "description": "Set of form hypermedia controls that describe how an operation can be performed.", + "items": { + "$ref": "#/$defs/Form" + }, + "type": "array" + }, + "name": { + "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", + "type": "string" + }, + "observable": { + "description": "A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property.", + "type": "boolean" + }, + "propertyName": { + "description": "Used to store the indexing name in the parent object when this schema appears as a property of an object schema.", + "type": "string" + }, + "readonly": { + "description": "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false).", + "type": "string" + }, + "title": { + "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", + "type": "string" + }, + "titleInLanguage": { + "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "titles": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "type": "object" + }, + "uriVariables": { + "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", + "items": { + "$ref": "#/$defs/DataSchema" + }, + "type": "array" + }, + "writeOnly": { + "description": "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false).", + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "PropertyAffordance", + "type": "object" + }, + "PropertyAffordance__identifier_optional": { + "additionalProperties": false, + "description": "An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated.", + "properties": { + "description": { + "type": "string" + }, + "descriptionInLanguage": { + "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "descriptions": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "description": "TODO, check, according to the description a description should not contain a lang tag.", + "type": "object" + }, + "forms": { + "description": "Set of form hypermedia controls that describe how an operation can be performed.", + "items": { + "$ref": "#/$defs/Form" + }, + "type": "array" + }, + "name": { + "description": "Indexing property to store entity names when serializing them in a JSON-LD @index container.", + "type": "string" + }, + "observable": { + "description": "A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property.", + "type": "boolean" + }, + "propertyName": { + "description": "Used to store the indexing name in the parent object when this schema appears as a property of an object schema.", + "type": "string" + }, + "readonly": { + "description": "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false).", + "type": "string" + }, + "title": { + "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", + "type": "string" + }, + "titleInLanguage": { + "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "titles": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "type": "object" + }, + "uriVariables": { + "description": "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology.", + "items": { + "$ref": "#/$defs/DataSchema" + }, + "type": "array" + }, + "writeOnly": { + "description": "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false).", + "type": "string" + } + }, + "required": [], + "title": "PropertyAffordance", + "type": "object" + }, + "SecurityScheme": { + "additionalProperties": false, + "description": "", + "properties": { + "@type": { + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "type": "string" + }, + "descriptions": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "description": "TODO, check, according to the description a description should not contain a lang tag.", + "type": "object" + }, + "proxy": { + "description": "URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint.", + "type": "string" + }, + "scheme": { + "$ref": "#/$defs/SecuritySchemeType" + } + }, + "required": [ + "scheme" + ], + "title": "SecurityScheme", + "type": "object" + }, + "SecuritySchemeType": { + "description": "", + "enum": [ + "nosec", + "combo", + "basic", + "digest", + "bearer", + "psk", + "oauth2", + "apikey", + "auto" + ], + "title": "SecuritySchemeType", + "type": "string" + }, + "Thing": { + "additionalProperties": false, + "description": "An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things.", + "properties": { + "@type": { + "items": { + "type": "string" + }, + "type": "array" + }, + "actions": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/ActionAffordance__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "description": "All Action-based interaction affordances of the Thing.", + "type": "object" + }, + "base": { + "description": "Define the base URI that is used for all relative URI references throughout a TD document.", + "type": "string" + }, + "created": { + "description": "Provides information when the TD instance was created.", + "format": "date-time", + "type": "string" + }, + "description": { + "type": "string" + }, + "descriptionInLanguage": { + "description": "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "descriptions": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "description": "TODO, check, according to the description a description should not contain a lang tag.", + "type": "object" + }, + "events": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/EventAffordance__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "description": "All Event-based interaction affordances of the Thing.", + "type": "object" + }, + "forms": { + "description": "Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings.", + "items": { + "$ref": "#/$defs/Form" + }, + "type": "array" + }, + "id": { + "description": "TODO", + "type": "string" + }, + "instance": { + "description": "Provides a version identicator of this TD instance.", + "type": "string" + }, + "links": { + "description": "Provides Web links to arbitrary resources that relate to the specified Thing Description.", + "items": { + "$ref": "#/$defs/Link" + }, + "type": "array" + }, + "modified": { + "description": "Provides information when the TD instance was last modified.", + "format": "date-time", + "type": "string" + }, + "profile": { + "description": "Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "properties": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/PropertyAffordance__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "description": "All Property-based interaction affordances of the Thing.", + "type": "object" + }, + "schemaDefinitions": { + "description": "TODO CHECK", + "items": { + "$ref": "#/$defs/DataSchema" + }, + "type": "array" + }, + "security": { + "description": "A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check", + "items": { + "type": "string" + }, + "type": "array" + }, + "securityDefinitions": { + "description": "A security scheme applied to a (set of) affordance(s). TODO check", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "$ref": "#/$defs/SecuritySchemeType" + } + ], + "type": "string" + }, + "type": "array" + }, + "supportContact": { + "description": "Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]).", + "type": "string" + }, + "title": { + "description": "Provides a human-readable title (e.g., display a text for UI representation) based on a default language.", + "type": "string" + }, + "titleInLanguage": { + "description": "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description.", + "type": "string" + }, + "titles": { + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/$defs/MultiLanguage__identifier_optional" + }, + { + "type": "null" + } + ] + }, + "type": "object" + }, + "version": { + "$ref": "#/$defs/VersionInfo" + } + }, + "required": [ + "id" + ], + "title": "Thing", + "type": "object" + }, + "VersionInfo": { + "additionalProperties": false, + "description": "Provides version information.", + "properties": { + "instance": { + "type": "string" + }, + "model": { + "type": "string" + } + }, + "required": [ + "instance" + ], + "title": "VersionInfo", + "type": "object" + } + }, + "$id": "td", + "$schema": "https://json-schema.org/draft/2019-09/schema", + "additionalProperties": true, + "metamodel_version": "1.7.0", + "title": "thing-description-schema", + "type": "object", + "version": null +} \ No newline at end of file diff --git a/resources/gens/markdown/@type.md b/resources/gens/markdown/@type.md new file mode 100644 index 0000000..510e4a3 --- /dev/null +++ b/resources/gens/markdown/@type.md @@ -0,0 +1,22 @@ + +# Slot: @type + + + +URI: [td:@type](https://www.w3.org/2019/wot/td#@type) + + +## Domain and Range + +None → <sub>0..\*</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [SecurityScheme](SecurityScheme.md) + * [Thing](Thing.md) diff --git a/resources/gens/markdown/ActionAffordance.md b/resources/gens/markdown/ActionAffordance.md new file mode 100644 index 0000000..7343552 --- /dev/null +++ b/resources/gens/markdown/ActionAffordance.md @@ -0,0 +1,72 @@ + +# Class: ActionAffordance + +An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time). + +URI: [td:ActionAffordance](https://www.w3.org/2019/wot/td#ActionAffordance) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage],[InteractionAffordance],[Form],[DataSchema],[DataSchema]<output%200..1-++[ActionAffordance|safe:boolean%20%3F;synchronous:boolean%20%3F;idempotent:boolean%20%3F;name(i):string],[DataSchema]<input%200..1-++[ActionAffordance],[Thing]++-%20actions%200..*>[ActionAffordance],[InteractionAffordance]^-[ActionAffordance],[Thing])](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage],[InteractionAffordance],[Form],[DataSchema],[DataSchema]<output%200..1-++[ActionAffordance|safe:boolean%20%3F;synchronous:boolean%20%3F;idempotent:boolean%20%3F;name(i):string],[DataSchema]<input%200..1-++[ActionAffordance],[Thing]++-%20actions%200..*>[ActionAffordance],[InteractionAffordance]^-[ActionAffordance],[Thing]) + +## Parents + + * is_a: [InteractionAffordance](InteractionAffordance.md) - TOOD + +## Referenced by Class + + * **None** *[âžžactions](thing__actions.md)* <sub>0..\*</sub> **[ActionAffordance](ActionAffordance.md)** + +## Attributes + + +### Own + + * [âžžsafe](actionAffordance__safe.md) <sub>0..1</sub> + * Description: Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action. + * Range: [Boolean](types/Boolean.md) + * [âžžsynchronous](actionAffordance__synchronous.md) <sub>0..1</sub> + * Description: Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made. + * Range: [Boolean](types/Boolean.md) + * [âžžidempotent](actionAffordance__idempotent.md) <sub>0..1</sub> + * Description: Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input. + * Range: [Boolean](types/Boolean.md) + * [âžžinput](actionAffordance__input.md) <sub>0..1</sub> + * Description: Used to define the input data schema of the action. + * Range: [DataSchema](DataSchema.md) + * [âžžoutput](actionAffordance__output.md) <sub>0..1</sub> + * Description: Used to define the output data schema of the action. + * Range: [DataSchema](DataSchema.md) + +### Inherited from InteractionAffordance: + + * [titles](titles.md) <sub>0..\*</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptions](descriptions.md) <sub>0..\*</sub> + * Description: TODO, check, according to the description a description should not contain a lang tag. + * Range: [MultiLanguage](MultiLanguage.md) + * [title](title.md) <sub>0..1</sub> + * Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * Range: [MultiLanguage](MultiLanguage.md) + * [description](description.md) <sub>0..1</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [titleInLanguage](titleInLanguage.md) <sub>0..1</sub> + * Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptionInLanguage](descriptionInLanguage.md) <sub>0..1</sub> + * Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžžname](interactionAffordance__name.md) <sub>1..1</sub> + * Description: Indexing property to store entity names when serializing them in a JSON-LD @index container. + * Range: [String](types/String.md) + * [âžžuriVariables](interactionAffordance__uriVariables.md) <sub>0..\*</sub> + * Description: Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. + * Range: [DataSchema](DataSchema.md) + * [âžžforms](interactionAffordance__forms.md) <sub>0..\*</sub> + * Description: Set of form hypermedia controls that describe how an operation can be performed. + * Range: [Form](Form.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:ActionAffordance | \ No newline at end of file diff --git a/resources/gens/markdown/AdditionalExpectedResponse.md b/resources/gens/markdown/AdditionalExpectedResponse.md new file mode 100644 index 0000000..a9fadc6 --- /dev/null +++ b/resources/gens/markdown/AdditionalExpectedResponse.md @@ -0,0 +1,44 @@ + +# Class: AdditionalExpectedResponse + +Communication metadata describing the expected response message for additional responses. + +URI: [td:AdditionalExpectedResponse](https://www.w3.org/2019/wot/td#AdditionalExpectedResponse) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[ExpectedResponse],[Form]++-%20additionalReturns%200..*>[AdditionalExpectedResponse|additionalOutputSchema:string%20%3F;success:boolean%20%3F;schema:string%20%3F;contentType(i):string],[ExpectedResponse]^-[AdditionalExpectedResponse],[Form])](https://yuml.me/diagram/nofunky;dir:TB/class/[ExpectedResponse],[Form]++-%20additionalReturns%200..*>[AdditionalExpectedResponse|additionalOutputSchema:string%20%3F;success:boolean%20%3F;schema:string%20%3F;contentType(i):string],[ExpectedResponse]^-[AdditionalExpectedResponse],[Form]) + +## Parents + + * is_a: [ExpectedResponse](ExpectedResponse.md) - Communication metadata describing the expected response message for the primary response. + +## Referenced by Class + + * **None** *[âžžadditionalReturns](form__additionalReturns.md)* <sub>0..\*</sub> **[AdditionalExpectedResponse](AdditionalExpectedResponse.md)** + +## Attributes + + +### Own + + * [âžžadditionalOutputSchema](additionalExpectedResponse__additionalOutputSchema.md) <sub>0..1</sub> + * Description: This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used. + * Range: [String](types/String.md) + * [âžžsuccess](additionalExpectedResponse__success.md) <sub>0..1</sub> + * Description: Signals if the additional response should not be considered an error. + * Range: [Boolean](types/Boolean.md) + * [âžžschema](additionalExpectedResponse__schema.md) <sub>0..1</sub> + * Description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + * Range: [String](types/String.md) + +### Inherited from ExpectedResponse: + + * [âžžcontentType](expectedResponse__contentType.md) <sub>1..1</sub> + * Description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + * Range: [String](types/String.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | hctl:AdditionalExpectedResponse | \ No newline at end of file diff --git a/resources/gens/markdown/DataSchema.md b/resources/gens/markdown/DataSchema.md new file mode 100644 index 0000000..c52aa37 --- /dev/null +++ b/resources/gens/markdown/DataSchema.md @@ -0,0 +1,56 @@ + +# Class: DataSchema + +Metadata that describes the data format used. It can be used for validation. + +URI: [td:DataSchema](https://www.w3.org/2019/wot/td#DataSchema) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage],[MultiLanguage]<descriptionInLanguage%200..1-%20[DataSchema|propertyName:string%20%3F;writeOnly:string%20%3F;readonly:string%20%3F],[MultiLanguage]<titleInLanguage%200..1-%20[DataSchema],[MultiLanguage]<title%200..1-%20[DataSchema],[MultiLanguage]<description%200..1-%20[DataSchema],[ActionAffordance]++-%20input%200..1>[DataSchema],[ActionAffordance]++-%20output%200..1>[DataSchema],[EventAffordance]++-%20cancellation%200..1>[DataSchema],[EventAffordance]++-%20notification%200..1>[DataSchema],[EventAffordance]++-%20notificationResponse%200..1>[DataSchema],[EventAffordance]++-%20subscription%200..1>[DataSchema],[InteractionAffordance]++-%20uriVariables%200..*>[DataSchema],[Thing]++-%20schemaDefinitions%200..*>[DataSchema],[PropertyAffordance]uses%20-.->[DataSchema],[Thing],[PropertyAffordance],[InteractionAffordance],[EventAffordance],[ActionAffordance])](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage],[MultiLanguage]<descriptionInLanguage%200..1-%20[DataSchema|propertyName:string%20%3F;writeOnly:string%20%3F;readonly:string%20%3F],[MultiLanguage]<titleInLanguage%200..1-%20[DataSchema],[MultiLanguage]<title%200..1-%20[DataSchema],[MultiLanguage]<description%200..1-%20[DataSchema],[ActionAffordance]++-%20input%200..1>[DataSchema],[ActionAffordance]++-%20output%200..1>[DataSchema],[EventAffordance]++-%20cancellation%200..1>[DataSchema],[EventAffordance]++-%20notification%200..1>[DataSchema],[EventAffordance]++-%20notificationResponse%200..1>[DataSchema],[EventAffordance]++-%20subscription%200..1>[DataSchema],[InteractionAffordance]++-%20uriVariables%200..*>[DataSchema],[Thing]++-%20schemaDefinitions%200..*>[DataSchema],[PropertyAffordance]uses%20-.->[DataSchema],[Thing],[PropertyAffordance],[InteractionAffordance],[EventAffordance],[ActionAffordance]) + +## Mixin for + + * [PropertyAffordance](PropertyAffordance.md) (mixin) - An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated. + +## Referenced by Class + + * **None** *[âžžinput](actionAffordance__input.md)* <sub>0..1</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžoutput](actionAffordance__output.md)* <sub>0..1</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžcancellation](eventAffordance__cancellation.md)* <sub>0..1</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžnotification](eventAffordance__notification.md)* <sub>0..1</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžnotificationResponse](eventAffordance__notificationResponse.md)* <sub>0..1</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžsubscription](eventAffordance__subscription.md)* <sub>0..1</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžuriVariables](interactionAffordance__uriVariables.md)* <sub>0..\*</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžschemaDefinitions](thing__schemaDefinitions.md)* <sub>0..\*</sub> **[DataSchema](DataSchema.md)** + +## Attributes + + +### Own + + * [description](description.md) <sub>0..1</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [title](title.md) <sub>0..1</sub> + * Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * Range: [MultiLanguage](MultiLanguage.md) + * [titleInLanguage](titleInLanguage.md) <sub>0..1</sub> + * Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptionInLanguage](descriptionInLanguage.md) <sub>0..1</sub> + * Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžžpropertyName](dataSchema__propertyName.md) <sub>0..1</sub> + * Description: Used to store the indexing name in the parent object when this schema appears as a property of an object schema. + * Range: [String](types/String.md) + * [âžžwriteOnly](dataSchema__writeOnly.md) <sub>0..1</sub> + * Description: Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false). + * Range: [String](types/String.md) + * [âžžreadonly](dataSchema__readonly.md) <sub>0..1</sub> + * Description: Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false). + * Range: [String](types/String.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | jsonschema:DataSchema | \ No newline at end of file diff --git a/resources/gens/markdown/EventAffordance.md b/resources/gens/markdown/EventAffordance.md new file mode 100644 index 0000000..f41facd --- /dev/null +++ b/resources/gens/markdown/EventAffordance.md @@ -0,0 +1,69 @@ + +# Class: EventAffordance + +An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts). + +URI: [td:EventAffordance](https://www.w3.org/2019/wot/td#EventAffordance) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage],[InteractionAffordance],[Form],[DataSchema]<notificationResponse%200..1-++[EventAffordance|name(i):string],[DataSchema]<notification%200..1-++[EventAffordance],[DataSchema]<cancellation%200..1-++[EventAffordance],[DataSchema]<subscription%200..1-++[EventAffordance],[Thing]++-%20events%200..*>[EventAffordance],[InteractionAffordance]^-[EventAffordance],[Thing],[DataSchema])](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage],[InteractionAffordance],[Form],[DataSchema]<notificationResponse%200..1-++[EventAffordance|name(i):string],[DataSchema]<notification%200..1-++[EventAffordance],[DataSchema]<cancellation%200..1-++[EventAffordance],[DataSchema]<subscription%200..1-++[EventAffordance],[Thing]++-%20events%200..*>[EventAffordance],[InteractionAffordance]^-[EventAffordance],[Thing],[DataSchema]) + +## Parents + + * is_a: [InteractionAffordance](InteractionAffordance.md) - TOOD + +## Referenced by Class + + * **None** *[âžževents](thing__events.md)* <sub>0..\*</sub> **[EventAffordance](EventAffordance.md)** + +## Attributes + + +### Own + + * [âžžsubscription](eventAffordance__subscription.md) <sub>0..1</sub> + * Description: Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks. + * Range: [DataSchema](DataSchema.md) + * [âžžcancellation](eventAffordance__cancellation.md) <sub>0..1</sub> + * Description: Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook. + * Range: [DataSchema](DataSchema.md) + * [âžžnotification](eventAffordance__notification.md) <sub>0..1</sub> + * Description: Defines the data schema of the Event instance messages pushed by the Thing. + * Range: [DataSchema](DataSchema.md) + * [âžžnotificationResponse](eventAffordance__notificationResponse.md) <sub>0..1</sub> + * Description: Defines the data schema of the Event response messages sent by the consumer in a response to a data message. + * Range: [DataSchema](DataSchema.md) + +### Inherited from InteractionAffordance: + + * [titles](titles.md) <sub>0..\*</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptions](descriptions.md) <sub>0..\*</sub> + * Description: TODO, check, according to the description a description should not contain a lang tag. + * Range: [MultiLanguage](MultiLanguage.md) + * [title](title.md) <sub>0..1</sub> + * Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * Range: [MultiLanguage](MultiLanguage.md) + * [description](description.md) <sub>0..1</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [titleInLanguage](titleInLanguage.md) <sub>0..1</sub> + * Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptionInLanguage](descriptionInLanguage.md) <sub>0..1</sub> + * Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžžname](interactionAffordance__name.md) <sub>1..1</sub> + * Description: Indexing property to store entity names when serializing them in a JSON-LD @index container. + * Range: [String](types/String.md) + * [âžžuriVariables](interactionAffordance__uriVariables.md) <sub>0..\*</sub> + * Description: Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. + * Range: [DataSchema](DataSchema.md) + * [âžžforms](interactionAffordance__forms.md) <sub>0..\*</sub> + * Description: Set of form hypermedia controls that describe how an operation can be performed. + * Range: [Form](Form.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:EventAffordance | \ No newline at end of file diff --git a/resources/gens/markdown/ExpectedResponse.md b/resources/gens/markdown/ExpectedResponse.md new file mode 100644 index 0000000..abcf512 --- /dev/null +++ b/resources/gens/markdown/ExpectedResponse.md @@ -0,0 +1,32 @@ + +# Class: ExpectedResponse + +Communication metadata describing the expected response message for the primary response. + +URI: [td:ExpectedResponse](https://www.w3.org/2019/wot/td#ExpectedResponse) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Form]++-%20returns%200..1>[ExpectedResponse|contentType:string],[ExpectedResponse]^-[AdditionalExpectedResponse],[Form],[AdditionalExpectedResponse])](https://yuml.me/diagram/nofunky;dir:TB/class/[Form]++-%20returns%200..1>[ExpectedResponse|contentType:string],[ExpectedResponse]^-[AdditionalExpectedResponse],[Form],[AdditionalExpectedResponse]) + +## Children + + * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) - Communication metadata describing the expected response message for additional responses. + +## Referenced by Class + + * **None** *[âžžreturns](form__returns.md)* <sub>0..1</sub> **[ExpectedResponse](ExpectedResponse.md)** + +## Attributes + + +### Own + + * [âžžcontentType](expectedResponse__contentType.md) <sub>1..1</sub> + * Description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + * Range: [String](types/String.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | hctl:ExpectedResponse | \ No newline at end of file diff --git a/resources/gens/markdown/Form.md b/resources/gens/markdown/Form.md new file mode 100644 index 0000000..748c7b5 --- /dev/null +++ b/resources/gens/markdown/Form.md @@ -0,0 +1,55 @@ + +# Class: Form + +A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions. + +URI: [td:Form](https://www.w3.org/2019/wot/td#Form) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[AdditionalExpectedResponse]<additionalReturns%200..*-++[Form|target:anyUri;href:anyUri;contentType:string%20%3F;contentCoding:string%20%3F;securityDefinitions:string%20%3F;scopes:string%20%3F;subprotocol:string%20%3F;operationType:OperationTypes%20*],[ExpectedResponse]<returns%200..1-++[Form],[InteractionAffordance]++-%20forms%200..*>[Form],[Thing]++-%20forms%200..*>[Form],[Thing],[InteractionAffordance],[ExpectedResponse],[AdditionalExpectedResponse])](https://yuml.me/diagram/nofunky;dir:TB/class/[AdditionalExpectedResponse]<additionalReturns%200..*-++[Form|target:anyUri;href:anyUri;contentType:string%20%3F;contentCoding:string%20%3F;securityDefinitions:string%20%3F;scopes:string%20%3F;subprotocol:string%20%3F;operationType:OperationTypes%20*],[ExpectedResponse]<returns%200..1-++[Form],[InteractionAffordance]++-%20forms%200..*>[Form],[Thing]++-%20forms%200..*>[Form],[Thing],[InteractionAffordance],[ExpectedResponse],[AdditionalExpectedResponse]) + +## Referenced by Class + + * **None** *[âžžforms](interactionAffordance__forms.md)* <sub>0..\*</sub> **[Form](Form.md)** + * **None** *[âžžforms](thing__forms.md)* <sub>0..\*</sub> **[Form](Form.md)** + +## Attributes + + +### Own + + * [target](target.md) <sub>1..1</sub> + * Description: Target IRI of a link or submission target of a Form + * Range: [AnyUri](types/AnyUri.md) + * [âžžhref](form__href.md) <sub>1..1</sub> + * Range: [AnyUri](types/AnyUri.md) + * [âžžcontentType](form__contentType.md) <sub>0..1</sub> + * Description: Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type. + * Range: [String](types/String.md) + * [âžžcontentCoding](form__contentCoding.md) <sub>0..1</sub> + * Description: Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \"gzip\", \"deflate\", etc. + * Range: [String](types/String.md) + * [âžžsecurityDefinitions](form__securityDefinitions.md) <sub>0..1</sub> + * Description: A security schema applied to a (set of) affordance(s). + * Range: [String](types/String.md) + * [âžžscopes](form__scopes.md) <sub>0..1</sub> + * Description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + * Range: [String](types/String.md) + * [âžžreturns](form__returns.md) <sub>0..1</sub> + * Description: This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages. + * Range: [ExpectedResponse](ExpectedResponse.md) + * [âžžadditionalReturns](form__additionalReturns.md) <sub>0..\*</sub> + * Description: This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema. + * Range: [AdditionalExpectedResponse](AdditionalExpectedResponse.md) + * [âžžsubprotocol](form__subprotocol.md) <sub>0..1</sub> + * Description: Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options. + * Range: [String](types/String.md) + * [âžžoperationType](form__operationType.md) <sub>0..\*</sub> + * Description: Indicates the semantic intention of performing the operation(s) described by the form. + * Range: [OperationTypes](OperationTypes.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | hctl:Form | \ No newline at end of file diff --git a/resources/gens/markdown/InteractionAffordance.md b/resources/gens/markdown/InteractionAffordance.md new file mode 100644 index 0000000..988758b --- /dev/null +++ b/resources/gens/markdown/InteractionAffordance.md @@ -0,0 +1,55 @@ + +# Class: InteractionAffordance + +TOOD + +URI: [td:InteractionAffordance](https://www.w3.org/2019/wot/td#InteractionAffordance) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[PropertyAffordance],[MultiLanguage],[Form]<forms%200..*-++[InteractionAffordance|name:string],[DataSchema]<uriVariables%200..*-++[InteractionAffordance],[MultiLanguage]<descriptionInLanguage%200..1-%20[InteractionAffordance],[MultiLanguage]<titleInLanguage%200..1-%20[InteractionAffordance],[MultiLanguage]<description%200..1-%20[InteractionAffordance],[MultiLanguage]<title%200..1-%20[InteractionAffordance],[MultiLanguage]<descriptions%200..*-++[InteractionAffordance],[MultiLanguage]<titles%200..*-++[InteractionAffordance],[InteractionAffordance]^-[PropertyAffordance],[InteractionAffordance]^-[EventAffordance],[InteractionAffordance]^-[ActionAffordance],[Form],[EventAffordance],[DataSchema],[ActionAffordance])](https://yuml.me/diagram/nofunky;dir:TB/class/[PropertyAffordance],[MultiLanguage],[Form]<forms%200..*-++[InteractionAffordance|name:string],[DataSchema]<uriVariables%200..*-++[InteractionAffordance],[MultiLanguage]<descriptionInLanguage%200..1-%20[InteractionAffordance],[MultiLanguage]<titleInLanguage%200..1-%20[InteractionAffordance],[MultiLanguage]<description%200..1-%20[InteractionAffordance],[MultiLanguage]<title%200..1-%20[InteractionAffordance],[MultiLanguage]<descriptions%200..*-++[InteractionAffordance],[MultiLanguage]<titles%200..*-++[InteractionAffordance],[InteractionAffordance]^-[PropertyAffordance],[InteractionAffordance]^-[EventAffordance],[InteractionAffordance]^-[ActionAffordance],[Form],[EventAffordance],[DataSchema],[ActionAffordance]) + +## Children + + * [ActionAffordance](ActionAffordance.md) - An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time). + * [EventAffordance](EventAffordance.md) - An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts). + * [PropertyAffordance](PropertyAffordance.md) - An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated. + +## Referenced by Class + + +## Attributes + + +### Own + + * [titles](titles.md) <sub>0..\*</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptions](descriptions.md) <sub>0..\*</sub> + * Description: TODO, check, according to the description a description should not contain a lang tag. + * Range: [MultiLanguage](MultiLanguage.md) + * [title](title.md) <sub>0..1</sub> + * Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * Range: [MultiLanguage](MultiLanguage.md) + * [description](description.md) <sub>0..1</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [titleInLanguage](titleInLanguage.md) <sub>0..1</sub> + * Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptionInLanguage](descriptionInLanguage.md) <sub>0..1</sub> + * Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžžname](interactionAffordance__name.md) <sub>1..1</sub> + * Description: Indexing property to store entity names when serializing them in a JSON-LD @index container. + * Range: [String](types/String.md) + * [âžžuriVariables](interactionAffordance__uriVariables.md) <sub>0..\*</sub> + * Description: Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. + * Range: [DataSchema](DataSchema.md) + * [âžžforms](interactionAffordance__forms.md) <sub>0..\*</sub> + * Description: Set of form hypermedia controls that describe how an operation can be performed. + * Range: [Form](Form.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:InteractionAffordance | \ No newline at end of file diff --git a/resources/gens/markdown/Link.md b/resources/gens/markdown/Link.md new file mode 100644 index 0000000..a64fb59 --- /dev/null +++ b/resources/gens/markdown/Link.md @@ -0,0 +1,45 @@ + +# Class: Link + +A link can be viewed as a statement of the form link context that has a relation type resource at link target", where the optional target attributes may further describe the resource. + +URI: [td:Link](https://www.w3.org/2019/wot/td#Link) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Thing]++-%20links%200..*>[Link|target:anyUri;hintsAtMediaType:string%20%3F;type:string%20%3F;relation:string%20%3F;anchor:anyUri%20%3F;sizes:string%20%3F;hreflang:string%20%3F],[Thing])](https://yuml.me/diagram/nofunky;dir:TB/class/[Thing]++-%20links%200..*>[Link|target:anyUri;hintsAtMediaType:string%20%3F;type:string%20%3F;relation:string%20%3F;anchor:anyUri%20%3F;sizes:string%20%3F;hreflang:string%20%3F],[Thing]) + +## Referenced by Class + + * **None** *[âžžlinks](thing__links.md)* <sub>0..\*</sub> **[Link](Link.md)** + +## Attributes + + +### Own + + * [target](target.md) <sub>1..1</sub> + * Description: Target IRI of a link or submission target of a Form + * Range: [AnyUri](types/AnyUri.md) + * [âžžhintsAtMediaType](link__hintsAtMediaType.md) <sub>0..1</sub> + * Description: Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. + * Range: [String](types/String.md) + * [âžžtype](link__type.md) <sub>0..1</sub> + * Range: [String](types/String.md) + * [âžžrelation](link__relation.md) <sub>0..1</sub> + * Description: A link relation type identifies the semantics of a link. + * Range: [String](types/String.md) + * [âžžanchor](link__anchor.md) <sub>0..1</sub> + * Description: By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI. + * Range: [AnyUri](types/AnyUri.md) + * [âžžsizes](link__sizes.md) <sub>0..1</sub> + * Description: Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \"16x16\", \"16x16 32x32\"). + * Range: [String](types/String.md) + * [âžžhreflang](link__hreflang.md) <sub>0..1</sub> + * Description: The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]. + * Range: [String](types/String.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | hctl:Link | \ No newline at end of file diff --git a/resources/gens/markdown/MultiLanguage.md b/resources/gens/markdown/MultiLanguage.md new file mode 100644 index 0000000..2a67d79 --- /dev/null +++ b/resources/gens/markdown/MultiLanguage.md @@ -0,0 +1,26 @@ + +# Class: MultiLanguage + + + +URI: [td:MultiLanguage](https://www.w3.org/2019/wot/td#MultiLanguage) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[DataSchema]-%20description%200..1>[MultiLanguage|key:string],[InteractionAffordance]-%20description%200..1>[MultiLanguage],[Thing]-%20description%200..1>[MultiLanguage],[DataSchema]-%20descriptionInLanguage%200..1>[MultiLanguage],[InteractionAffordance]-%20descriptionInLanguage%200..1>[MultiLanguage],[Thing]-%20descriptionInLanguage%200..1>[MultiLanguage],[SecurityScheme]++-%20descriptions%200..*>[MultiLanguage],[InteractionAffordance]++-%20descriptions%200..*>[MultiLanguage],[Thing]++-%20descriptions%200..*>[MultiLanguage],[DataSchema]-%20title%200..1>[MultiLanguage],[InteractionAffordance]-%20title%200..1>[MultiLanguage],[Thing]-%20title%200..1>[MultiLanguage],[DataSchema]-%20titleInLanguage%200..1>[MultiLanguage],[InteractionAffordance]-%20titleInLanguage%200..1>[MultiLanguage],[Thing]-%20titleInLanguage%200..1>[MultiLanguage],[InteractionAffordance]++-%20titles%200..*>[MultiLanguage],[Thing]++-%20titles%200..*>[MultiLanguage],[Thing],[SecurityScheme],[InteractionAffordance],[DataSchema])](https://yuml.me/diagram/nofunky;dir:TB/class/[DataSchema]-%20description%200..1>[MultiLanguage|key:string],[InteractionAffordance]-%20description%200..1>[MultiLanguage],[Thing]-%20description%200..1>[MultiLanguage],[DataSchema]-%20descriptionInLanguage%200..1>[MultiLanguage],[InteractionAffordance]-%20descriptionInLanguage%200..1>[MultiLanguage],[Thing]-%20descriptionInLanguage%200..1>[MultiLanguage],[SecurityScheme]++-%20descriptions%200..*>[MultiLanguage],[InteractionAffordance]++-%20descriptions%200..*>[MultiLanguage],[Thing]++-%20descriptions%200..*>[MultiLanguage],[DataSchema]-%20title%200..1>[MultiLanguage],[InteractionAffordance]-%20title%200..1>[MultiLanguage],[Thing]-%20title%200..1>[MultiLanguage],[DataSchema]-%20titleInLanguage%200..1>[MultiLanguage],[InteractionAffordance]-%20titleInLanguage%200..1>[MultiLanguage],[Thing]-%20titleInLanguage%200..1>[MultiLanguage],[InteractionAffordance]++-%20titles%200..*>[MultiLanguage],[Thing]++-%20titles%200..*>[MultiLanguage],[Thing],[SecurityScheme],[InteractionAffordance],[DataSchema]) + +## Referenced by Class + + * **None** *[description](description.md)* <sub>0..1</sub> **[MultiLanguage](MultiLanguage.md)** + * **None** *[descriptionInLanguage](descriptionInLanguage.md)* <sub>0..1</sub> **[MultiLanguage](MultiLanguage.md)** + * **None** *[descriptions](descriptions.md)* <sub>0..\*</sub> **[MultiLanguage](MultiLanguage.md)** + * **None** *[title](title.md)* <sub>0..1</sub> **[MultiLanguage](MultiLanguage.md)** + * **None** *[titleInLanguage](titleInLanguage.md)* <sub>0..1</sub> **[MultiLanguage](MultiLanguage.md)** + * **None** *[titles](titles.md)* <sub>0..\*</sub> **[MultiLanguage](MultiLanguage.md)** + +## Attributes + + +### Own + + * [âžžkey](multiLanguage__key.md) <sub>1..1</sub> + * Range: [String](types/String.md) diff --git a/resources/gens/markdown/OperationTypes.md b/resources/gens/markdown/OperationTypes.md new file mode 100644 index 0000000..fb03a82 --- /dev/null +++ b/resources/gens/markdown/OperationTypes.md @@ -0,0 +1,31 @@ + +# Enum: OperationTypes + +Enumerations of well-known operation types necessary to implement the WoT interaction model. + +URI: [td:OperationTypes](https://www.w3.org/2019/wot/td#OperationTypes) + + +## Permissible Values + +| Text | Description | Meaning | Other Information | +| :--- | :---: | :---: | ---: | +| readproperty | Identifies the read operation on Property Affordances to retrieve the corresponding data. | td:readProperty | | +| writeproperty | Identifies the write operation on Property Affordances to update the corresponding data. | td:writeProperty | | +| observeproperty | Identifies the observe operation on Property Affordances to be notified with the new data when the Property is updated. | td:observeProperty | | +| unobserveproperty | Identifies the unobserve operation on Property Affordances to stop the corresponding notifications. | td:unobserveProperty | | +| invokeaction | Identifies the invoke operation on Action Affordances to perform the corresponding action. | td:invokeAction | | +| queryaction | Identifies the querying operation on Action Affordances to get the status of the corresponding action. | td:queryAction | | +| cancelaction | Identifies the cancel operation on Action Affordances to cancel the ongoing corresponding action. | td:cancelAction | | +| subscribeevent | Identifies the subscribe operation on Event Affordances to be notified by the Thing when the event occurs. | td:subscribeEvent | | +| unsubscribeevent | Identifies the unsubscribe operation on Event Affordances to stop the corresponding notifications. | td:unsubscribeEvent | | +| readallproperties | Identifies the readallproperties operation on a Thing to retrieve the data of all Properties in a single interaction. | td:readAllProperties | | +| writeallproperties | Identifies the writeallproperties operation on a Thing to update the data of all writable Properties in a single interaction. | writeAllProperties | | +| readmultipleproperties | Identifies the readmultipleproperties operation on a Thing to retrieve the data of selected Properties in a single interaction. | td:readMultipleProperties | | +| writemultipleproperties | Identifies the writemultipleproperties operation on a Thing to update the data of selected writable Properties in a single interaction. | td:writeMultipleProperties | | +| observeallproperties | Identifies the observeallproperties operation on Properties to be notified with new data when any Property is updated. | td:observeAllProperties | | +| unobserveallproperties | Identifies the unobserveallproperties operation on Properties to stop notifications from all Properties in a single interaction. | td:unobserveAllProperties | | +| subscribeallevents | Identifies the subscribeallevents operation on Events to subscribe to notifications from all Events in a single interaction. | td:subscribeAllEvents | | +| unsubscribeallevents | Identifies the unsubscribeallevents operation on Events to unsubscribe from notifications from all Events in a single interaction. | td:unsubscribeAllEvents | | +| queryallactions | Identifies the queryallactions operation on a Thing to get the status of all Actions in a single interaction. | td:queryAllActions | | + diff --git a/resources/gens/markdown/PropertyAffordance.md b/resources/gens/markdown/PropertyAffordance.md new file mode 100644 index 0000000..be087b1 --- /dev/null +++ b/resources/gens/markdown/PropertyAffordance.md @@ -0,0 +1,82 @@ + +# Class: PropertyAffordance + +An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated. + +URI: [td:PropertyAffordance](https://www.w3.org/2019/wot/td#PropertyAffordance) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Thing]++-%20properties%200..*>[PropertyAffordance|observable:boolean%20%3F;propertyName:string%20%3F;writeOnly:string%20%3F;readonly:string%20%3F;name(i):string],[PropertyAffordance]uses%20-.->[DataSchema],[InteractionAffordance]^-[PropertyAffordance],[Thing],[MultiLanguage],[InteractionAffordance],[Form],[DataSchema])](https://yuml.me/diagram/nofunky;dir:TB/class/[Thing]++-%20properties%200..*>[PropertyAffordance|observable:boolean%20%3F;propertyName:string%20%3F;writeOnly:string%20%3F;readonly:string%20%3F;name(i):string],[PropertyAffordance]uses%20-.->[DataSchema],[InteractionAffordance]^-[PropertyAffordance],[Thing],[MultiLanguage],[InteractionAffordance],[Form],[DataSchema]) + +## Parents + + * is_a: [InteractionAffordance](InteractionAffordance.md) - TOOD + +## Uses Mixin + + * mixin: [DataSchema](DataSchema.md) - Metadata that describes the data format used. It can be used for validation. + +## Referenced by Class + + * **None** *[âžžproperties](thing__properties.md)* <sub>0..\*</sub> **[PropertyAffordance](PropertyAffordance.md)** + +## Attributes + + +### Own + + * [âžžobservable](propertyAffordance__observable.md) <sub>0..1</sub> + * Description: A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property. + * Range: [Boolean](types/Boolean.md) + +### Inherited from InteractionAffordance: + + * [titles](titles.md) <sub>0..\*</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptions](descriptions.md) <sub>0..\*</sub> + * Description: TODO, check, according to the description a description should not contain a lang tag. + * Range: [MultiLanguage](MultiLanguage.md) + * [title](title.md) <sub>0..1</sub> + * Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * Range: [MultiLanguage](MultiLanguage.md) + * [description](description.md) <sub>0..1</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [titleInLanguage](titleInLanguage.md) <sub>0..1</sub> + * Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptionInLanguage](descriptionInLanguage.md) <sub>0..1</sub> + * Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžžname](interactionAffordance__name.md) <sub>1..1</sub> + * Description: Indexing property to store entity names when serializing them in a JSON-LD @index container. + * Range: [String](types/String.md) + * [âžžuriVariables](interactionAffordance__uriVariables.md) <sub>0..\*</sub> + * Description: Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. + * Range: [DataSchema](DataSchema.md) + * [âžžforms](interactionAffordance__forms.md) <sub>0..\*</sub> + * Description: Set of form hypermedia controls that describe how an operation can be performed. + * Range: [Form](Form.md) + +### Mixed in from DataSchema: + + * [âžžpropertyName](dataSchema__propertyName.md) <sub>0..1</sub> + * Description: Used to store the indexing name in the parent object when this schema appears as a property of an object schema. + * Range: [String](types/String.md) + +### Mixed in from DataSchema: + + * [âžžwriteOnly](dataSchema__writeOnly.md) <sub>0..1</sub> + * Description: Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false). + * Range: [String](types/String.md) + +### Mixed in from DataSchema: + + * [âžžreadonly](dataSchema__readonly.md) <sub>0..1</sub> + * Description: Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false). + * Range: [String](types/String.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:PropertyAffordance | \ No newline at end of file diff --git a/resources/gens/markdown/SecurityScheme.md b/resources/gens/markdown/SecurityScheme.md new file mode 100644 index 0000000..96bfecd --- /dev/null +++ b/resources/gens/markdown/SecurityScheme.md @@ -0,0 +1,27 @@ + +# Class: SecurityScheme + + + +URI: [td:SecurityScheme](https://www.w3.org/2019/wot/td#SecurityScheme) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage]<descriptions%200..*-++[SecurityScheme|@type:string%20*;description:string%20%3F;proxy:anyUri%20%3F;scheme:SecuritySchemeType],[MultiLanguage])](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage]<descriptions%200..*-++[SecurityScheme|@type:string%20*;description:string%20%3F;proxy:anyUri%20%3F;scheme:SecuritySchemeType],[MultiLanguage]) + +## Attributes + + +### Own + + * [@type](@type.md) <sub>0..\*</sub> + * Range: [String](types/String.md) + * [descriptions](descriptions.md) <sub>0..\*</sub> + * Description: TODO, check, according to the description a description should not contain a lang tag. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžždescription](securityScheme__description.md) <sub>0..1</sub> + * Range: [String](types/String.md) + * [âžžproxy](securityScheme__proxy.md) <sub>0..1</sub> + * Description: URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint. + * Range: [AnyUri](types/AnyUri.md) + * [âžžscheme](securityScheme__scheme.md) <sub>1..1</sub> + * Range: [SecuritySchemeType](SecuritySchemeType.md) diff --git a/resources/gens/markdown/SecuritySchemeType.md b/resources/gens/markdown/SecuritySchemeType.md new file mode 100644 index 0000000..ff39e28 --- /dev/null +++ b/resources/gens/markdown/SecuritySchemeType.md @@ -0,0 +1,22 @@ + +# Enum: SecuritySchemeType + + + +URI: [td:SecuritySchemeType](https://www.w3.org/2019/wot/td#SecuritySchemeType) + + +## Permissible Values + +| Text | Description | Meaning | Other Information | +| :--- | :---: | :---: | ---: | +| nosec | A security configuration corresponding to identified by the Vocabulary Term nosec, indicating there is no authentication or other mechanism required to access the resource. | wotsec:NoSecurityScheme | | +| combo | Elements of this scheme define various ways in which other named schemes defined in securityDefinitions, including other ComboSecurityScheme definitions, are to be combined to create a new scheme definition. | wotsec:ComboSecurityScheme | | +| basic | Uses an unencrypted username and password. | wotsec:BasicSecurityScheme | | +| digest | This scheme is similar to basic authentication but with added features to avoid man-in-the-middle attacks. | wotsec:DigestSecurityScheme | | +| bearer | Bearer tokens are used independently of OAuth2. | wotsec:BearerSecurityScheme | | +| psk | This is meant to identify that a standard is used for pre-shared keys such as TLS-PSK [RFC4279], and that the ciphersuite used for keys will be established during protocol negotiation. | wotsec:PSKSecurityScheme | | +| oauth2 | OAuth 2.0 authentication security configuration for systems conformant with [RFC6749] and [RFC8252]. | wotsec:OAuth2SecurityScheme | | +| apikey | This scheme is to be used when the access token is opaque. | wotsec:APIKeySecurityScheme | | +| auto | This scheme indicates that the security parameters are going to be negotiated by the underlying protocols at runtime | wotsec:AutoSecurityScheme | | + diff --git a/resources/gens/markdown/Thing.md b/resources/gens/markdown/Thing.md new file mode 100644 index 0000000..e041add --- /dev/null +++ b/resources/gens/markdown/Thing.md @@ -0,0 +1,86 @@ + +# Class: Thing + +An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things. + +URI: [td:Thing](https://www.w3.org/2019/wot/td#Thing) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[VersionInfo],[EventAffordance]<events%200..*-++[Thing|id:anyUri;@type:string%20*;securityDefinitions:string%20*;security:string%20*;profile:anyUri%20*;instance:string%20%3F;created:datetime%20%3F;modified:datetime%20%3F;supportContact:anyUri%20%3F;base:anyUri%20%3F],[ActionAffordance]<actions%200..*-++[Thing],[PropertyAffordance]<properties%200..*-++[Thing],[Link]<links%200..*-++[Thing],[Form]<forms%200..*-++[Thing],[VersionInfo]<version%200..1-++[Thing],[DataSchema]<schemaDefinitions%200..*-++[Thing],[MultiLanguage]<descriptionInLanguage%200..1-%20[Thing],[MultiLanguage]<titleInLanguage%200..1-%20[Thing],[MultiLanguage]<descriptions%200..*-++[Thing],[MultiLanguage]<titles%200..*-++[Thing],[MultiLanguage]<description%200..1-%20[Thing],[MultiLanguage]<title%200..1-%20[Thing],[PropertyAffordance],[MultiLanguage],[Link],[Form],[EventAffordance],[DataSchema],[ActionAffordance])](https://yuml.me/diagram/nofunky;dir:TB/class/[VersionInfo],[EventAffordance]<events%200..*-++[Thing|id:anyUri;@type:string%20*;securityDefinitions:string%20*;security:string%20*;profile:anyUri%20*;instance:string%20%3F;created:datetime%20%3F;modified:datetime%20%3F;supportContact:anyUri%20%3F;base:anyUri%20%3F],[ActionAffordance]<actions%200..*-++[Thing],[PropertyAffordance]<properties%200..*-++[Thing],[Link]<links%200..*-++[Thing],[Form]<forms%200..*-++[Thing],[VersionInfo]<version%200..1-++[Thing],[DataSchema]<schemaDefinitions%200..*-++[Thing],[MultiLanguage]<descriptionInLanguage%200..1-%20[Thing],[MultiLanguage]<titleInLanguage%200..1-%20[Thing],[MultiLanguage]<descriptions%200..*-++[Thing],[MultiLanguage]<titles%200..*-++[Thing],[MultiLanguage]<description%200..1-%20[Thing],[MultiLanguage]<title%200..1-%20[Thing],[PropertyAffordance],[MultiLanguage],[Link],[Form],[EventAffordance],[DataSchema],[ActionAffordance]) + +## Attributes + + +### Own + + * [id](id.md) <sub>1..1</sub> + * Description: TODO + * Range: [AnyUri](types/AnyUri.md) + * [title](title.md) <sub>0..1</sub> + * Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * Range: [MultiLanguage](MultiLanguage.md) + * [description](description.md) <sub>0..1</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [titles](titles.md) <sub>0..\*</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptions](descriptions.md) <sub>0..\*</sub> + * Description: TODO, check, according to the description a description should not contain a lang tag. + * Range: [MultiLanguage](MultiLanguage.md) + * [@type](@type.md) <sub>0..\*</sub> + * Range: [String](types/String.md) + * [titleInLanguage](titleInLanguage.md) <sub>0..1</sub> + * Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptionInLanguage](descriptionInLanguage.md) <sub>0..1</sub> + * Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžžsecurityDefinitions](thing__securityDefinitions.md) <sub>0..\*</sub> + * Description: A security scheme applied to a (set of) affordance(s). TODO check + * Range: [String](types/String.md) + * [âžžsecurity](thing__security.md) <sub>0..\*</sub> + * Description: A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check + * Range: [String](types/String.md) + * [âžžschemaDefinitions](thing__schemaDefinitions.md) <sub>0..\*</sub> + * Description: TODO CHECK + * Range: [DataSchema](DataSchema.md) + * [âžžprofile](thing__profile.md) <sub>0..\*</sub> + * Description: Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation. + * Range: [AnyUri](types/AnyUri.md) + * [âžžinstance](thing__instance.md) <sub>0..1</sub> + * Description: Provides a version identicator of this TD instance. + * Range: [String](types/String.md) + * [âžžcreated](thing__created.md) <sub>0..1</sub> + * Description: Provides information when the TD instance was created. + * Range: [Datetime](types/Datetime.md) + * [âžžmodified](thing__modified.md) <sub>0..1</sub> + * Description: Provides information when the TD instance was last modified. + * Range: [Datetime](types/Datetime.md) + * [âžžsupportContact](thing__supportContact.md) <sub>0..1</sub> + * Description: Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]). + * Range: [AnyUri](types/AnyUri.md) + * [âžžbase](thing__base.md) <sub>0..1</sub> + * Description: Define the base URI that is used for all relative URI references throughout a TD document. + * Range: [AnyUri](types/AnyUri.md) + * [âžžversion](thing__version.md) <sub>0..1</sub> + * Range: [VersionInfo](VersionInfo.md) + * [âžžforms](thing__forms.md) <sub>0..\*</sub> + * Description: Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings. + * Range: [Form](Form.md) + * [âžžlinks](thing__links.md) <sub>0..\*</sub> + * Description: Provides Web links to arbitrary resources that relate to the specified Thing Description. + * Range: [Link](Link.md) + * [âžžproperties](thing__properties.md) <sub>0..\*</sub> + * Description: All Property-based interaction affordances of the Thing. + * Range: [PropertyAffordance](PropertyAffordance.md) + * [âžžactions](thing__actions.md) <sub>0..\*</sub> + * Description: All Action-based interaction affordances of the Thing. + * Range: [ActionAffordance](ActionAffordance.md) + * [âžževents](thing__events.md) <sub>0..\*</sub> + * Description: All Event-based interaction affordances of the Thing. + * Range: [EventAffordance](EventAffordance.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:Thing | \ No newline at end of file diff --git a/resources/gens/markdown/VersionInfo.md b/resources/gens/markdown/VersionInfo.md new file mode 100644 index 0000000..69f9780 --- /dev/null +++ b/resources/gens/markdown/VersionInfo.md @@ -0,0 +1,29 @@ + +# Class: VersionInfo + +Provides version information. + +URI: [td:VersionInfo](https://www.w3.org/2019/wot/td#VersionInfo) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Thing]++-%20version%200..1>[VersionInfo|instance:string;model:string%20%3F],[Thing])](https://yuml.me/diagram/nofunky;dir:TB/class/[Thing]++-%20version%200..1>[VersionInfo|instance:string;model:string%20%3F],[Thing]) + +## Referenced by Class + + * **None** *[âžžversion](thing__version.md)* <sub>0..1</sub> **[VersionInfo](VersionInfo.md)** + +## Attributes + + +### Own + + * [âžžinstance](versionInfo__instance.md) <sub>1..1</sub> + * Range: [String](types/String.md) + * [âžžmodel](versionInfo__model.md) <sub>0..1</sub> + * Range: [String](types/String.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | schema:version | \ No newline at end of file diff --git a/resources/gens/markdown/actionAffordance__idempotent.md b/resources/gens/markdown/actionAffordance__idempotent.md new file mode 100644 index 0000000..d60b7c9 --- /dev/null +++ b/resources/gens/markdown/actionAffordance__idempotent.md @@ -0,0 +1,21 @@ + +# Slot: idempotent + +Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input. + +URI: [td:actionAffordance__idempotent](https://www.w3.org/2019/wot/td#actionAffordance__idempotent) + + +## Domain and Range + +None → <sub>0..1</sub> [Boolean](types/Boolean.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) diff --git a/resources/gens/markdown/actionAffordance__input.md b/resources/gens/markdown/actionAffordance__input.md new file mode 100644 index 0000000..a1b65d9 --- /dev/null +++ b/resources/gens/markdown/actionAffordance__input.md @@ -0,0 +1,21 @@ + +# Slot: input + +Used to define the input data schema of the action. + +URI: [td:actionAffordance__input](https://www.w3.org/2019/wot/td#actionAffordance__input) + + +## Domain and Range + +None → <sub>0..1</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) diff --git a/resources/gens/markdown/actionAffordance__output.md b/resources/gens/markdown/actionAffordance__output.md new file mode 100644 index 0000000..1e3a849 --- /dev/null +++ b/resources/gens/markdown/actionAffordance__output.md @@ -0,0 +1,21 @@ + +# Slot: output + +Used to define the output data schema of the action. + +URI: [td:actionAffordance__output](https://www.w3.org/2019/wot/td#actionAffordance__output) + + +## Domain and Range + +None → <sub>0..1</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) diff --git a/resources/gens/markdown/actionAffordance__safe.md b/resources/gens/markdown/actionAffordance__safe.md new file mode 100644 index 0000000..9de94be --- /dev/null +++ b/resources/gens/markdown/actionAffordance__safe.md @@ -0,0 +1,21 @@ + +# Slot: safe + +Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action. + +URI: [td:actionAffordance__safe](https://www.w3.org/2019/wot/td#actionAffordance__safe) + + +## Domain and Range + +None → <sub>0..1</sub> [Boolean](types/Boolean.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) diff --git a/resources/gens/markdown/actionAffordance__synchronous.md b/resources/gens/markdown/actionAffordance__synchronous.md new file mode 100644 index 0000000..7ef11a2 --- /dev/null +++ b/resources/gens/markdown/actionAffordance__synchronous.md @@ -0,0 +1,21 @@ + +# Slot: synchronous + +Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made. + +URI: [td:actionAffordance__synchronous](https://www.w3.org/2019/wot/td#actionAffordance__synchronous) + + +## Domain and Range + +None → <sub>0..1</sub> [Boolean](types/Boolean.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) diff --git a/resources/gens/markdown/additionalExpectedResponse__additionalOutputSchema.md b/resources/gens/markdown/additionalExpectedResponse__additionalOutputSchema.md new file mode 100644 index 0000000..0dec557 --- /dev/null +++ b/resources/gens/markdown/additionalExpectedResponse__additionalOutputSchema.md @@ -0,0 +1,21 @@ + +# Slot: additionalOutputSchema + +This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used. + +URI: [td:additionalExpectedResponse__additionalOutputSchema](https://www.w3.org/2019/wot/td#additionalExpectedResponse__additionalOutputSchema) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) diff --git a/resources/gens/markdown/additionalExpectedResponse__schema.md b/resources/gens/markdown/additionalExpectedResponse__schema.md new file mode 100644 index 0000000..6020d92 --- /dev/null +++ b/resources/gens/markdown/additionalExpectedResponse__schema.md @@ -0,0 +1,21 @@ + +# Slot: schema + +TODO Check, was not in hctl ontology, if not could be source of discrepancy + +URI: [td:additionalExpectedResponse__schema](https://www.w3.org/2019/wot/td#additionalExpectedResponse__schema) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) diff --git a/resources/gens/markdown/additionalExpectedResponse__success.md b/resources/gens/markdown/additionalExpectedResponse__success.md new file mode 100644 index 0000000..a3967c6 --- /dev/null +++ b/resources/gens/markdown/additionalExpectedResponse__success.md @@ -0,0 +1,21 @@ + +# Slot: success + +Signals if the additional response should not be considered an error. + +URI: [td:additionalExpectedResponse__success](https://www.w3.org/2019/wot/td#additionalExpectedResponse__success) + + +## Domain and Range + +None → <sub>0..1</sub> [Boolean](types/Boolean.md) + +## Parents + + +## Children + + +## Used by + + * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) diff --git a/resources/gens/markdown/dataSchema__propertyName.md b/resources/gens/markdown/dataSchema__propertyName.md new file mode 100644 index 0000000..60e813b --- /dev/null +++ b/resources/gens/markdown/dataSchema__propertyName.md @@ -0,0 +1,22 @@ + +# Slot: propertyName + +Used to store the indexing name in the parent object when this schema appears as a property of an object schema. + +URI: [td:dataSchema__propertyName](https://www.w3.org/2019/wot/td#dataSchema__propertyName) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [DataSchema](DataSchema.md) + * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/markdown/dataSchema__readonly.md b/resources/gens/markdown/dataSchema__readonly.md new file mode 100644 index 0000000..5f09bfd --- /dev/null +++ b/resources/gens/markdown/dataSchema__readonly.md @@ -0,0 +1,22 @@ + +# Slot: readonly + +Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false). + +URI: [td:dataSchema__readonly](https://www.w3.org/2019/wot/td#dataSchema__readonly) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [DataSchema](DataSchema.md) + * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/markdown/dataSchema__writeOnly.md b/resources/gens/markdown/dataSchema__writeOnly.md new file mode 100644 index 0000000..1244e15 --- /dev/null +++ b/resources/gens/markdown/dataSchema__writeOnly.md @@ -0,0 +1,22 @@ + +# Slot: writeOnly + +Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false). + +URI: [td:dataSchema__writeOnly](https://www.w3.org/2019/wot/td#dataSchema__writeOnly) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [DataSchema](DataSchema.md) + * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/markdown/description.md b/resources/gens/markdown/description.md new file mode 100644 index 0000000..d4fb564 --- /dev/null +++ b/resources/gens/markdown/description.md @@ -0,0 +1,26 @@ + +# Slot: description + + + +URI: [td:description](https://www.w3.org/2019/wot/td#description) + + +## Domain and Range + +None → <sub>0..1</sub> [MultiLanguage](MultiLanguage.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [DataSchema](DataSchema.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + * [Thing](Thing.md) diff --git a/resources/gens/markdown/descriptionInLanguage.md b/resources/gens/markdown/descriptionInLanguage.md new file mode 100644 index 0000000..7e6154b --- /dev/null +++ b/resources/gens/markdown/descriptionInLanguage.md @@ -0,0 +1,26 @@ + +# Slot: descriptionInLanguage + +description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + +URI: [td:descriptionInLanguage](https://www.w3.org/2019/wot/td#descriptionInLanguage) + + +## Domain and Range + +None → <sub>0..1</sub> [MultiLanguage](MultiLanguage.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [DataSchema](DataSchema.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + * [Thing](Thing.md) diff --git a/resources/gens/markdown/descriptions.md b/resources/gens/markdown/descriptions.md new file mode 100644 index 0000000..b98b284 --- /dev/null +++ b/resources/gens/markdown/descriptions.md @@ -0,0 +1,26 @@ + +# Slot: descriptions + +TODO, check, according to the description a description should not contain a lang tag. + +URI: [td:descriptions](https://www.w3.org/2019/wot/td#descriptions) + + +## Domain and Range + +None → <sub>0..\*</sub> [MultiLanguage](MultiLanguage.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + * [SecurityScheme](SecurityScheme.md) + * [Thing](Thing.md) diff --git a/resources/gens/markdown/eventAffordance__cancellation.md b/resources/gens/markdown/eventAffordance__cancellation.md new file mode 100644 index 0000000..bf303f3 --- /dev/null +++ b/resources/gens/markdown/eventAffordance__cancellation.md @@ -0,0 +1,21 @@ + +# Slot: cancellation + +Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook. + +URI: [td:eventAffordance__cancellation](https://www.w3.org/2019/wot/td#eventAffordance__cancellation) + + +## Domain and Range + +None → <sub>0..1</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [EventAffordance](EventAffordance.md) diff --git a/resources/gens/markdown/eventAffordance__notification.md b/resources/gens/markdown/eventAffordance__notification.md new file mode 100644 index 0000000..ac1fee7 --- /dev/null +++ b/resources/gens/markdown/eventAffordance__notification.md @@ -0,0 +1,21 @@ + +# Slot: notification + +Defines the data schema of the Event instance messages pushed by the Thing. + +URI: [td:eventAffordance__notification](https://www.w3.org/2019/wot/td#eventAffordance__notification) + + +## Domain and Range + +None → <sub>0..1</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [EventAffordance](EventAffordance.md) diff --git a/resources/gens/markdown/eventAffordance__notificationResponse.md b/resources/gens/markdown/eventAffordance__notificationResponse.md new file mode 100644 index 0000000..843db83 --- /dev/null +++ b/resources/gens/markdown/eventAffordance__notificationResponse.md @@ -0,0 +1,21 @@ + +# Slot: notificationResponse + +Defines the data schema of the Event response messages sent by the consumer in a response to a data message. + +URI: [td:eventAffordance__notificationResponse](https://www.w3.org/2019/wot/td#eventAffordance__notificationResponse) + + +## Domain and Range + +None → <sub>0..1</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [EventAffordance](EventAffordance.md) diff --git a/resources/gens/markdown/eventAffordance__subscription.md b/resources/gens/markdown/eventAffordance__subscription.md new file mode 100644 index 0000000..c797b31 --- /dev/null +++ b/resources/gens/markdown/eventAffordance__subscription.md @@ -0,0 +1,21 @@ + +# Slot: subscription + +Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks. + +URI: [td:eventAffordance__subscription](https://www.w3.org/2019/wot/td#eventAffordance__subscription) + + +## Domain and Range + +None → <sub>0..1</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [EventAffordance](EventAffordance.md) diff --git a/resources/gens/markdown/expectedResponse__contentType.md b/resources/gens/markdown/expectedResponse__contentType.md new file mode 100644 index 0000000..bdaf6d3 --- /dev/null +++ b/resources/gens/markdown/expectedResponse__contentType.md @@ -0,0 +1,22 @@ + +# Slot: contentType + +TODO Check, was not in hctl ontology, if not could be source of discrepancy + +URI: [td:expectedResponse__contentType](https://www.w3.org/2019/wot/td#expectedResponse__contentType) + + +## Domain and Range + +None → <sub>1..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) + * [ExpectedResponse](ExpectedResponse.md) diff --git a/resources/gens/markdown/form__additionalReturns.md b/resources/gens/markdown/form__additionalReturns.md new file mode 100644 index 0000000..c383760 --- /dev/null +++ b/resources/gens/markdown/form__additionalReturns.md @@ -0,0 +1,21 @@ + +# Slot: additionalReturns + +This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema. + +URI: [td:form__additionalReturns](https://www.w3.org/2019/wot/td#form__additionalReturns) + + +## Domain and Range + +None → <sub>0..\*</sub> [AdditionalExpectedResponse](AdditionalExpectedResponse.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) diff --git a/resources/gens/markdown/form__contentCoding.md b/resources/gens/markdown/form__contentCoding.md new file mode 100644 index 0000000..5c66d2d --- /dev/null +++ b/resources/gens/markdown/form__contentCoding.md @@ -0,0 +1,21 @@ + +# Slot: contentCoding + +Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \"gzip\", \"deflate\", etc. + +URI: [td:form__contentCoding](https://www.w3.org/2019/wot/td#form__contentCoding) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) diff --git a/resources/gens/markdown/form__contentType.md b/resources/gens/markdown/form__contentType.md new file mode 100644 index 0000000..b02f21f --- /dev/null +++ b/resources/gens/markdown/form__contentType.md @@ -0,0 +1,21 @@ + +# Slot: contentType + +Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type. + +URI: [td:form__contentType](https://www.w3.org/2019/wot/td#form__contentType) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) diff --git a/resources/gens/markdown/form__href.md b/resources/gens/markdown/form__href.md new file mode 100644 index 0000000..52af8ba --- /dev/null +++ b/resources/gens/markdown/form__href.md @@ -0,0 +1,21 @@ + +# Slot: href + + + +URI: [td:form__href](https://www.w3.org/2019/wot/td#form__href) + + +## Domain and Range + +None → <sub>1..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) diff --git a/resources/gens/markdown/form__operationType.md b/resources/gens/markdown/form__operationType.md new file mode 100644 index 0000000..b82d791 --- /dev/null +++ b/resources/gens/markdown/form__operationType.md @@ -0,0 +1,21 @@ + +# Slot: operationType + +Indicates the semantic intention of performing the operation(s) described by the form. + +URI: [td:form__operationType](https://www.w3.org/2019/wot/td#form__operationType) + + +## Domain and Range + +None → <sub>0..\*</sub> [OperationTypes](OperationTypes.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) diff --git a/resources/gens/markdown/form__returns.md b/resources/gens/markdown/form__returns.md new file mode 100644 index 0000000..0698748 --- /dev/null +++ b/resources/gens/markdown/form__returns.md @@ -0,0 +1,21 @@ + +# Slot: returns + +This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages. + +URI: [td:form__returns](https://www.w3.org/2019/wot/td#form__returns) + + +## Domain and Range + +None → <sub>0..1</sub> [ExpectedResponse](ExpectedResponse.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) diff --git a/resources/gens/markdown/form__scopes.md b/resources/gens/markdown/form__scopes.md new file mode 100644 index 0000000..1701c32 --- /dev/null +++ b/resources/gens/markdown/form__scopes.md @@ -0,0 +1,21 @@ + +# Slot: scopes + +TODO Check, was not in hctl ontology, if not could be source of discrepancy + +URI: [td:form__scopes](https://www.w3.org/2019/wot/td#form__scopes) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) diff --git a/resources/gens/markdown/form__securityDefinitions.md b/resources/gens/markdown/form__securityDefinitions.md new file mode 100644 index 0000000..9d71cbe --- /dev/null +++ b/resources/gens/markdown/form__securityDefinitions.md @@ -0,0 +1,21 @@ + +# Slot: securityDefinitions + +A security schema applied to a (set of) affordance(s). + +URI: [td:form__securityDefinitions](https://www.w3.org/2019/wot/td#form__securityDefinitions) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) diff --git a/resources/gens/markdown/form__subprotocol.md b/resources/gens/markdown/form__subprotocol.md new file mode 100644 index 0000000..4cb5172 --- /dev/null +++ b/resources/gens/markdown/form__subprotocol.md @@ -0,0 +1,21 @@ + +# Slot: subprotocol + +Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options. + +URI: [td:form__subprotocol](https://www.w3.org/2019/wot/td#form__subprotocol) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) diff --git a/resources/gens/markdown/id.md b/resources/gens/markdown/id.md new file mode 100644 index 0000000..c822f1c --- /dev/null +++ b/resources/gens/markdown/id.md @@ -0,0 +1,27 @@ + +# Slot: id + +TODO + +URI: [td:id](https://www.w3.org/2019/wot/td#id) + + +## Domain and Range + +None → <sub>1..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:id | \ No newline at end of file diff --git a/resources/gens/markdown/index.md b/resources/gens/markdown/index.md new file mode 100644 index 0000000..028536a --- /dev/null +++ b/resources/gens/markdown/index.md @@ -0,0 +1,150 @@ + +# thing-description-schema + + +**metamodel version:** 1.7.0 + +**version:** None + + +LinkML schema for modelling the W3C Web of Things Thing Description information model. This schema is used to generate +JSON Schema, SHACL shapes, and RDF. + + +### Classes + + * [DataSchema](DataSchema.md) - Metadata that describes the data format used. It can be used for validation. + * [ExpectedResponse](ExpectedResponse.md) - Communication metadata describing the expected response message for the primary response. + * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) - Communication metadata describing the expected response message for additional responses. + * [Form](Form.md) - A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions. + * [InteractionAffordance](InteractionAffordance.md) - TOOD + * [ActionAffordance](ActionAffordance.md) - An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time). + * [EventAffordance](EventAffordance.md) - An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts). + * [PropertyAffordance](PropertyAffordance.md) - An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated. + * [Link](Link.md) - A link can be viewed as a statement of the form link context that has a relation type resource at link target", where the optional target attributes may further describe the resource. + * [MultiLanguage](MultiLanguage.md) + * [SecurityScheme](SecurityScheme.md) + * [Thing](Thing.md) - An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things. + * [VersionInfo](VersionInfo.md) - Provides version information. + +### Mixins + + +### Slots + + * [@type](@type.md) + * [âžžidempotent](actionAffordance__idempotent.md) - Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input. + * [âžžinput](actionAffordance__input.md) - Used to define the input data schema of the action. + * [âžžoutput](actionAffordance__output.md) - Used to define the output data schema of the action. + * [âžžsafe](actionAffordance__safe.md) - Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action. + * [âžžsynchronous](actionAffordance__synchronous.md) - Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made. + * [âžžadditionalOutputSchema](additionalExpectedResponse__additionalOutputSchema.md) - This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used. + * [âžžschema](additionalExpectedResponse__schema.md) - TODO Check, was not in hctl ontology, if not could be source of discrepancy + * [âžžsuccess](additionalExpectedResponse__success.md) - Signals if the additional response should not be considered an error. + * [âžžpropertyName](dataSchema__propertyName.md) - Used to store the indexing name in the parent object when this schema appears as a property of an object schema. + * [âžžreadonly](dataSchema__readonly.md) - Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false). + * [âžžwriteOnly](dataSchema__writeOnly.md) - Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false). + * [description](description.md) + * [descriptionInLanguage](descriptionInLanguage.md) - description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * [descriptions](descriptions.md) - TODO, check, according to the description a description should not contain a lang tag. + * [âžžcancellation](eventAffordance__cancellation.md) - Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook. + * [âžžnotification](eventAffordance__notification.md) - Defines the data schema of the Event instance messages pushed by the Thing. + * [âžžnotificationResponse](eventAffordance__notificationResponse.md) - Defines the data schema of the Event response messages sent by the consumer in a response to a data message. + * [âžžsubscription](eventAffordance__subscription.md) - Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks. + * [âžžcontentType](expectedResponse__contentType.md) - TODO Check, was not in hctl ontology, if not could be source of discrepancy + * [âžžadditionalReturns](form__additionalReturns.md) - This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema. + * [âžžcontentCoding](form__contentCoding.md) - Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \"gzip\", \"deflate\", etc. + * [âžžcontentType](form__contentType.md) - Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type. + * [âžžhref](form__href.md) + * [âžžoperationType](form__operationType.md) - Indicates the semantic intention of performing the operation(s) described by the form. + * [âžžreturns](form__returns.md) - This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages. + * [âžžscopes](form__scopes.md) - TODO Check, was not in hctl ontology, if not could be source of discrepancy + * [âžžsecurityDefinitions](form__securityDefinitions.md) - A security schema applied to a (set of) affordance(s). + * [âžžsubprotocol](form__subprotocol.md) - Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options. + * [id](id.md) - TODO + * [âžžforms](interactionAffordance__forms.md) - Set of form hypermedia controls that describe how an operation can be performed. + * [âžžname](interactionAffordance__name.md) - Indexing property to store entity names when serializing them in a JSON-LD @index container. + * [âžžuriVariables](interactionAffordance__uriVariables.md) - Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. + * [âžžanchor](link__anchor.md) - By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI. + * [âžžhintsAtMediaType](link__hintsAtMediaType.md) - Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. + * [âžžhreflang](link__hreflang.md) - The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]. + * [âžžrelation](link__relation.md) - A link relation type identifies the semantics of a link. + * [âžžsizes](link__sizes.md) - Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \"16x16\", \"16x16 32x32\"). + * [âžžtype](link__type.md) + * [âžžkey](multiLanguage__key.md) + * [âžžobservable](propertyAffordance__observable.md) - A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property. + * [âžždescription](securityScheme__description.md) + * [âžžproxy](securityScheme__proxy.md) - URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint. + * [âžžscheme](securityScheme__scheme.md) + * [target](target.md) - Target IRI of a link or submission target of a Form + * [âžžactions](thing__actions.md) - All Action-based interaction affordances of the Thing. + * [âžžbase](thing__base.md) - Define the base URI that is used for all relative URI references throughout a TD document. + * [âžžcreated](thing__created.md) - Provides information when the TD instance was created. + * [âžževents](thing__events.md) - All Event-based interaction affordances of the Thing. + * [âžžforms](thing__forms.md) - Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings. + * [âžžinstance](thing__instance.md) - Provides a version identicator of this TD instance. + * [âžžlinks](thing__links.md) - Provides Web links to arbitrary resources that relate to the specified Thing Description. + * [âžžmodified](thing__modified.md) - Provides information when the TD instance was last modified. + * [âžžprofile](thing__profile.md) - Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation. + * [âžžproperties](thing__properties.md) - All Property-based interaction affordances of the Thing. + * [âžžschemaDefinitions](thing__schemaDefinitions.md) - TODO CHECK + * [âžžsecurity](thing__security.md) - A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check + * [âžžsecurityDefinitions](thing__securityDefinitions.md) - A security scheme applied to a (set of) affordance(s). TODO check + * [âžžsupportContact](thing__supportContact.md) - Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]). + * [âžžversion](thing__version.md) + * [title](title.md) - Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * [titleInLanguage](titleInLanguage.md) - title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * [titles](titles.md) + * [âžžinstance](versionInfo__instance.md) + * [âžžmodel](versionInfo__model.md) + +### Enums + + * [OperationTypes](OperationTypes.md) - Enumerations of well-known operation types necessary to implement the WoT interaction model. + * [SecuritySchemeType](SecuritySchemeType.md) + +### Subsets + + +### Types + + +#### Built in + + * **Bool** + * **Curie** + * **Decimal** + * **ElementIdentifier** + * **NCName** + * **NodeIdentifier** + * **URI** + * **URIorCURIE** + * **XSDDate** + * **XSDDateTime** + * **XSDTime** + * **float** + * **int** + * **str** + +#### Defined + + * [AnyUri](types/AnyUri.md) (**URI**) - a complete URI + * [Boolean](types/Boolean.md) (**Bool**) - A binary (true or false) value + * [Curie](types/Curie.md) (**Curie**) - a compact URI + * [Date](types/Date.md) (**XSDDate**) - a date (year, month and day) in an idealized calendar + * [DateOrDatetime](types/DateOrDatetime.md) (**str**) - Either a date or a datetime + * [Datetime](types/Datetime.md) (**XSDDateTime**) - The combination of a date and time + * [Decimal](types/Decimal.md) (**Decimal**) - A real number with arbitrary precision that conforms to the xsd:decimal specification + * [Double](types/Double.md) (**float**) - A real number that conforms to the xsd:double specification + * [Float](types/Float.md) (**float**) - A real number that conforms to the xsd:float specification + * [Integer](types/Integer.md) (**int**) - An integer + * [Jsonpath](types/Jsonpath.md) (**str**) - A string encoding a JSON Path. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded in tree form. + * [Jsonpointer](types/Jsonpointer.md) (**str**) - A string encoding a JSON Pointer. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to a valid object within the current instance document when encoded in tree form. + * [Ncname](types/Ncname.md) (**NCName**) - Prefix part of CURIE + * [Nodeidentifier](types/Nodeidentifier.md) (**NodeIdentifier**) - A URI, CURIE or BNODE that represents a node in a model. + * [Objectidentifier](types/Objectidentifier.md) (**ElementIdentifier**) - A URI or CURIE that represents an object in the model. + * [Sparqlpath](types/Sparqlpath.md) (**str**) - A string encoding a SPARQL Property Path. The value of the string MUST conform to SPARQL syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded as RDF. + * [String](types/String.md) (**str**) - A character string + * [Time](types/Time.md) (**XSDTime**) - A time object represents a (local) time of day, independent of any particular day + * [Uri](types/Uri.md) (**URI**) - a complete URI + * [Uriorcurie](types/Uriorcurie.md) (**URIorCURIE**) - a URI or a CURIE diff --git a/resources/gens/markdown/interactionAffordance__forms.md b/resources/gens/markdown/interactionAffordance__forms.md new file mode 100644 index 0000000..bd73707 --- /dev/null +++ b/resources/gens/markdown/interactionAffordance__forms.md @@ -0,0 +1,24 @@ + +# Slot: forms + +Set of form hypermedia controls that describe how an operation can be performed. + +URI: [td:interactionAffordance__forms](https://www.w3.org/2019/wot/td#interactionAffordance__forms) + + +## Domain and Range + +None → <sub>0..\*</sub> [Form](Form.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/markdown/interactionAffordance__name.md b/resources/gens/markdown/interactionAffordance__name.md new file mode 100644 index 0000000..0cc73e8 --- /dev/null +++ b/resources/gens/markdown/interactionAffordance__name.md @@ -0,0 +1,24 @@ + +# Slot: name + +Indexing property to store entity names when serializing them in a JSON-LD @index container. + +URI: [td:interactionAffordance__name](https://www.w3.org/2019/wot/td#interactionAffordance__name) + + +## Domain and Range + +None → <sub>1..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/markdown/interactionAffordance__uriVariables.md b/resources/gens/markdown/interactionAffordance__uriVariables.md new file mode 100644 index 0000000..43a987b --- /dev/null +++ b/resources/gens/markdown/interactionAffordance__uriVariables.md @@ -0,0 +1,24 @@ + +# Slot: uriVariables + +Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. + +URI: [td:interactionAffordance__uriVariables](https://www.w3.org/2019/wot/td#interactionAffordance__uriVariables) + + +## Domain and Range + +None → <sub>0..\*</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/markdown/link__anchor.md b/resources/gens/markdown/link__anchor.md new file mode 100644 index 0000000..4c0e26e --- /dev/null +++ b/resources/gens/markdown/link__anchor.md @@ -0,0 +1,21 @@ + +# Slot: anchor + +By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI. + +URI: [td:link__anchor](https://www.w3.org/2019/wot/td#link__anchor) + + +## Domain and Range + +None → <sub>0..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Link](Link.md) diff --git a/resources/gens/markdown/link__hintsAtMediaType.md b/resources/gens/markdown/link__hintsAtMediaType.md new file mode 100644 index 0000000..de0114d --- /dev/null +++ b/resources/gens/markdown/link__hintsAtMediaType.md @@ -0,0 +1,21 @@ + +# Slot: hintsAtMediaType + +Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. + +URI: [td:link__hintsAtMediaType](https://www.w3.org/2019/wot/td#link__hintsAtMediaType) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Link](Link.md) diff --git a/resources/gens/markdown/link__hreflang.md b/resources/gens/markdown/link__hreflang.md new file mode 100644 index 0000000..c15d589 --- /dev/null +++ b/resources/gens/markdown/link__hreflang.md @@ -0,0 +1,21 @@ + +# Slot: hreflang + +The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]. + +URI: [td:link__hreflang](https://www.w3.org/2019/wot/td#link__hreflang) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Link](Link.md) diff --git a/resources/gens/markdown/link__relation.md b/resources/gens/markdown/link__relation.md new file mode 100644 index 0000000..eb468ea --- /dev/null +++ b/resources/gens/markdown/link__relation.md @@ -0,0 +1,21 @@ + +# Slot: relation + +A link relation type identifies the semantics of a link. + +URI: [td:link__relation](https://www.w3.org/2019/wot/td#link__relation) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Link](Link.md) diff --git a/resources/gens/markdown/link__sizes.md b/resources/gens/markdown/link__sizes.md new file mode 100644 index 0000000..76ccb88 --- /dev/null +++ b/resources/gens/markdown/link__sizes.md @@ -0,0 +1,21 @@ + +# Slot: sizes + +Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \"16x16\", \"16x16 32x32\"). + +URI: [td:link__sizes](https://www.w3.org/2019/wot/td#link__sizes) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Link](Link.md) diff --git a/resources/gens/markdown/link__type.md b/resources/gens/markdown/link__type.md new file mode 100644 index 0000000..b9988ad --- /dev/null +++ b/resources/gens/markdown/link__type.md @@ -0,0 +1,21 @@ + +# Slot: type + + + +URI: [td:link__type](https://www.w3.org/2019/wot/td#link__type) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Link](Link.md) diff --git a/resources/gens/markdown/multiLanguage__key.md b/resources/gens/markdown/multiLanguage__key.md new file mode 100644 index 0000000..68e9ba3 --- /dev/null +++ b/resources/gens/markdown/multiLanguage__key.md @@ -0,0 +1,21 @@ + +# Slot: key + + + +URI: [td:multiLanguage__key](https://www.w3.org/2019/wot/td#multiLanguage__key) + + +## Domain and Range + +None → <sub>1..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [MultiLanguage](MultiLanguage.md) diff --git a/resources/gens/markdown/propertyAffordance__observable.md b/resources/gens/markdown/propertyAffordance__observable.md new file mode 100644 index 0000000..9750c6e --- /dev/null +++ b/resources/gens/markdown/propertyAffordance__observable.md @@ -0,0 +1,21 @@ + +# Slot: observable + +A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property. + +URI: [td:propertyAffordance__observable](https://www.w3.org/2019/wot/td#propertyAffordance__observable) + + +## Domain and Range + +None → <sub>0..1</sub> [Boolean](types/Boolean.md) + +## Parents + + +## Children + + +## Used by + + * [PropertyAffordance](PropertyAffordance.md) diff --git a/resources/gens/markdown/securityScheme__description.md b/resources/gens/markdown/securityScheme__description.md new file mode 100644 index 0000000..e6b033f --- /dev/null +++ b/resources/gens/markdown/securityScheme__description.md @@ -0,0 +1,21 @@ + +# Slot: description + + + +URI: [td:securityScheme__description](https://www.w3.org/2019/wot/td#securityScheme__description) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [SecurityScheme](SecurityScheme.md) diff --git a/resources/gens/markdown/securityScheme__proxy.md b/resources/gens/markdown/securityScheme__proxy.md new file mode 100644 index 0000000..3a63652 --- /dev/null +++ b/resources/gens/markdown/securityScheme__proxy.md @@ -0,0 +1,21 @@ + +# Slot: proxy + +URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint. + +URI: [td:securityScheme__proxy](https://www.w3.org/2019/wot/td#securityScheme__proxy) + + +## Domain and Range + +None → <sub>0..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [SecurityScheme](SecurityScheme.md) diff --git a/resources/gens/markdown/securityScheme__scheme.md b/resources/gens/markdown/securityScheme__scheme.md new file mode 100644 index 0000000..84741aa --- /dev/null +++ b/resources/gens/markdown/securityScheme__scheme.md @@ -0,0 +1,21 @@ + +# Slot: scheme + + + +URI: [td:securityScheme__scheme](https://www.w3.org/2019/wot/td#securityScheme__scheme) + + +## Domain and Range + +None → <sub>1..1</sub> [SecuritySchemeType](SecuritySchemeType.md) + +## Parents + + +## Children + + +## Used by + + * [SecurityScheme](SecurityScheme.md) diff --git a/resources/gens/markdown/target.md b/resources/gens/markdown/target.md new file mode 100644 index 0000000..1590219 --- /dev/null +++ b/resources/gens/markdown/target.md @@ -0,0 +1,28 @@ + +# Slot: target + +Target IRI of a link or submission target of a Form + +URI: [td:target](https://www.w3.org/2019/wot/td#target) + + +## Domain and Range + +None → <sub>1..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) + * [Link](Link.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | hctl:target | \ No newline at end of file diff --git a/resources/gens/markdown/thing__actions.md b/resources/gens/markdown/thing__actions.md new file mode 100644 index 0000000..2097cad --- /dev/null +++ b/resources/gens/markdown/thing__actions.md @@ -0,0 +1,21 @@ + +# Slot: actions + +All Action-based interaction affordances of the Thing. + +URI: [td:thing__actions](https://www.w3.org/2019/wot/td#thing__actions) + + +## Domain and Range + +None → <sub>0..\*</sub> [ActionAffordance](ActionAffordance.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__base.md b/resources/gens/markdown/thing__base.md new file mode 100644 index 0000000..7a05e48 --- /dev/null +++ b/resources/gens/markdown/thing__base.md @@ -0,0 +1,21 @@ + +# Slot: base + +Define the base URI that is used for all relative URI references throughout a TD document. + +URI: [td:thing__base](https://www.w3.org/2019/wot/td#thing__base) + + +## Domain and Range + +None → <sub>0..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__created.md b/resources/gens/markdown/thing__created.md new file mode 100644 index 0000000..a8d4ea4 --- /dev/null +++ b/resources/gens/markdown/thing__created.md @@ -0,0 +1,21 @@ + +# Slot: created + +Provides information when the TD instance was created. + +URI: [td:thing__created](https://www.w3.org/2019/wot/td#thing__created) + + +## Domain and Range + +None → <sub>0..1</sub> [Datetime](types/Datetime.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__events.md b/resources/gens/markdown/thing__events.md new file mode 100644 index 0000000..4e2ab22 --- /dev/null +++ b/resources/gens/markdown/thing__events.md @@ -0,0 +1,21 @@ + +# Slot: events + +All Event-based interaction affordances of the Thing. + +URI: [td:thing__events](https://www.w3.org/2019/wot/td#thing__events) + + +## Domain and Range + +None → <sub>0..\*</sub> [EventAffordance](EventAffordance.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__forms.md b/resources/gens/markdown/thing__forms.md new file mode 100644 index 0000000..eb5c8c2 --- /dev/null +++ b/resources/gens/markdown/thing__forms.md @@ -0,0 +1,21 @@ + +# Slot: forms + +Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings. + +URI: [td:thing__forms](https://www.w3.org/2019/wot/td#thing__forms) + + +## Domain and Range + +None → <sub>0..\*</sub> [Form](Form.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__instance.md b/resources/gens/markdown/thing__instance.md new file mode 100644 index 0000000..c81be38 --- /dev/null +++ b/resources/gens/markdown/thing__instance.md @@ -0,0 +1,21 @@ + +# Slot: instance + +Provides a version identicator of this TD instance. + +URI: [td:thing__instance](https://www.w3.org/2019/wot/td#thing__instance) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__links.md b/resources/gens/markdown/thing__links.md new file mode 100644 index 0000000..34af95f --- /dev/null +++ b/resources/gens/markdown/thing__links.md @@ -0,0 +1,21 @@ + +# Slot: links + +Provides Web links to arbitrary resources that relate to the specified Thing Description. + +URI: [td:thing__links](https://www.w3.org/2019/wot/td#thing__links) + + +## Domain and Range + +None → <sub>0..\*</sub> [Link](Link.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__modified.md b/resources/gens/markdown/thing__modified.md new file mode 100644 index 0000000..1c1e961 --- /dev/null +++ b/resources/gens/markdown/thing__modified.md @@ -0,0 +1,21 @@ + +# Slot: modified + +Provides information when the TD instance was last modified. + +URI: [td:thing__modified](https://www.w3.org/2019/wot/td#thing__modified) + + +## Domain and Range + +None → <sub>0..1</sub> [Datetime](types/Datetime.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__profile.md b/resources/gens/markdown/thing__profile.md new file mode 100644 index 0000000..c0bfe83 --- /dev/null +++ b/resources/gens/markdown/thing__profile.md @@ -0,0 +1,21 @@ + +# Slot: profile + +Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation. + +URI: [td:thing__profile](https://www.w3.org/2019/wot/td#thing__profile) + + +## Domain and Range + +None → <sub>0..\*</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__properties.md b/resources/gens/markdown/thing__properties.md new file mode 100644 index 0000000..5daa1d6 --- /dev/null +++ b/resources/gens/markdown/thing__properties.md @@ -0,0 +1,21 @@ + +# Slot: properties + +All Property-based interaction affordances of the Thing. + +URI: [td:thing__properties](https://www.w3.org/2019/wot/td#thing__properties) + + +## Domain and Range + +None → <sub>0..\*</sub> [PropertyAffordance](PropertyAffordance.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__schemaDefinitions.md b/resources/gens/markdown/thing__schemaDefinitions.md new file mode 100644 index 0000000..1003637 --- /dev/null +++ b/resources/gens/markdown/thing__schemaDefinitions.md @@ -0,0 +1,21 @@ + +# Slot: schemaDefinitions + +TODO CHECK + +URI: [td:thing__schemaDefinitions](https://www.w3.org/2019/wot/td#thing__schemaDefinitions) + + +## Domain and Range + +None → <sub>0..\*</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__security.md b/resources/gens/markdown/thing__security.md new file mode 100644 index 0000000..cbf872f --- /dev/null +++ b/resources/gens/markdown/thing__security.md @@ -0,0 +1,21 @@ + +# Slot: security + +A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check + +URI: [td:thing__security](https://www.w3.org/2019/wot/td#thing__security) + + +## Domain and Range + +None → <sub>0..\*</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__securityDefinitions.md b/resources/gens/markdown/thing__securityDefinitions.md new file mode 100644 index 0000000..fc1339f --- /dev/null +++ b/resources/gens/markdown/thing__securityDefinitions.md @@ -0,0 +1,21 @@ + +# Slot: securityDefinitions + +A security scheme applied to a (set of) affordance(s). TODO check + +URI: [td:thing__securityDefinitions](https://www.w3.org/2019/wot/td#thing__securityDefinitions) + + +## Domain and Range + +None → <sub>0..\*</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__supportContact.md b/resources/gens/markdown/thing__supportContact.md new file mode 100644 index 0000000..eb48c07 --- /dev/null +++ b/resources/gens/markdown/thing__supportContact.md @@ -0,0 +1,21 @@ + +# Slot: supportContact + +Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]). + +URI: [td:thing__supportContact](https://www.w3.org/2019/wot/td#thing__supportContact) + + +## Domain and Range + +None → <sub>0..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing__version.md b/resources/gens/markdown/thing__version.md new file mode 100644 index 0000000..10f0607 --- /dev/null +++ b/resources/gens/markdown/thing__version.md @@ -0,0 +1,21 @@ + +# Slot: version + + + +URI: [td:thing__version](https://www.w3.org/2019/wot/td#thing__version) + + +## Domain and Range + +None → <sub>0..1</sub> [VersionInfo](VersionInfo.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) diff --git a/resources/gens/markdown/thing_description_schema.md b/resources/gens/markdown/thing_description_schema.md new file mode 100644 index 0000000..75d3e80 --- /dev/null +++ b/resources/gens/markdown/thing_description_schema.md @@ -0,0 +1,2583 @@ + +# thing-description-schema + + +**metamodel version:** 1.7.0 + +**version:** None + + +LinkML schema for modelling the W3C Web of Things Thing Description information model. This schema is used to generate +JSON Schema, SHACL shapes, and RDF. + + +### Classes + + * [DataSchema](DataSchema.md) - Metadata that describes the data format used. It can be used for validation. + * [ExpectedResponse](ExpectedResponse.md) - Communication metadata describing the expected response message for the primary response. + * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) - Communication metadata describing the expected response message for additional responses. + * [Form](Form.md) - A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions. + * [InteractionAffordance](InteractionAffordance.md) - TOOD + * [ActionAffordance](ActionAffordance.md) - An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time). + * [EventAffordance](EventAffordance.md) - An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts). + * [PropertyAffordance](PropertyAffordance.md) - An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated. + * [Link](Link.md) - A link can be viewed as a statement of the form link context that has a relation type resource at link target", where the optional target attributes may further describe the resource. + * [MultiLanguage](MultiLanguage.md) + * [SecurityScheme](SecurityScheme.md) + * [Thing](Thing.md) - An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things. + * [VersionInfo](VersionInfo.md) - Provides version information. + +### Mixins + + +### Slots + + * [@type](@type.md) + * [âžžidempotent](actionAffordance__idempotent.md) - Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input. + * [âžžinput](actionAffordance__input.md) - Used to define the input data schema of the action. + * [âžžoutput](actionAffordance__output.md) - Used to define the output data schema of the action. + * [âžžsafe](actionAffordance__safe.md) - Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action. + * [âžžsynchronous](actionAffordance__synchronous.md) - Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made. + * [âžžadditionalOutputSchema](additionalExpectedResponse__additionalOutputSchema.md) - This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used. + * [âžžschema](additionalExpectedResponse__schema.md) - TODO Check, was not in hctl ontology, if not could be source of discrepancy + * [âžžsuccess](additionalExpectedResponse__success.md) - Signals if the additional response should not be considered an error. + * [âžžpropertyName](dataSchema__propertyName.md) - Used to store the indexing name in the parent object when this schema appears as a property of an object schema. + * [âžžreadonly](dataSchema__readonly.md) - Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false). + * [âžžwriteOnly](dataSchema__writeOnly.md) - Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false). + * [description](description.md) + * [descriptionInLanguage](descriptionInLanguage.md) - description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * [descriptions](descriptions.md) - TODO, check, according to the description a description should not contain a lang tag. + * [âžžcancellation](eventAffordance__cancellation.md) - Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook. + * [âžžnotification](eventAffordance__notification.md) - Defines the data schema of the Event instance messages pushed by the Thing. + * [âžžnotificationResponse](eventAffordance__notificationResponse.md) - Defines the data schema of the Event response messages sent by the consumer in a response to a data message. + * [âžžsubscription](eventAffordance__subscription.md) - Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks. + * [âžžcontentType](expectedResponse__contentType.md) - TODO Check, was not in hctl ontology, if not could be source of discrepancy + * [âžžadditionalReturns](form__additionalReturns.md) - This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema. + * [âžžcontentCoding](form__contentCoding.md) - Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \"gzip\", \"deflate\", etc. + * [âžžcontentType](form__contentType.md) - Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type. + * [âžžhref](form__href.md) + * [âžžoperationType](form__operationType.md) - Indicates the semantic intention of performing the operation(s) described by the form. + * [âžžreturns](form__returns.md) - This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages. + * [âžžscopes](form__scopes.md) - TODO Check, was not in hctl ontology, if not could be source of discrepancy + * [âžžsecurityDefinitions](form__securityDefinitions.md) - A security schema applied to a (set of) affordance(s). + * [âžžsubprotocol](form__subprotocol.md) - Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options. + * [id](id.md) - TODO + * [âžžforms](interactionAffordance__forms.md) - Set of form hypermedia controls that describe how an operation can be performed. + * [âžžname](interactionAffordance__name.md) - Indexing property to store entity names when serializing them in a JSON-LD @index container. + * [âžžuriVariables](interactionAffordance__uriVariables.md) - Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. + * [âžžanchor](link__anchor.md) - By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI. + * [âžžhintsAtMediaType](link__hintsAtMediaType.md) - Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. + * [âžžhreflang](link__hreflang.md) - The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]. + * [âžžrelation](link__relation.md) - A link relation type identifies the semantics of a link. + * [âžžsizes](link__sizes.md) - Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \"16x16\", \"16x16 32x32\"). + * [âžžtype](link__type.md) + * [âžžkey](multiLanguage__key.md) + * [âžžobservable](propertyAffordance__observable.md) - A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property. + * [âžždescription](securityScheme__description.md) + * [âžžproxy](securityScheme__proxy.md) - URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint. + * [âžžscheme](securityScheme__scheme.md) + * [target](target.md) - Target IRI of a link or submission target of a Form + * [âžžactions](thing__actions.md) - All Action-based interaction affordances of the Thing. + * [âžžbase](thing__base.md) - Define the base URI that is used for all relative URI references throughout a TD document. + * [âžžcreated](thing__created.md) - Provides information when the TD instance was created. + * [âžževents](thing__events.md) - All Event-based interaction affordances of the Thing. + * [âžžforms](thing__forms.md) - Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings. + * [âžžinstance](thing__instance.md) - Provides a version identicator of this TD instance. + * [âžžlinks](thing__links.md) - Provides Web links to arbitrary resources that relate to the specified Thing Description. + * [âžžmodified](thing__modified.md) - Provides information when the TD instance was last modified. + * [âžžprofile](thing__profile.md) - Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation. + * [âžžproperties](thing__properties.md) - All Property-based interaction affordances of the Thing. + * [âžžschemaDefinitions](thing__schemaDefinitions.md) - TODO CHECK + * [âžžsecurity](thing__security.md) - A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check + * [âžžsecurityDefinitions](thing__securityDefinitions.md) - A security scheme applied to a (set of) affordance(s). TODO check + * [âžžsupportContact](thing__supportContact.md) - Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]). + * [âžžversion](thing__version.md) + * [title](title.md) - Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * [titleInLanguage](titleInLanguage.md) - title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * [titles](titles.md) + * [âžžinstance](versionInfo__instance.md) + * [âžžmodel](versionInfo__model.md) + +### Enums + + * [OperationTypes](OperationTypes.md) - Enumerations of well-known operation types necessary to implement the WoT interaction model. + * [SecuritySchemeType](SecuritySchemeType.md) + +### Subsets + + +### Types + + +#### Built in + + * **Bool** + * **Curie** + * **Decimal** + * **ElementIdentifier** + * **NCName** + * **NodeIdentifier** + * **URI** + * **URIorCURIE** + * **XSDDate** + * **XSDDateTime** + * **XSDTime** + * **float** + * **int** + * **str** + +#### Defined + + * [AnyUri](types/AnyUri.md) (**URI**) - a complete URI + * [Boolean](types/Boolean.md) (**Bool**) - A binary (true or false) value + * [Curie](types/Curie.md) (**Curie**) - a compact URI + * [Date](types/Date.md) (**XSDDate**) - a date (year, month and day) in an idealized calendar + * [DateOrDatetime](types/DateOrDatetime.md) (**str**) - Either a date or a datetime + * [Datetime](types/Datetime.md) (**XSDDateTime**) - The combination of a date and time + * [Decimal](types/Decimal.md) (**Decimal**) - A real number with arbitrary precision that conforms to the xsd:decimal specification + * [Double](types/Double.md) (**float**) - A real number that conforms to the xsd:double specification + * [Float](types/Float.md) (**float**) - A real number that conforms to the xsd:float specification + * [Integer](types/Integer.md) (**int**) - An integer + * [Jsonpath](types/Jsonpath.md) (**str**) - A string encoding a JSON Path. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded in tree form. + * [Jsonpointer](types/Jsonpointer.md) (**str**) - A string encoding a JSON Pointer. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to a valid object within the current instance document when encoded in tree form. + * [Ncname](types/Ncname.md) (**NCName**) - Prefix part of CURIE + * [Nodeidentifier](types/Nodeidentifier.md) (**NodeIdentifier**) - A URI, CURIE or BNODE that represents a node in a model. + * [Objectidentifier](types/Objectidentifier.md) (**ElementIdentifier**) - A URI or CURIE that represents an object in the model. + * [Sparqlpath](types/Sparqlpath.md) (**str**) - A string encoding a SPARQL Property Path. The value of the string MUST conform to SPARQL syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded as RDF. + * [String](types/String.md) (**str**) - A character string + * [Time](types/Time.md) (**XSDTime**) - A time object represents a (local) time of day, independent of any particular day + * [Uri](types/Uri.md) (**URI**) - a complete URI + * [Uriorcurie](types/Uriorcurie.md) (**URIorCURIE**) - a URI or a CURIE + +# Type: anyUri + +a complete URI + +URI: [td:AnyUri](https://www.w3.org/2019/wot/td#AnyUri) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **URI** | + +# Type: boolean + +A binary (true or false) value + +URI: [linkml:Boolean](https://w3id.org/linkml/Boolean) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **Bool** | +| Representation | | bool | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:Boolean | + +# Type: curie + +a compact URI + +URI: [linkml:Curie](https://w3id.org/linkml/Curie) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **Curie** | +| Representation | | str | + +## Other properties + +| | | | +| --- | --- | --- | +| **Comments:** | | in RDF serializations this MUST be expanded to a URI | +| | | in non-RDF serializations MAY be serialized as the compact representation | + +# Type: date + +a date (year, month and day) in an idealized calendar + +URI: [linkml:Date](https://w3id.org/linkml/Date) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **XSDDate** | +| Representation | | str | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:Date | + +# Type: date_or_datetime + +Either a date or a datetime + +URI: [linkml:DateOrDatetime](https://w3id.org/linkml/DateOrDatetime) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **str** | +| Representation | | str | + +# Type: datetime + +The combination of a date and time + +URI: [linkml:Datetime](https://w3id.org/linkml/Datetime) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **XSDDateTime** | +| Representation | | str | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:DateTime | + +# Type: decimal + +A real number with arbitrary precision that conforms to the xsd:decimal specification + +URI: [linkml:Decimal](https://w3id.org/linkml/Decimal) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **Decimal** | + +## Other properties + +| | | | +| --- | --- | --- | +| **Broad Mappings:** | | schema:Number | + +# Type: double + +A real number that conforms to the xsd:double specification + +URI: [linkml:Double](https://w3id.org/linkml/Double) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **float** | + +## Other properties + +| | | | +| --- | --- | --- | +| **Close Mappings:** | | schema:Float | + +# Type: float + +A real number that conforms to the xsd:float specification + +URI: [linkml:Float](https://w3id.org/linkml/Float) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **float** | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:Float | + +# Type: integer + +An integer + +URI: [linkml:Integer](https://w3id.org/linkml/Integer) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **int** | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:Integer | + +# Type: jsonpath + +A string encoding a JSON Path. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded in tree form. + +URI: [linkml:Jsonpath](https://w3id.org/linkml/Jsonpath) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **str** | +| Representation | | str | + +# Type: jsonpointer + +A string encoding a JSON Pointer. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to a valid object within the current instance document when encoded in tree form. + +URI: [linkml:Jsonpointer](https://w3id.org/linkml/Jsonpointer) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **str** | +| Representation | | str | + +# Type: ncname + +Prefix part of CURIE + +URI: [linkml:Ncname](https://w3id.org/linkml/Ncname) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **NCName** | +| Representation | | str | + +# Type: nodeidentifier + +A URI, CURIE or BNODE that represents a node in a model. + +URI: [linkml:Nodeidentifier](https://w3id.org/linkml/Nodeidentifier) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **NodeIdentifier** | +| Representation | | str | + +# Type: objectidentifier + +A URI or CURIE that represents an object in the model. + +URI: [linkml:Objectidentifier](https://w3id.org/linkml/Objectidentifier) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **ElementIdentifier** | +| Representation | | str | + +## Other properties + +| | | | +| --- | --- | --- | +| **Comments:** | | Used for inheritance and type checking | + +# Type: sparqlpath + +A string encoding a SPARQL Property Path. The value of the string MUST conform to SPARQL syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded as RDF. + +URI: [linkml:Sparqlpath](https://w3id.org/linkml/Sparqlpath) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **str** | +| Representation | | str | + +# Type: string + +A character string + +URI: [linkml:String](https://w3id.org/linkml/String) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **str** | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:Text | + +# Type: time + +A time object represents a (local) time of day, independent of any particular day + +URI: [linkml:Time](https://w3id.org/linkml/Time) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **XSDTime** | +| Representation | | str | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:Time | + +# Type: uri + +a complete URI + +URI: [linkml:Uri](https://w3id.org/linkml/Uri) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **URI** | +| Representation | | str | + +## Other properties + +| | | | +| --- | --- | --- | +| **Comments:** | | in RDF serializations a slot with range of uri is treated as a literal or type xsd:anyURI unless it is an identifier or a reference to an identifier, in which case it is translated directly to a node | +| **Close Mappings:** | | schema:URL | + +# Type: uriorcurie + +a URI or a CURIE + +URI: [linkml:Uriorcurie](https://w3id.org/linkml/Uriorcurie) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **URIorCURIE** | +| Representation | | str | + +# Enum: OperationTypes + +Enumerations of well-known operation types necessary to implement the WoT interaction model. + +URI: [td:OperationTypes](https://www.w3.org/2019/wot/td#OperationTypes) + + +## Permissible Values + +| Text | Description | Meaning | Other Information | +| :--- | :---: | :---: | ---: | +| readproperty | Identifies the read operation on Property Affordances to retrieve the corresponding data. | td:readProperty | | +| writeproperty | Identifies the write operation on Property Affordances to update the corresponding data. | td:writeProperty | | +| observeproperty | Identifies the observe operation on Property Affordances to be notified with the new data when the Property is updated. | td:observeProperty | | +| unobserveproperty | Identifies the unobserve operation on Property Affordances to stop the corresponding notifications. | td:unobserveProperty | | +| invokeaction | Identifies the invoke operation on Action Affordances to perform the corresponding action. | td:invokeAction | | +| queryaction | Identifies the querying operation on Action Affordances to get the status of the corresponding action. | td:queryAction | | +| cancelaction | Identifies the cancel operation on Action Affordances to cancel the ongoing corresponding action. | td:cancelAction | | +| subscribeevent | Identifies the subscribe operation on Event Affordances to be notified by the Thing when the event occurs. | td:subscribeEvent | | +| unsubscribeevent | Identifies the unsubscribe operation on Event Affordances to stop the corresponding notifications. | td:unsubscribeEvent | | +| readallproperties | Identifies the readallproperties operation on a Thing to retrieve the data of all Properties in a single interaction. | td:readAllProperties | | +| writeallproperties | Identifies the writeallproperties operation on a Thing to update the data of all writable Properties in a single interaction. | writeAllProperties | | +| readmultipleproperties | Identifies the readmultipleproperties operation on a Thing to retrieve the data of selected Properties in a single interaction. | td:readMultipleProperties | | +| writemultipleproperties | Identifies the writemultipleproperties operation on a Thing to update the data of selected writable Properties in a single interaction. | td:writeMultipleProperties | | +| observeallproperties | Identifies the observeallproperties operation on Properties to be notified with new data when any Property is updated. | td:observeAllProperties | | +| unobserveallproperties | Identifies the unobserveallproperties operation on Properties to stop notifications from all Properties in a single interaction. | td:unobserveAllProperties | | +| subscribeallevents | Identifies the subscribeallevents operation on Events to subscribe to notifications from all Events in a single interaction. | td:subscribeAllEvents | | +| unsubscribeallevents | Identifies the unsubscribeallevents operation on Events to unsubscribe from notifications from all Events in a single interaction. | td:unsubscribeAllEvents | | +| queryallactions | Identifies the queryallactions operation on a Thing to get the status of all Actions in a single interaction. | td:queryAllActions | | + + +# Enum: SecuritySchemeType + + + +URI: [td:SecuritySchemeType](https://www.w3.org/2019/wot/td#SecuritySchemeType) + + +## Permissible Values + +| Text | Description | Meaning | Other Information | +| :--- | :---: | :---: | ---: | +| nosec | A security configuration corresponding to identified by the Vocabulary Term nosec, indicating there is no authentication or other mechanism required to access the resource. | wotsec:NoSecurityScheme | | +| combo | Elements of this scheme define various ways in which other named schemes defined in securityDefinitions, including other ComboSecurityScheme definitions, are to be combined to create a new scheme definition. | wotsec:ComboSecurityScheme | | +| basic | Uses an unencrypted username and password. | wotsec:BasicSecurityScheme | | +| digest | This scheme is similar to basic authentication but with added features to avoid man-in-the-middle attacks. | wotsec:DigestSecurityScheme | | +| bearer | Bearer tokens are used independently of OAuth2. | wotsec:BearerSecurityScheme | | +| psk | This is meant to identify that a standard is used for pre-shared keys such as TLS-PSK [RFC4279], and that the ciphersuite used for keys will be established during protocol negotiation. | wotsec:PSKSecurityScheme | | +| oauth2 | OAuth 2.0 authentication security configuration for systems conformant with [RFC6749] and [RFC8252]. | wotsec:OAuth2SecurityScheme | | +| apikey | This scheme is to be used when the access token is opaque. | wotsec:APIKeySecurityScheme | | +| auto | This scheme indicates that the security parameters are going to be negotiated by the underlying protocols at runtime | wotsec:AutoSecurityScheme | | + + +# Slot: @type + + + +URI: [td:@type](https://www.w3.org/2019/wot/td#@type) + + +## Domain and Range + +None → <sub>0..\*</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [SecurityScheme](SecurityScheme.md) + * [Thing](Thing.md) + +# Slot: idempotent + +Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input. + +URI: [td:actionAffordance__idempotent](https://www.w3.org/2019/wot/td#actionAffordance__idempotent) + + +## Domain and Range + +None → <sub>0..1</sub> [Boolean](types/Boolean.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + +# Slot: input + +Used to define the input data schema of the action. + +URI: [td:actionAffordance__input](https://www.w3.org/2019/wot/td#actionAffordance__input) + + +## Domain and Range + +None → <sub>0..1</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + +# Slot: output + +Used to define the output data schema of the action. + +URI: [td:actionAffordance__output](https://www.w3.org/2019/wot/td#actionAffordance__output) + + +## Domain and Range + +None → <sub>0..1</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + +# Slot: safe + +Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action. + +URI: [td:actionAffordance__safe](https://www.w3.org/2019/wot/td#actionAffordance__safe) + + +## Domain and Range + +None → <sub>0..1</sub> [Boolean](types/Boolean.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + +# Slot: synchronous + +Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made. + +URI: [td:actionAffordance__synchronous](https://www.w3.org/2019/wot/td#actionAffordance__synchronous) + + +## Domain and Range + +None → <sub>0..1</sub> [Boolean](types/Boolean.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + +# Slot: additionalOutputSchema + +This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used. + +URI: [td:additionalExpectedResponse__additionalOutputSchema](https://www.w3.org/2019/wot/td#additionalExpectedResponse__additionalOutputSchema) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) + +# Slot: schema + +TODO Check, was not in hctl ontology, if not could be source of discrepancy + +URI: [td:additionalExpectedResponse__schema](https://www.w3.org/2019/wot/td#additionalExpectedResponse__schema) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) + +# Slot: success + +Signals if the additional response should not be considered an error. + +URI: [td:additionalExpectedResponse__success](https://www.w3.org/2019/wot/td#additionalExpectedResponse__success) + + +## Domain and Range + +None → <sub>0..1</sub> [Boolean](types/Boolean.md) + +## Parents + + +## Children + + +## Used by + + * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) + +# Slot: propertyName + +Used to store the indexing name in the parent object when this schema appears as a property of an object schema. + +URI: [td:dataSchema__propertyName](https://www.w3.org/2019/wot/td#dataSchema__propertyName) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [DataSchema](DataSchema.md) + * [PropertyAffordance](PropertyAffordance.md) + +# Slot: readonly + +Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false). + +URI: [td:dataSchema__readonly](https://www.w3.org/2019/wot/td#dataSchema__readonly) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [DataSchema](DataSchema.md) + * [PropertyAffordance](PropertyAffordance.md) + +# Slot: writeOnly + +Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false). + +URI: [td:dataSchema__writeOnly](https://www.w3.org/2019/wot/td#dataSchema__writeOnly) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [DataSchema](DataSchema.md) + * [PropertyAffordance](PropertyAffordance.md) + +# Slot: description + + + +URI: [td:description](https://www.w3.org/2019/wot/td#description) + + +## Domain and Range + +None → <sub>0..1</sub> [MultiLanguage](MultiLanguage.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [DataSchema](DataSchema.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + * [Thing](Thing.md) + +# Slot: descriptionInLanguage + +description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + +URI: [td:descriptionInLanguage](https://www.w3.org/2019/wot/td#descriptionInLanguage) + + +## Domain and Range + +None → <sub>0..1</sub> [MultiLanguage](MultiLanguage.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [DataSchema](DataSchema.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + * [Thing](Thing.md) + +# Slot: descriptions + +TODO, check, according to the description a description should not contain a lang tag. + +URI: [td:descriptions](https://www.w3.org/2019/wot/td#descriptions) + + +## Domain and Range + +None → <sub>0..\*</sub> [MultiLanguage](MultiLanguage.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + * [SecurityScheme](SecurityScheme.md) + * [Thing](Thing.md) + +# Slot: cancellation + +Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook. + +URI: [td:eventAffordance__cancellation](https://www.w3.org/2019/wot/td#eventAffordance__cancellation) + + +## Domain and Range + +None → <sub>0..1</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [EventAffordance](EventAffordance.md) + +# Slot: notification + +Defines the data schema of the Event instance messages pushed by the Thing. + +URI: [td:eventAffordance__notification](https://www.w3.org/2019/wot/td#eventAffordance__notification) + + +## Domain and Range + +None → <sub>0..1</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [EventAffordance](EventAffordance.md) + +# Slot: notificationResponse + +Defines the data schema of the Event response messages sent by the consumer in a response to a data message. + +URI: [td:eventAffordance__notificationResponse](https://www.w3.org/2019/wot/td#eventAffordance__notificationResponse) + + +## Domain and Range + +None → <sub>0..1</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [EventAffordance](EventAffordance.md) + +# Slot: subscription + +Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks. + +URI: [td:eventAffordance__subscription](https://www.w3.org/2019/wot/td#eventAffordance__subscription) + + +## Domain and Range + +None → <sub>0..1</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [EventAffordance](EventAffordance.md) + +# Slot: contentType + +TODO Check, was not in hctl ontology, if not could be source of discrepancy + +URI: [td:expectedResponse__contentType](https://www.w3.org/2019/wot/td#expectedResponse__contentType) + + +## Domain and Range + +None → <sub>1..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) + * [ExpectedResponse](ExpectedResponse.md) + +# Slot: additionalReturns + +This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema. + +URI: [td:form__additionalReturns](https://www.w3.org/2019/wot/td#form__additionalReturns) + + +## Domain and Range + +None → <sub>0..\*</sub> [AdditionalExpectedResponse](AdditionalExpectedResponse.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) + +# Slot: contentCoding + +Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \"gzip\", \"deflate\", etc. + +URI: [td:form__contentCoding](https://www.w3.org/2019/wot/td#form__contentCoding) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) + +# Slot: contentType + +Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type. + +URI: [td:form__contentType](https://www.w3.org/2019/wot/td#form__contentType) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) + +# Slot: href + + + +URI: [td:form__href](https://www.w3.org/2019/wot/td#form__href) + + +## Domain and Range + +None → <sub>1..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) + +# Slot: operationType + +Indicates the semantic intention of performing the operation(s) described by the form. + +URI: [td:form__operationType](https://www.w3.org/2019/wot/td#form__operationType) + + +## Domain and Range + +None → <sub>0..\*</sub> [OperationTypes](OperationTypes.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) + +# Slot: returns + +This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages. + +URI: [td:form__returns](https://www.w3.org/2019/wot/td#form__returns) + + +## Domain and Range + +None → <sub>0..1</sub> [ExpectedResponse](ExpectedResponse.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) + +# Slot: scopes + +TODO Check, was not in hctl ontology, if not could be source of discrepancy + +URI: [td:form__scopes](https://www.w3.org/2019/wot/td#form__scopes) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) + +# Slot: securityDefinitions + +A security schema applied to a (set of) affordance(s). + +URI: [td:form__securityDefinitions](https://www.w3.org/2019/wot/td#form__securityDefinitions) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) + +# Slot: subprotocol + +Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options. + +URI: [td:form__subprotocol](https://www.w3.org/2019/wot/td#form__subprotocol) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) + +# Slot: id + +TODO + +URI: [td:id](https://www.w3.org/2019/wot/td#id) + + +## Domain and Range + +None → <sub>1..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:id | +# Slot: forms + +Set of form hypermedia controls that describe how an operation can be performed. + +URI: [td:interactionAffordance__forms](https://www.w3.org/2019/wot/td#interactionAffordance__forms) + + +## Domain and Range + +None → <sub>0..\*</sub> [Form](Form.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + +# Slot: name + +Indexing property to store entity names when serializing them in a JSON-LD @index container. + +URI: [td:interactionAffordance__name](https://www.w3.org/2019/wot/td#interactionAffordance__name) + + +## Domain and Range + +None → <sub>1..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + +# Slot: uriVariables + +Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. + +URI: [td:interactionAffordance__uriVariables](https://www.w3.org/2019/wot/td#interactionAffordance__uriVariables) + + +## Domain and Range + +None → <sub>0..\*</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + +# Slot: anchor + +By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI. + +URI: [td:link__anchor](https://www.w3.org/2019/wot/td#link__anchor) + + +## Domain and Range + +None → <sub>0..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Link](Link.md) + +# Slot: hintsAtMediaType + +Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. + +URI: [td:link__hintsAtMediaType](https://www.w3.org/2019/wot/td#link__hintsAtMediaType) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Link](Link.md) + +# Slot: hreflang + +The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]. + +URI: [td:link__hreflang](https://www.w3.org/2019/wot/td#link__hreflang) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Link](Link.md) + +# Slot: relation + +A link relation type identifies the semantics of a link. + +URI: [td:link__relation](https://www.w3.org/2019/wot/td#link__relation) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Link](Link.md) + +# Slot: sizes + +Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \"16x16\", \"16x16 32x32\"). + +URI: [td:link__sizes](https://www.w3.org/2019/wot/td#link__sizes) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Link](Link.md) + +# Slot: type + + + +URI: [td:link__type](https://www.w3.org/2019/wot/td#link__type) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Link](Link.md) + +# Slot: key + + + +URI: [td:multiLanguage__key](https://www.w3.org/2019/wot/td#multiLanguage__key) + + +## Domain and Range + +None → <sub>1..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [MultiLanguage](MultiLanguage.md) + +# Slot: observable + +A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property. + +URI: [td:propertyAffordance__observable](https://www.w3.org/2019/wot/td#propertyAffordance__observable) + + +## Domain and Range + +None → <sub>0..1</sub> [Boolean](types/Boolean.md) + +## Parents + + +## Children + + +## Used by + + * [PropertyAffordance](PropertyAffordance.md) + +# Slot: description + + + +URI: [td:securityScheme__description](https://www.w3.org/2019/wot/td#securityScheme__description) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [SecurityScheme](SecurityScheme.md) + +# Slot: proxy + +URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint. + +URI: [td:securityScheme__proxy](https://www.w3.org/2019/wot/td#securityScheme__proxy) + + +## Domain and Range + +None → <sub>0..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [SecurityScheme](SecurityScheme.md) + +# Slot: scheme + + + +URI: [td:securityScheme__scheme](https://www.w3.org/2019/wot/td#securityScheme__scheme) + + +## Domain and Range + +None → <sub>1..1</sub> [SecuritySchemeType](SecuritySchemeType.md) + +## Parents + + +## Children + + +## Used by + + * [SecurityScheme](SecurityScheme.md) + +# Slot: target + +Target IRI of a link or submission target of a Form + +URI: [td:target](https://www.w3.org/2019/wot/td#target) + + +## Domain and Range + +None → <sub>1..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Form](Form.md) + * [Link](Link.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | hctl:target | +# Slot: actions + +All Action-based interaction affordances of the Thing. + +URI: [td:thing__actions](https://www.w3.org/2019/wot/td#thing__actions) + + +## Domain and Range + +None → <sub>0..\*</sub> [ActionAffordance](ActionAffordance.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: base + +Define the base URI that is used for all relative URI references throughout a TD document. + +URI: [td:thing__base](https://www.w3.org/2019/wot/td#thing__base) + + +## Domain and Range + +None → <sub>0..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: created + +Provides information when the TD instance was created. + +URI: [td:thing__created](https://www.w3.org/2019/wot/td#thing__created) + + +## Domain and Range + +None → <sub>0..1</sub> [Datetime](types/Datetime.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: events + +All Event-based interaction affordances of the Thing. + +URI: [td:thing__events](https://www.w3.org/2019/wot/td#thing__events) + + +## Domain and Range + +None → <sub>0..\*</sub> [EventAffordance](EventAffordance.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: forms + +Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings. + +URI: [td:thing__forms](https://www.w3.org/2019/wot/td#thing__forms) + + +## Domain and Range + +None → <sub>0..\*</sub> [Form](Form.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: instance + +Provides a version identicator of this TD instance. + +URI: [td:thing__instance](https://www.w3.org/2019/wot/td#thing__instance) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: links + +Provides Web links to arbitrary resources that relate to the specified Thing Description. + +URI: [td:thing__links](https://www.w3.org/2019/wot/td#thing__links) + + +## Domain and Range + +None → <sub>0..\*</sub> [Link](Link.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: modified + +Provides information when the TD instance was last modified. + +URI: [td:thing__modified](https://www.w3.org/2019/wot/td#thing__modified) + + +## Domain and Range + +None → <sub>0..1</sub> [Datetime](types/Datetime.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: profile + +Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation. + +URI: [td:thing__profile](https://www.w3.org/2019/wot/td#thing__profile) + + +## Domain and Range + +None → <sub>0..\*</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: properties + +All Property-based interaction affordances of the Thing. + +URI: [td:thing__properties](https://www.w3.org/2019/wot/td#thing__properties) + + +## Domain and Range + +None → <sub>0..\*</sub> [PropertyAffordance](PropertyAffordance.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: schemaDefinitions + +TODO CHECK + +URI: [td:thing__schemaDefinitions](https://www.w3.org/2019/wot/td#thing__schemaDefinitions) + + +## Domain and Range + +None → <sub>0..\*</sub> [DataSchema](DataSchema.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: security + +A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check + +URI: [td:thing__security](https://www.w3.org/2019/wot/td#thing__security) + + +## Domain and Range + +None → <sub>0..\*</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: securityDefinitions + +A security scheme applied to a (set of) affordance(s). TODO check + +URI: [td:thing__securityDefinitions](https://www.w3.org/2019/wot/td#thing__securityDefinitions) + + +## Domain and Range + +None → <sub>0..\*</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: supportContact + +Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]). + +URI: [td:thing__supportContact](https://www.w3.org/2019/wot/td#thing__supportContact) + + +## Domain and Range + +None → <sub>0..1</sub> [AnyUri](types/AnyUri.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: version + + + +URI: [td:thing__version](https://www.w3.org/2019/wot/td#thing__version) + + +## Domain and Range + +None → <sub>0..1</sub> [VersionInfo](VersionInfo.md) + +## Parents + + +## Children + + +## Used by + + * [Thing](Thing.md) + +# Slot: title + +Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + +URI: [td:title](https://www.w3.org/2019/wot/td#title) + + +## Domain and Range + +None → <sub>0..1</sub> [MultiLanguage](MultiLanguage.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [DataSchema](DataSchema.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + * [Thing](Thing.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:title | +# Slot: titleInLanguage + +title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + +URI: [td:titleInLanguage](https://www.w3.org/2019/wot/td#titleInLanguage) + + +## Domain and Range + +None → <sub>0..1</sub> [MultiLanguage](MultiLanguage.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [DataSchema](DataSchema.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + * [Thing](Thing.md) + +# Slot: titles + + + +URI: [td:titles](https://www.w3.org/2019/wot/td#titles) + + +## Domain and Range + +None → <sub>0..\*</sub> [MultiLanguage](MultiLanguage.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + * [Thing](Thing.md) + +# Slot: instance + + + +URI: [td:versionInfo__instance](https://www.w3.org/2019/wot/td#versionInfo__instance) + + +## Domain and Range + +None → <sub>1..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [VersionInfo](VersionInfo.md) + +# Slot: model + + + +URI: [td:versionInfo__model](https://www.w3.org/2019/wot/td#versionInfo__model) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [VersionInfo](VersionInfo.md) + +# Class: ActionAffordance + +An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time). + +URI: [td:ActionAffordance](https://www.w3.org/2019/wot/td#ActionAffordance) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage],[InteractionAffordance],[Form],[DataSchema],[DataSchema]<output%200..1-++[ActionAffordance|safe:boolean%20%3F;synchronous:boolean%20%3F;idempotent:boolean%20%3F;name(i):string],[DataSchema]<input%200..1-++[ActionAffordance],[Thing]++-%20actions%200..*>[ActionAffordance],[InteractionAffordance]^-[ActionAffordance],[Thing])](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage],[InteractionAffordance],[Form],[DataSchema],[DataSchema]<output%200..1-++[ActionAffordance|safe:boolean%20%3F;synchronous:boolean%20%3F;idempotent:boolean%20%3F;name(i):string],[DataSchema]<input%200..1-++[ActionAffordance],[Thing]++-%20actions%200..*>[ActionAffordance],[InteractionAffordance]^-[ActionAffordance],[Thing]) + +## Parents + + * is_a: [InteractionAffordance](InteractionAffordance.md) - TOOD + +## Referenced by Class + + * **None** *[âžžactions](thing__actions.md)* <sub>0..\*</sub> **[ActionAffordance](ActionAffordance.md)** + +## Attributes + + +### Own + + * [âžžsafe](actionAffordance__safe.md) <sub>0..1</sub> + * Description: Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action. + * Range: [Boolean](types/Boolean.md) + * [âžžsynchronous](actionAffordance__synchronous.md) <sub>0..1</sub> + * Description: Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made. + * Range: [Boolean](types/Boolean.md) + * [âžžidempotent](actionAffordance__idempotent.md) <sub>0..1</sub> + * Description: Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input. + * Range: [Boolean](types/Boolean.md) + * [âžžinput](actionAffordance__input.md) <sub>0..1</sub> + * Description: Used to define the input data schema of the action. + * Range: [DataSchema](DataSchema.md) + * [âžžoutput](actionAffordance__output.md) <sub>0..1</sub> + * Description: Used to define the output data schema of the action. + * Range: [DataSchema](DataSchema.md) + +### Inherited from InteractionAffordance: + + * [titles](titles.md) <sub>0..\*</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptions](descriptions.md) <sub>0..\*</sub> + * Description: TODO, check, according to the description a description should not contain a lang tag. + * Range: [MultiLanguage](MultiLanguage.md) + * [title](title.md) <sub>0..1</sub> + * Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * Range: [MultiLanguage](MultiLanguage.md) + * [description](description.md) <sub>0..1</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [titleInLanguage](titleInLanguage.md) <sub>0..1</sub> + * Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptionInLanguage](descriptionInLanguage.md) <sub>0..1</sub> + * Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžžname](interactionAffordance__name.md) <sub>1..1</sub> + * Description: Indexing property to store entity names when serializing them in a JSON-LD @index container. + * Range: [String](types/String.md) + * [âžžuriVariables](interactionAffordance__uriVariables.md) <sub>0..\*</sub> + * Description: Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. + * Range: [DataSchema](DataSchema.md) + * [âžžforms](interactionAffordance__forms.md) <sub>0..\*</sub> + * Description: Set of form hypermedia controls that describe how an operation can be performed. + * Range: [Form](Form.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:ActionAffordance | +# Class: AdditionalExpectedResponse + +Communication metadata describing the expected response message for additional responses. + +URI: [td:AdditionalExpectedResponse](https://www.w3.org/2019/wot/td#AdditionalExpectedResponse) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[ExpectedResponse],[Form]++-%20additionalReturns%200..*>[AdditionalExpectedResponse|additionalOutputSchema:string%20%3F;success:boolean%20%3F;schema:string%20%3F;contentType(i):string],[ExpectedResponse]^-[AdditionalExpectedResponse],[Form])](https://yuml.me/diagram/nofunky;dir:TB/class/[ExpectedResponse],[Form]++-%20additionalReturns%200..*>[AdditionalExpectedResponse|additionalOutputSchema:string%20%3F;success:boolean%20%3F;schema:string%20%3F;contentType(i):string],[ExpectedResponse]^-[AdditionalExpectedResponse],[Form]) + +## Parents + + * is_a: [ExpectedResponse](ExpectedResponse.md) - Communication metadata describing the expected response message for the primary response. + +## Referenced by Class + + * **None** *[âžžadditionalReturns](form__additionalReturns.md)* <sub>0..\*</sub> **[AdditionalExpectedResponse](AdditionalExpectedResponse.md)** + +## Attributes + + +### Own + + * [âžžadditionalOutputSchema](additionalExpectedResponse__additionalOutputSchema.md) <sub>0..1</sub> + * Description: This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used. + * Range: [String](types/String.md) + * [âžžsuccess](additionalExpectedResponse__success.md) <sub>0..1</sub> + * Description: Signals if the additional response should not be considered an error. + * Range: [Boolean](types/Boolean.md) + * [âžžschema](additionalExpectedResponse__schema.md) <sub>0..1</sub> + * Description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + * Range: [String](types/String.md) + +### Inherited from ExpectedResponse: + + * [âžžcontentType](expectedResponse__contentType.md) <sub>1..1</sub> + * Description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + * Range: [String](types/String.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | hctl:AdditionalExpectedResponse | +# Class: DataSchema + +Metadata that describes the data format used. It can be used for validation. + +URI: [td:DataSchema](https://www.w3.org/2019/wot/td#DataSchema) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage],[MultiLanguage]<descriptionInLanguage%200..1-%20[DataSchema|propertyName:string%20%3F;writeOnly:string%20%3F;readonly:string%20%3F],[MultiLanguage]<titleInLanguage%200..1-%20[DataSchema],[MultiLanguage]<title%200..1-%20[DataSchema],[MultiLanguage]<description%200..1-%20[DataSchema],[ActionAffordance]++-%20input%200..1>[DataSchema],[ActionAffordance]++-%20output%200..1>[DataSchema],[EventAffordance]++-%20cancellation%200..1>[DataSchema],[EventAffordance]++-%20notification%200..1>[DataSchema],[EventAffordance]++-%20notificationResponse%200..1>[DataSchema],[EventAffordance]++-%20subscription%200..1>[DataSchema],[InteractionAffordance]++-%20uriVariables%200..*>[DataSchema],[Thing]++-%20schemaDefinitions%200..*>[DataSchema],[PropertyAffordance]uses%20-.->[DataSchema],[Thing],[PropertyAffordance],[InteractionAffordance],[EventAffordance],[ActionAffordance])](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage],[MultiLanguage]<descriptionInLanguage%200..1-%20[DataSchema|propertyName:string%20%3F;writeOnly:string%20%3F;readonly:string%20%3F],[MultiLanguage]<titleInLanguage%200..1-%20[DataSchema],[MultiLanguage]<title%200..1-%20[DataSchema],[MultiLanguage]<description%200..1-%20[DataSchema],[ActionAffordance]++-%20input%200..1>[DataSchema],[ActionAffordance]++-%20output%200..1>[DataSchema],[EventAffordance]++-%20cancellation%200..1>[DataSchema],[EventAffordance]++-%20notification%200..1>[DataSchema],[EventAffordance]++-%20notificationResponse%200..1>[DataSchema],[EventAffordance]++-%20subscription%200..1>[DataSchema],[InteractionAffordance]++-%20uriVariables%200..*>[DataSchema],[Thing]++-%20schemaDefinitions%200..*>[DataSchema],[PropertyAffordance]uses%20-.->[DataSchema],[Thing],[PropertyAffordance],[InteractionAffordance],[EventAffordance],[ActionAffordance]) + +## Mixin for + + * [PropertyAffordance](PropertyAffordance.md) (mixin) - An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated. + +## Referenced by Class + + * **None** *[âžžinput](actionAffordance__input.md)* <sub>0..1</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžoutput](actionAffordance__output.md)* <sub>0..1</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžcancellation](eventAffordance__cancellation.md)* <sub>0..1</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžnotification](eventAffordance__notification.md)* <sub>0..1</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžnotificationResponse](eventAffordance__notificationResponse.md)* <sub>0..1</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžsubscription](eventAffordance__subscription.md)* <sub>0..1</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžuriVariables](interactionAffordance__uriVariables.md)* <sub>0..\*</sub> **[DataSchema](DataSchema.md)** + * **None** *[âžžschemaDefinitions](thing__schemaDefinitions.md)* <sub>0..\*</sub> **[DataSchema](DataSchema.md)** + +## Attributes + + +### Own + + * [description](description.md) <sub>0..1</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [title](title.md) <sub>0..1</sub> + * Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * Range: [MultiLanguage](MultiLanguage.md) + * [titleInLanguage](titleInLanguage.md) <sub>0..1</sub> + * Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptionInLanguage](descriptionInLanguage.md) <sub>0..1</sub> + * Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžžpropertyName](dataSchema__propertyName.md) <sub>0..1</sub> + * Description: Used to store the indexing name in the parent object when this schema appears as a property of an object schema. + * Range: [String](types/String.md) + * [âžžwriteOnly](dataSchema__writeOnly.md) <sub>0..1</sub> + * Description: Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false). + * Range: [String](types/String.md) + * [âžžreadonly](dataSchema__readonly.md) <sub>0..1</sub> + * Description: Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false). + * Range: [String](types/String.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | jsonschema:DataSchema | +# Class: EventAffordance + +An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts). + +URI: [td:EventAffordance](https://www.w3.org/2019/wot/td#EventAffordance) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage],[InteractionAffordance],[Form],[DataSchema]<notificationResponse%200..1-++[EventAffordance|name(i):string],[DataSchema]<notification%200..1-++[EventAffordance],[DataSchema]<cancellation%200..1-++[EventAffordance],[DataSchema]<subscription%200..1-++[EventAffordance],[Thing]++-%20events%200..*>[EventAffordance],[InteractionAffordance]^-[EventAffordance],[Thing],[DataSchema])](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage],[InteractionAffordance],[Form],[DataSchema]<notificationResponse%200..1-++[EventAffordance|name(i):string],[DataSchema]<notification%200..1-++[EventAffordance],[DataSchema]<cancellation%200..1-++[EventAffordance],[DataSchema]<subscription%200..1-++[EventAffordance],[Thing]++-%20events%200..*>[EventAffordance],[InteractionAffordance]^-[EventAffordance],[Thing],[DataSchema]) + +## Parents + + * is_a: [InteractionAffordance](InteractionAffordance.md) - TOOD + +## Referenced by Class + + * **None** *[âžževents](thing__events.md)* <sub>0..\*</sub> **[EventAffordance](EventAffordance.md)** + +## Attributes + + +### Own + + * [âžžsubscription](eventAffordance__subscription.md) <sub>0..1</sub> + * Description: Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks. + * Range: [DataSchema](DataSchema.md) + * [âžžcancellation](eventAffordance__cancellation.md) <sub>0..1</sub> + * Description: Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook. + * Range: [DataSchema](DataSchema.md) + * [âžžnotification](eventAffordance__notification.md) <sub>0..1</sub> + * Description: Defines the data schema of the Event instance messages pushed by the Thing. + * Range: [DataSchema](DataSchema.md) + * [âžžnotificationResponse](eventAffordance__notificationResponse.md) <sub>0..1</sub> + * Description: Defines the data schema of the Event response messages sent by the consumer in a response to a data message. + * Range: [DataSchema](DataSchema.md) + +### Inherited from InteractionAffordance: + + * [titles](titles.md) <sub>0..\*</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptions](descriptions.md) <sub>0..\*</sub> + * Description: TODO, check, according to the description a description should not contain a lang tag. + * Range: [MultiLanguage](MultiLanguage.md) + * [title](title.md) <sub>0..1</sub> + * Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * Range: [MultiLanguage](MultiLanguage.md) + * [description](description.md) <sub>0..1</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [titleInLanguage](titleInLanguage.md) <sub>0..1</sub> + * Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptionInLanguage](descriptionInLanguage.md) <sub>0..1</sub> + * Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžžname](interactionAffordance__name.md) <sub>1..1</sub> + * Description: Indexing property to store entity names when serializing them in a JSON-LD @index container. + * Range: [String](types/String.md) + * [âžžuriVariables](interactionAffordance__uriVariables.md) <sub>0..\*</sub> + * Description: Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. + * Range: [DataSchema](DataSchema.md) + * [âžžforms](interactionAffordance__forms.md) <sub>0..\*</sub> + * Description: Set of form hypermedia controls that describe how an operation can be performed. + * Range: [Form](Form.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:EventAffordance | +# Class: ExpectedResponse + +Communication metadata describing the expected response message for the primary response. + +URI: [td:ExpectedResponse](https://www.w3.org/2019/wot/td#ExpectedResponse) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Form]++-%20returns%200..1>[ExpectedResponse|contentType:string],[ExpectedResponse]^-[AdditionalExpectedResponse],[Form],[AdditionalExpectedResponse])](https://yuml.me/diagram/nofunky;dir:TB/class/[Form]++-%20returns%200..1>[ExpectedResponse|contentType:string],[ExpectedResponse]^-[AdditionalExpectedResponse],[Form],[AdditionalExpectedResponse]) + +## Children + + * [AdditionalExpectedResponse](AdditionalExpectedResponse.md) - Communication metadata describing the expected response message for additional responses. + +## Referenced by Class + + * **None** *[âžžreturns](form__returns.md)* <sub>0..1</sub> **[ExpectedResponse](ExpectedResponse.md)** + +## Attributes + + +### Own + + * [âžžcontentType](expectedResponse__contentType.md) <sub>1..1</sub> + * Description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + * Range: [String](types/String.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | hctl:ExpectedResponse | +# Class: Form + +A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions. + +URI: [td:Form](https://www.w3.org/2019/wot/td#Form) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[AdditionalExpectedResponse]<additionalReturns%200..*-++[Form|target:anyUri;href:anyUri;contentType:string%20%3F;contentCoding:string%20%3F;securityDefinitions:string%20%3F;scopes:string%20%3F;subprotocol:string%20%3F;operationType:OperationTypes%20*],[ExpectedResponse]<returns%200..1-++[Form],[InteractionAffordance]++-%20forms%200..*>[Form],[Thing]++-%20forms%200..*>[Form],[Thing],[InteractionAffordance],[ExpectedResponse],[AdditionalExpectedResponse])](https://yuml.me/diagram/nofunky;dir:TB/class/[AdditionalExpectedResponse]<additionalReturns%200..*-++[Form|target:anyUri;href:anyUri;contentType:string%20%3F;contentCoding:string%20%3F;securityDefinitions:string%20%3F;scopes:string%20%3F;subprotocol:string%20%3F;operationType:OperationTypes%20*],[ExpectedResponse]<returns%200..1-++[Form],[InteractionAffordance]++-%20forms%200..*>[Form],[Thing]++-%20forms%200..*>[Form],[Thing],[InteractionAffordance],[ExpectedResponse],[AdditionalExpectedResponse]) + +## Referenced by Class + + * **None** *[âžžforms](interactionAffordance__forms.md)* <sub>0..\*</sub> **[Form](Form.md)** + * **None** *[âžžforms](thing__forms.md)* <sub>0..\*</sub> **[Form](Form.md)** + +## Attributes + + +### Own + + * [target](target.md) <sub>1..1</sub> + * Description: Target IRI of a link or submission target of a Form + * Range: [AnyUri](types/AnyUri.md) + * [âžžhref](form__href.md) <sub>1..1</sub> + * Range: [AnyUri](types/AnyUri.md) + * [âžžcontentType](form__contentType.md) <sub>0..1</sub> + * Description: Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type. + * Range: [String](types/String.md) + * [âžžcontentCoding](form__contentCoding.md) <sub>0..1</sub> + * Description: Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \"gzip\", \"deflate\", etc. + * Range: [String](types/String.md) + * [âžžsecurityDefinitions](form__securityDefinitions.md) <sub>0..1</sub> + * Description: A security schema applied to a (set of) affordance(s). + * Range: [String](types/String.md) + * [âžžscopes](form__scopes.md) <sub>0..1</sub> + * Description: TODO Check, was not in hctl ontology, if not could be source of discrepancy + * Range: [String](types/String.md) + * [âžžreturns](form__returns.md) <sub>0..1</sub> + * Description: This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages. + * Range: [ExpectedResponse](ExpectedResponse.md) + * [âžžadditionalReturns](form__additionalReturns.md) <sub>0..\*</sub> + * Description: This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema. + * Range: [AdditionalExpectedResponse](AdditionalExpectedResponse.md) + * [âžžsubprotocol](form__subprotocol.md) <sub>0..1</sub> + * Description: Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options. + * Range: [String](types/String.md) + * [âžžoperationType](form__operationType.md) <sub>0..\*</sub> + * Description: Indicates the semantic intention of performing the operation(s) described by the form. + * Range: [OperationTypes](OperationTypes.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | hctl:Form | +# Class: InteractionAffordance + +TOOD + +URI: [td:InteractionAffordance](https://www.w3.org/2019/wot/td#InteractionAffordance) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[PropertyAffordance],[MultiLanguage],[Form]<forms%200..*-++[InteractionAffordance|name:string],[DataSchema]<uriVariables%200..*-++[InteractionAffordance],[MultiLanguage]<descriptionInLanguage%200..1-%20[InteractionAffordance],[MultiLanguage]<titleInLanguage%200..1-%20[InteractionAffordance],[MultiLanguage]<description%200..1-%20[InteractionAffordance],[MultiLanguage]<title%200..1-%20[InteractionAffordance],[MultiLanguage]<descriptions%200..*-++[InteractionAffordance],[MultiLanguage]<titles%200..*-++[InteractionAffordance],[InteractionAffordance]^-[PropertyAffordance],[InteractionAffordance]^-[EventAffordance],[InteractionAffordance]^-[ActionAffordance],[Form],[EventAffordance],[DataSchema],[ActionAffordance])](https://yuml.me/diagram/nofunky;dir:TB/class/[PropertyAffordance],[MultiLanguage],[Form]<forms%200..*-++[InteractionAffordance|name:string],[DataSchema]<uriVariables%200..*-++[InteractionAffordance],[MultiLanguage]<descriptionInLanguage%200..1-%20[InteractionAffordance],[MultiLanguage]<titleInLanguage%200..1-%20[InteractionAffordance],[MultiLanguage]<description%200..1-%20[InteractionAffordance],[MultiLanguage]<title%200..1-%20[InteractionAffordance],[MultiLanguage]<descriptions%200..*-++[InteractionAffordance],[MultiLanguage]<titles%200..*-++[InteractionAffordance],[InteractionAffordance]^-[PropertyAffordance],[InteractionAffordance]^-[EventAffordance],[InteractionAffordance]^-[ActionAffordance],[Form],[EventAffordance],[DataSchema],[ActionAffordance]) + +## Children + + * [ActionAffordance](ActionAffordance.md) - An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time). + * [EventAffordance](EventAffordance.md) - An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts). + * [PropertyAffordance](PropertyAffordance.md) - An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated. + +## Referenced by Class + + +## Attributes + + +### Own + + * [titles](titles.md) <sub>0..\*</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptions](descriptions.md) <sub>0..\*</sub> + * Description: TODO, check, according to the description a description should not contain a lang tag. + * Range: [MultiLanguage](MultiLanguage.md) + * [title](title.md) <sub>0..1</sub> + * Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * Range: [MultiLanguage](MultiLanguage.md) + * [description](description.md) <sub>0..1</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [titleInLanguage](titleInLanguage.md) <sub>0..1</sub> + * Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptionInLanguage](descriptionInLanguage.md) <sub>0..1</sub> + * Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžžname](interactionAffordance__name.md) <sub>1..1</sub> + * Description: Indexing property to store entity names when serializing them in a JSON-LD @index container. + * Range: [String](types/String.md) + * [âžžuriVariables](interactionAffordance__uriVariables.md) <sub>0..\*</sub> + * Description: Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. + * Range: [DataSchema](DataSchema.md) + * [âžžforms](interactionAffordance__forms.md) <sub>0..\*</sub> + * Description: Set of form hypermedia controls that describe how an operation can be performed. + * Range: [Form](Form.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:InteractionAffordance | +# Class: Link + +A link can be viewed as a statement of the form link context that has a relation type resource at link target", where the optional target attributes may further describe the resource. + +URI: [td:Link](https://www.w3.org/2019/wot/td#Link) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Thing]++-%20links%200..*>[Link|target:anyUri;hintsAtMediaType:string%20%3F;type:string%20%3F;relation:string%20%3F;anchor:anyUri%20%3F;sizes:string%20%3F;hreflang:string%20%3F],[Thing])](https://yuml.me/diagram/nofunky;dir:TB/class/[Thing]++-%20links%200..*>[Link|target:anyUri;hintsAtMediaType:string%20%3F;type:string%20%3F;relation:string%20%3F;anchor:anyUri%20%3F;sizes:string%20%3F;hreflang:string%20%3F],[Thing]) + +## Referenced by Class + + * **None** *[âžžlinks](thing__links.md)* <sub>0..\*</sub> **[Link](Link.md)** + +## Attributes + + +### Own + + * [target](target.md) <sub>1..1</sub> + * Description: Target IRI of a link or submission target of a Form + * Range: [AnyUri](types/AnyUri.md) + * [âžžhintsAtMediaType](link__hintsAtMediaType.md) <sub>0..1</sub> + * Description: Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. + * Range: [String](types/String.md) + * [âžžtype](link__type.md) <sub>0..1</sub> + * Range: [String](types/String.md) + * [âžžrelation](link__relation.md) <sub>0..1</sub> + * Description: A link relation type identifies the semantics of a link. + * Range: [String](types/String.md) + * [âžžanchor](link__anchor.md) <sub>0..1</sub> + * Description: By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI. + * Range: [AnyUri](types/AnyUri.md) + * [âžžsizes](link__sizes.md) <sub>0..1</sub> + * Description: Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \"16x16\", \"16x16 32x32\"). + * Range: [String](types/String.md) + * [âžžhreflang](link__hreflang.md) <sub>0..1</sub> + * Description: The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]. + * Range: [String](types/String.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | hctl:Link | +# Class: MultiLanguage + + + +URI: [td:MultiLanguage](https://www.w3.org/2019/wot/td#MultiLanguage) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[DataSchema]-%20description%200..1>[MultiLanguage|key:string],[InteractionAffordance]-%20description%200..1>[MultiLanguage],[Thing]-%20description%200..1>[MultiLanguage],[DataSchema]-%20descriptionInLanguage%200..1>[MultiLanguage],[InteractionAffordance]-%20descriptionInLanguage%200..1>[MultiLanguage],[Thing]-%20descriptionInLanguage%200..1>[MultiLanguage],[SecurityScheme]++-%20descriptions%200..*>[MultiLanguage],[InteractionAffordance]++-%20descriptions%200..*>[MultiLanguage],[Thing]++-%20descriptions%200..*>[MultiLanguage],[DataSchema]-%20title%200..1>[MultiLanguage],[InteractionAffordance]-%20title%200..1>[MultiLanguage],[Thing]-%20title%200..1>[MultiLanguage],[DataSchema]-%20titleInLanguage%200..1>[MultiLanguage],[InteractionAffordance]-%20titleInLanguage%200..1>[MultiLanguage],[Thing]-%20titleInLanguage%200..1>[MultiLanguage],[InteractionAffordance]++-%20titles%200..*>[MultiLanguage],[Thing]++-%20titles%200..*>[MultiLanguage],[Thing],[SecurityScheme],[InteractionAffordance],[DataSchema])](https://yuml.me/diagram/nofunky;dir:TB/class/[DataSchema]-%20description%200..1>[MultiLanguage|key:string],[InteractionAffordance]-%20description%200..1>[MultiLanguage],[Thing]-%20description%200..1>[MultiLanguage],[DataSchema]-%20descriptionInLanguage%200..1>[MultiLanguage],[InteractionAffordance]-%20descriptionInLanguage%200..1>[MultiLanguage],[Thing]-%20descriptionInLanguage%200..1>[MultiLanguage],[SecurityScheme]++-%20descriptions%200..*>[MultiLanguage],[InteractionAffordance]++-%20descriptions%200..*>[MultiLanguage],[Thing]++-%20descriptions%200..*>[MultiLanguage],[DataSchema]-%20title%200..1>[MultiLanguage],[InteractionAffordance]-%20title%200..1>[MultiLanguage],[Thing]-%20title%200..1>[MultiLanguage],[DataSchema]-%20titleInLanguage%200..1>[MultiLanguage],[InteractionAffordance]-%20titleInLanguage%200..1>[MultiLanguage],[Thing]-%20titleInLanguage%200..1>[MultiLanguage],[InteractionAffordance]++-%20titles%200..*>[MultiLanguage],[Thing]++-%20titles%200..*>[MultiLanguage],[Thing],[SecurityScheme],[InteractionAffordance],[DataSchema]) + +## Referenced by Class + + * **None** *[description](description.md)* <sub>0..1</sub> **[MultiLanguage](MultiLanguage.md)** + * **None** *[descriptionInLanguage](descriptionInLanguage.md)* <sub>0..1</sub> **[MultiLanguage](MultiLanguage.md)** + * **None** *[descriptions](descriptions.md)* <sub>0..\*</sub> **[MultiLanguage](MultiLanguage.md)** + * **None** *[title](title.md)* <sub>0..1</sub> **[MultiLanguage](MultiLanguage.md)** + * **None** *[titleInLanguage](titleInLanguage.md)* <sub>0..1</sub> **[MultiLanguage](MultiLanguage.md)** + * **None** *[titles](titles.md)* <sub>0..\*</sub> **[MultiLanguage](MultiLanguage.md)** + +## Attributes + + +### Own + + * [âžžkey](multiLanguage__key.md) <sub>1..1</sub> + * Range: [String](types/String.md) + +# Class: PropertyAffordance + +An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated. + +URI: [td:PropertyAffordance](https://www.w3.org/2019/wot/td#PropertyAffordance) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Thing]++-%20properties%200..*>[PropertyAffordance|observable:boolean%20%3F;propertyName:string%20%3F;writeOnly:string%20%3F;readonly:string%20%3F;name(i):string],[PropertyAffordance]uses%20-.->[DataSchema],[InteractionAffordance]^-[PropertyAffordance],[Thing],[MultiLanguage],[InteractionAffordance],[Form],[DataSchema])](https://yuml.me/diagram/nofunky;dir:TB/class/[Thing]++-%20properties%200..*>[PropertyAffordance|observable:boolean%20%3F;propertyName:string%20%3F;writeOnly:string%20%3F;readonly:string%20%3F;name(i):string],[PropertyAffordance]uses%20-.->[DataSchema],[InteractionAffordance]^-[PropertyAffordance],[Thing],[MultiLanguage],[InteractionAffordance],[Form],[DataSchema]) + +## Parents + + * is_a: [InteractionAffordance](InteractionAffordance.md) - TOOD + +## Uses Mixin + + * mixin: [DataSchema](DataSchema.md) - Metadata that describes the data format used. It can be used for validation. + +## Referenced by Class + + * **None** *[âžžproperties](thing__properties.md)* <sub>0..\*</sub> **[PropertyAffordance](PropertyAffordance.md)** + +## Attributes + + +### Own + + * [âžžobservable](propertyAffordance__observable.md) <sub>0..1</sub> + * Description: A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property. + * Range: [Boolean](types/Boolean.md) + +### Inherited from InteractionAffordance: + + * [titles](titles.md) <sub>0..\*</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptions](descriptions.md) <sub>0..\*</sub> + * Description: TODO, check, according to the description a description should not contain a lang tag. + * Range: [MultiLanguage](MultiLanguage.md) + * [title](title.md) <sub>0..1</sub> + * Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * Range: [MultiLanguage](MultiLanguage.md) + * [description](description.md) <sub>0..1</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [titleInLanguage](titleInLanguage.md) <sub>0..1</sub> + * Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptionInLanguage](descriptionInLanguage.md) <sub>0..1</sub> + * Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžžname](interactionAffordance__name.md) <sub>1..1</sub> + * Description: Indexing property to store entity names when serializing them in a JSON-LD @index container. + * Range: [String](types/String.md) + * [âžžuriVariables](interactionAffordance__uriVariables.md) <sub>0..\*</sub> + * Description: Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. + * Range: [DataSchema](DataSchema.md) + * [âžžforms](interactionAffordance__forms.md) <sub>0..\*</sub> + * Description: Set of form hypermedia controls that describe how an operation can be performed. + * Range: [Form](Form.md) + +### Mixed in from DataSchema: + + * [âžžpropertyName](dataSchema__propertyName.md) <sub>0..1</sub> + * Description: Used to store the indexing name in the parent object when this schema appears as a property of an object schema. + * Range: [String](types/String.md) + +### Mixed in from DataSchema: + + * [âžžwriteOnly](dataSchema__writeOnly.md) <sub>0..1</sub> + * Description: Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false). + * Range: [String](types/String.md) + +### Mixed in from DataSchema: + + * [âžžreadonly](dataSchema__readonly.md) <sub>0..1</sub> + * Description: Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false). + * Range: [String](types/String.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:PropertyAffordance | +# Class: SecurityScheme + + + +URI: [td:SecurityScheme](https://www.w3.org/2019/wot/td#SecurityScheme) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage]<descriptions%200..*-++[SecurityScheme|@type:string%20*;description:string%20%3F;proxy:anyUri%20%3F;scheme:SecuritySchemeType],[MultiLanguage])](https://yuml.me/diagram/nofunky;dir:TB/class/[MultiLanguage]<descriptions%200..*-++[SecurityScheme|@type:string%20*;description:string%20%3F;proxy:anyUri%20%3F;scheme:SecuritySchemeType],[MultiLanguage]) + +## Attributes + + +### Own + + * [@type](@type.md) <sub>0..\*</sub> + * Range: [String](types/String.md) + * [descriptions](descriptions.md) <sub>0..\*</sub> + * Description: TODO, check, according to the description a description should not contain a lang tag. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžždescription](securityScheme__description.md) <sub>0..1</sub> + * Range: [String](types/String.md) + * [âžžproxy](securityScheme__proxy.md) <sub>0..1</sub> + * Description: URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint. + * Range: [AnyUri](types/AnyUri.md) + * [âžžscheme](securityScheme__scheme.md) <sub>1..1</sub> + * Range: [SecuritySchemeType](SecuritySchemeType.md) + +# Class: Thing + +An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things. + +URI: [td:Thing](https://www.w3.org/2019/wot/td#Thing) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[VersionInfo],[EventAffordance]<events%200..*-++[Thing|id:anyUri;@type:string%20*;securityDefinitions:string%20*;security:string%20*;profile:anyUri%20*;instance:string%20%3F;created:datetime%20%3F;modified:datetime%20%3F;supportContact:anyUri%20%3F;base:anyUri%20%3F],[ActionAffordance]<actions%200..*-++[Thing],[PropertyAffordance]<properties%200..*-++[Thing],[Link]<links%200..*-++[Thing],[Form]<forms%200..*-++[Thing],[VersionInfo]<version%200..1-++[Thing],[DataSchema]<schemaDefinitions%200..*-++[Thing],[MultiLanguage]<descriptionInLanguage%200..1-%20[Thing],[MultiLanguage]<titleInLanguage%200..1-%20[Thing],[MultiLanguage]<descriptions%200..*-++[Thing],[MultiLanguage]<titles%200..*-++[Thing],[MultiLanguage]<description%200..1-%20[Thing],[MultiLanguage]<title%200..1-%20[Thing],[PropertyAffordance],[MultiLanguage],[Link],[Form],[EventAffordance],[DataSchema],[ActionAffordance])](https://yuml.me/diagram/nofunky;dir:TB/class/[VersionInfo],[EventAffordance]<events%200..*-++[Thing|id:anyUri;@type:string%20*;securityDefinitions:string%20*;security:string%20*;profile:anyUri%20*;instance:string%20%3F;created:datetime%20%3F;modified:datetime%20%3F;supportContact:anyUri%20%3F;base:anyUri%20%3F],[ActionAffordance]<actions%200..*-++[Thing],[PropertyAffordance]<properties%200..*-++[Thing],[Link]<links%200..*-++[Thing],[Form]<forms%200..*-++[Thing],[VersionInfo]<version%200..1-++[Thing],[DataSchema]<schemaDefinitions%200..*-++[Thing],[MultiLanguage]<descriptionInLanguage%200..1-%20[Thing],[MultiLanguage]<titleInLanguage%200..1-%20[Thing],[MultiLanguage]<descriptions%200..*-++[Thing],[MultiLanguage]<titles%200..*-++[Thing],[MultiLanguage]<description%200..1-%20[Thing],[MultiLanguage]<title%200..1-%20[Thing],[PropertyAffordance],[MultiLanguage],[Link],[Form],[EventAffordance],[DataSchema],[ActionAffordance]) + +## Attributes + + +### Own + + * [id](id.md) <sub>1..1</sub> + * Description: TODO + * Range: [AnyUri](types/AnyUri.md) + * [title](title.md) <sub>0..1</sub> + * Description: Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + * Range: [MultiLanguage](MultiLanguage.md) + * [description](description.md) <sub>0..1</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [titles](titles.md) <sub>0..\*</sub> + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptions](descriptions.md) <sub>0..\*</sub> + * Description: TODO, check, according to the description a description should not contain a lang tag. + * Range: [MultiLanguage](MultiLanguage.md) + * [@type](@type.md) <sub>0..\*</sub> + * Range: [String](types/String.md) + * [titleInLanguage](titleInLanguage.md) <sub>0..1</sub> + * Description: title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [descriptionInLanguage](descriptionInLanguage.md) <sub>0..1</sub> + * Description: description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + * Range: [MultiLanguage](MultiLanguage.md) + * [âžžsecurityDefinitions](thing__securityDefinitions.md) <sub>0..\*</sub> + * Description: A security scheme applied to a (set of) affordance(s). TODO check + * Range: [String](types/String.md) + * [âžžsecurity](thing__security.md) <sub>0..\*</sub> + * Description: A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check + * Range: [String](types/String.md) + * [âžžschemaDefinitions](thing__schemaDefinitions.md) <sub>0..\*</sub> + * Description: TODO CHECK + * Range: [DataSchema](DataSchema.md) + * [âžžprofile](thing__profile.md) <sub>0..\*</sub> + * Description: Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation. + * Range: [AnyUri](types/AnyUri.md) + * [âžžinstance](thing__instance.md) <sub>0..1</sub> + * Description: Provides a version identicator of this TD instance. + * Range: [String](types/String.md) + * [âžžcreated](thing__created.md) <sub>0..1</sub> + * Description: Provides information when the TD instance was created. + * Range: [Datetime](types/Datetime.md) + * [âžžmodified](thing__modified.md) <sub>0..1</sub> + * Description: Provides information when the TD instance was last modified. + * Range: [Datetime](types/Datetime.md) + * [âžžsupportContact](thing__supportContact.md) <sub>0..1</sub> + * Description: Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]). + * Range: [AnyUri](types/AnyUri.md) + * [âžžbase](thing__base.md) <sub>0..1</sub> + * Description: Define the base URI that is used for all relative URI references throughout a TD document. + * Range: [AnyUri](types/AnyUri.md) + * [âžžversion](thing__version.md) <sub>0..1</sub> + * Range: [VersionInfo](VersionInfo.md) + * [âžžforms](thing__forms.md) <sub>0..\*</sub> + * Description: Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings. + * Range: [Form](Form.md) + * [âžžlinks](thing__links.md) <sub>0..\*</sub> + * Description: Provides Web links to arbitrary resources that relate to the specified Thing Description. + * Range: [Link](Link.md) + * [âžžproperties](thing__properties.md) <sub>0..\*</sub> + * Description: All Property-based interaction affordances of the Thing. + * Range: [PropertyAffordance](PropertyAffordance.md) + * [âžžactions](thing__actions.md) <sub>0..\*</sub> + * Description: All Action-based interaction affordances of the Thing. + * Range: [ActionAffordance](ActionAffordance.md) + * [âžževents](thing__events.md) <sub>0..\*</sub> + * Description: All Event-based interaction affordances of the Thing. + * Range: [EventAffordance](EventAffordance.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:Thing | +# Class: VersionInfo + +Provides version information. + +URI: [td:VersionInfo](https://www.w3.org/2019/wot/td#VersionInfo) + + +[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Thing]++-%20version%200..1>[VersionInfo|instance:string;model:string%20%3F],[Thing])](https://yuml.me/diagram/nofunky;dir:TB/class/[Thing]++-%20version%200..1>[VersionInfo|instance:string;model:string%20%3F],[Thing]) + +## Referenced by Class + + * **None** *[âžžversion](thing__version.md)* <sub>0..1</sub> **[VersionInfo](VersionInfo.md)** + +## Attributes + + +### Own + + * [âžžinstance](versionInfo__instance.md) <sub>1..1</sub> + * Range: [String](types/String.md) + * [âžžmodel](versionInfo__model.md) <sub>0..1</sub> + * Range: [String](types/String.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | schema:version | \ No newline at end of file diff --git a/resources/gens/markdown/title.md b/resources/gens/markdown/title.md new file mode 100644 index 0000000..3d824ea --- /dev/null +++ b/resources/gens/markdown/title.md @@ -0,0 +1,32 @@ + +# Slot: title + +Provides a human-readable title (e.g., display a text for UI representation) based on a default language. + +URI: [td:title](https://www.w3.org/2019/wot/td#title) + + +## Domain and Range + +None → <sub>0..1</sub> [MultiLanguage](MultiLanguage.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [DataSchema](DataSchema.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + * [Thing](Thing.md) + +## Other properties + +| | | | +| --- | --- | --- | +| **Mappings:** | | td:title | \ No newline at end of file diff --git a/resources/gens/markdown/titleInLanguage.md b/resources/gens/markdown/titleInLanguage.md new file mode 100644 index 0000000..049ff20 --- /dev/null +++ b/resources/gens/markdown/titleInLanguage.md @@ -0,0 +1,26 @@ + +# Slot: titleInLanguage + +title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. + +URI: [td:titleInLanguage](https://www.w3.org/2019/wot/td#titleInLanguage) + + +## Domain and Range + +None → <sub>0..1</sub> [MultiLanguage](MultiLanguage.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [DataSchema](DataSchema.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + * [Thing](Thing.md) diff --git a/resources/gens/markdown/titles.md b/resources/gens/markdown/titles.md new file mode 100644 index 0000000..36e5281 --- /dev/null +++ b/resources/gens/markdown/titles.md @@ -0,0 +1,25 @@ + +# Slot: titles + + + +URI: [td:titles](https://www.w3.org/2019/wot/td#titles) + + +## Domain and Range + +None → <sub>0..\*</sub> [MultiLanguage](MultiLanguage.md) + +## Parents + + +## Children + + +## Used by + + * [ActionAffordance](ActionAffordance.md) + * [EventAffordance](EventAffordance.md) + * [InteractionAffordance](InteractionAffordance.md) + * [PropertyAffordance](PropertyAffordance.md) + * [Thing](Thing.md) diff --git a/resources/gens/markdown/types/AnyUri.md b/resources/gens/markdown/types/AnyUri.md new file mode 100644 index 0000000..d3a9f6c --- /dev/null +++ b/resources/gens/markdown/types/AnyUri.md @@ -0,0 +1,10 @@ + +# Type: anyUri + +a complete URI + +URI: [td:AnyUri](https://www.w3.org/2019/wot/td#AnyUri) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **URI** | diff --git a/resources/gens/markdown/types/Boolean.md b/resources/gens/markdown/types/Boolean.md new file mode 100644 index 0000000..fc97222 --- /dev/null +++ b/resources/gens/markdown/types/Boolean.md @@ -0,0 +1,17 @@ + +# Type: boolean + +A binary (true or false) value + +URI: [linkml:Boolean](https://w3id.org/linkml/Boolean) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **Bool** | +| Representation | | bool | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:Boolean | diff --git a/resources/gens/markdown/types/Curie.md b/resources/gens/markdown/types/Curie.md new file mode 100644 index 0000000..b28741b --- /dev/null +++ b/resources/gens/markdown/types/Curie.md @@ -0,0 +1,18 @@ + +# Type: curie + +a compact URI + +URI: [linkml:Curie](https://w3id.org/linkml/Curie) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **Curie** | +| Representation | | str | + +## Other properties + +| | | | +| --- | --- | --- | +| **Comments:** | | in RDF serializations this MUST be expanded to a URI | +| | | in non-RDF serializations MAY be serialized as the compact representation | diff --git a/resources/gens/markdown/types/Date.md b/resources/gens/markdown/types/Date.md new file mode 100644 index 0000000..0c0ca29 --- /dev/null +++ b/resources/gens/markdown/types/Date.md @@ -0,0 +1,17 @@ + +# Type: date + +a date (year, month and day) in an idealized calendar + +URI: [linkml:Date](https://w3id.org/linkml/Date) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **XSDDate** | +| Representation | | str | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:Date | diff --git a/resources/gens/markdown/types/DateOrDatetime.md b/resources/gens/markdown/types/DateOrDatetime.md new file mode 100644 index 0000000..d16623f --- /dev/null +++ b/resources/gens/markdown/types/DateOrDatetime.md @@ -0,0 +1,11 @@ + +# Type: date_or_datetime + +Either a date or a datetime + +URI: [linkml:DateOrDatetime](https://w3id.org/linkml/DateOrDatetime) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **str** | +| Representation | | str | diff --git a/resources/gens/markdown/types/Datetime.md b/resources/gens/markdown/types/Datetime.md new file mode 100644 index 0000000..432955c --- /dev/null +++ b/resources/gens/markdown/types/Datetime.md @@ -0,0 +1,17 @@ + +# Type: datetime + +The combination of a date and time + +URI: [linkml:Datetime](https://w3id.org/linkml/Datetime) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **XSDDateTime** | +| Representation | | str | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:DateTime | diff --git a/resources/gens/markdown/types/Decimal.md b/resources/gens/markdown/types/Decimal.md new file mode 100644 index 0000000..164eb96 --- /dev/null +++ b/resources/gens/markdown/types/Decimal.md @@ -0,0 +1,16 @@ + +# Type: decimal + +A real number with arbitrary precision that conforms to the xsd:decimal specification + +URI: [linkml:Decimal](https://w3id.org/linkml/Decimal) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **Decimal** | + +## Other properties + +| | | | +| --- | --- | --- | +| **Broad Mappings:** | | schema:Number | diff --git a/resources/gens/markdown/types/Double.md b/resources/gens/markdown/types/Double.md new file mode 100644 index 0000000..b08fe52 --- /dev/null +++ b/resources/gens/markdown/types/Double.md @@ -0,0 +1,16 @@ + +# Type: double + +A real number that conforms to the xsd:double specification + +URI: [linkml:Double](https://w3id.org/linkml/Double) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **float** | + +## Other properties + +| | | | +| --- | --- | --- | +| **Close Mappings:** | | schema:Float | diff --git a/resources/gens/markdown/types/Float.md b/resources/gens/markdown/types/Float.md new file mode 100644 index 0000000..b473c2b --- /dev/null +++ b/resources/gens/markdown/types/Float.md @@ -0,0 +1,16 @@ + +# Type: float + +A real number that conforms to the xsd:float specification + +URI: [linkml:Float](https://w3id.org/linkml/Float) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **float** | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:Float | diff --git a/resources/gens/markdown/types/Integer.md b/resources/gens/markdown/types/Integer.md new file mode 100644 index 0000000..12290d4 --- /dev/null +++ b/resources/gens/markdown/types/Integer.md @@ -0,0 +1,16 @@ + +# Type: integer + +An integer + +URI: [linkml:Integer](https://w3id.org/linkml/Integer) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **int** | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:Integer | diff --git a/resources/gens/markdown/types/Jsonpath.md b/resources/gens/markdown/types/Jsonpath.md new file mode 100644 index 0000000..c35a38f --- /dev/null +++ b/resources/gens/markdown/types/Jsonpath.md @@ -0,0 +1,11 @@ + +# Type: jsonpath + +A string encoding a JSON Path. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded in tree form. + +URI: [linkml:Jsonpath](https://w3id.org/linkml/Jsonpath) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **str** | +| Representation | | str | diff --git a/resources/gens/markdown/types/Jsonpointer.md b/resources/gens/markdown/types/Jsonpointer.md new file mode 100644 index 0000000..f3460de --- /dev/null +++ b/resources/gens/markdown/types/Jsonpointer.md @@ -0,0 +1,11 @@ + +# Type: jsonpointer + +A string encoding a JSON Pointer. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to a valid object within the current instance document when encoded in tree form. + +URI: [linkml:Jsonpointer](https://w3id.org/linkml/Jsonpointer) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **str** | +| Representation | | str | diff --git a/resources/gens/markdown/types/Ncname.md b/resources/gens/markdown/types/Ncname.md new file mode 100644 index 0000000..317223f --- /dev/null +++ b/resources/gens/markdown/types/Ncname.md @@ -0,0 +1,11 @@ + +# Type: ncname + +Prefix part of CURIE + +URI: [linkml:Ncname](https://w3id.org/linkml/Ncname) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **NCName** | +| Representation | | str | diff --git a/resources/gens/markdown/types/Nodeidentifier.md b/resources/gens/markdown/types/Nodeidentifier.md new file mode 100644 index 0000000..d30c3e8 --- /dev/null +++ b/resources/gens/markdown/types/Nodeidentifier.md @@ -0,0 +1,11 @@ + +# Type: nodeidentifier + +A URI, CURIE or BNODE that represents a node in a model. + +URI: [linkml:Nodeidentifier](https://w3id.org/linkml/Nodeidentifier) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **NodeIdentifier** | +| Representation | | str | diff --git a/resources/gens/markdown/types/Objectidentifier.md b/resources/gens/markdown/types/Objectidentifier.md new file mode 100644 index 0000000..c2850b7 --- /dev/null +++ b/resources/gens/markdown/types/Objectidentifier.md @@ -0,0 +1,17 @@ + +# Type: objectidentifier + +A URI or CURIE that represents an object in the model. + +URI: [linkml:Objectidentifier](https://w3id.org/linkml/Objectidentifier) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **ElementIdentifier** | +| Representation | | str | + +## Other properties + +| | | | +| --- | --- | --- | +| **Comments:** | | Used for inheritance and type checking | diff --git a/resources/gens/markdown/types/Sparqlpath.md b/resources/gens/markdown/types/Sparqlpath.md new file mode 100644 index 0000000..7f03b24 --- /dev/null +++ b/resources/gens/markdown/types/Sparqlpath.md @@ -0,0 +1,11 @@ + +# Type: sparqlpath + +A string encoding a SPARQL Property Path. The value of the string MUST conform to SPARQL syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded as RDF. + +URI: [linkml:Sparqlpath](https://w3id.org/linkml/Sparqlpath) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **str** | +| Representation | | str | diff --git a/resources/gens/markdown/types/String.md b/resources/gens/markdown/types/String.md new file mode 100644 index 0000000..8313e14 --- /dev/null +++ b/resources/gens/markdown/types/String.md @@ -0,0 +1,16 @@ + +# Type: string + +A character string + +URI: [linkml:String](https://w3id.org/linkml/String) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **str** | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:Text | diff --git a/resources/gens/markdown/types/Time.md b/resources/gens/markdown/types/Time.md new file mode 100644 index 0000000..76bb966 --- /dev/null +++ b/resources/gens/markdown/types/Time.md @@ -0,0 +1,17 @@ + +# Type: time + +A time object represents a (local) time of day, independent of any particular day + +URI: [linkml:Time](https://w3id.org/linkml/Time) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **XSDTime** | +| Representation | | str | + +## Other properties + +| | | | +| --- | --- | --- | +| **Exact Mappings:** | | schema:Time | diff --git a/resources/gens/markdown/types/Uri.md b/resources/gens/markdown/types/Uri.md new file mode 100644 index 0000000..fbb5431 --- /dev/null +++ b/resources/gens/markdown/types/Uri.md @@ -0,0 +1,18 @@ + +# Type: uri + +a complete URI + +URI: [linkml:Uri](https://w3id.org/linkml/Uri) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **URI** | +| Representation | | str | + +## Other properties + +| | | | +| --- | --- | --- | +| **Comments:** | | in RDF serializations a slot with range of uri is treated as a literal or type xsd:anyURI unless it is an identifier or a reference to an identifier, in which case it is translated directly to a node | +| **Close Mappings:** | | schema:URL | diff --git a/resources/gens/markdown/types/Uriorcurie.md b/resources/gens/markdown/types/Uriorcurie.md new file mode 100644 index 0000000..edba484 --- /dev/null +++ b/resources/gens/markdown/types/Uriorcurie.md @@ -0,0 +1,11 @@ + +# Type: uriorcurie + +a URI or a CURIE + +URI: [linkml:Uriorcurie](https://w3id.org/linkml/Uriorcurie) + +| | | | +| --- | --- | --- | +| Root (builtin) type | | **URIorCURIE** | +| Representation | | str | diff --git a/resources/gens/markdown/versionInfo__instance.md b/resources/gens/markdown/versionInfo__instance.md new file mode 100644 index 0000000..f7181ca --- /dev/null +++ b/resources/gens/markdown/versionInfo__instance.md @@ -0,0 +1,21 @@ + +# Slot: instance + + + +URI: [td:versionInfo__instance](https://www.w3.org/2019/wot/td#versionInfo__instance) + + +## Domain and Range + +None → <sub>1..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [VersionInfo](VersionInfo.md) diff --git a/resources/gens/markdown/versionInfo__model.md b/resources/gens/markdown/versionInfo__model.md new file mode 100644 index 0000000..2e326a5 --- /dev/null +++ b/resources/gens/markdown/versionInfo__model.md @@ -0,0 +1,21 @@ + +# Slot: model + + + +URI: [td:versionInfo__model](https://www.w3.org/2019/wot/td#versionInfo__model) + + +## Domain and Range + +None → <sub>0..1</sub> [String](types/String.md) + +## Parents + + +## Children + + +## Used by + + * [VersionInfo](VersionInfo.md) diff --git a/resources/gens/owl/thing_description_schema.owl.ttl b/resources/gens/owl/thing_description_schema.owl.ttl new file mode 100644 index 0000000..c60a330 --- /dev/null +++ b/resources/gens/owl/thing_description_schema.owl.ttl @@ -0,0 +1,1287 @@ +@prefix dct: <http://purl.org/dc/terms/> . +@prefix hctl: <https://www.w3.org/2019/wot/hypermedia#> . +@prefix jsonschema: <https://www.w3.org/2019/wot/json-schema#> . +@prefix linkml: <https://w3id.org/linkml/> . +@prefix owl: <http://www.w3.org/2002/07/owl#> . +@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> . +@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . +@prefix schema1: <http://schema.org/> . +@prefix skos: <http://www.w3.org/2004/02/skos/core#> . +@prefix td: <https://www.w3.org/2019/wot/td#> . +@prefix wotsec: <https://www.w3.org/2019/wot/security#> . +@prefix xsd: <http://www.w3.org/2001/XMLSchema#> . + +td:SecurityScheme a owl:Class, + linkml:ClassDefinition ; + rdfs:label "SecurityScheme" ; + rdfs:subClassOf [ a owl:Restriction ; + owl:allValuesFrom owl:Thing ; + owl:onProperty td:description ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty <https://www.w3.org/2019/wot/td#@type> ], + [ a owl:Restriction ; + owl:allValuesFrom td:anyUri ; + owl:onProperty td:proxy ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:scheme ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:descriptions ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:description ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:proxy ], + [ a owl:Restriction ; + owl:minCardinality 1 ; + owl:onProperty td:scheme ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:proxy ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:descriptions ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty <https://www.w3.org/2019/wot/td#@type> ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:description ], + [ a owl:Restriction ; + owl:allValuesFrom td:SecuritySchemeType ; + owl:onProperty td:scheme ] ; + skos:inScheme <td> . + +linkml:topValue a owl:DatatypeProperty ; + rdfs:label "value" . + +td:AdditionalExpectedResponse a owl:Class, + linkml:ClassDefinition ; + rdfs:label "AdditionalExpectedResponse" ; + rdfs:subClassOf [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:schema ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:schema ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:schema ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:success ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:additionalOutputSchema ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:additionalOutputSchema ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:success ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:additionalOutputSchema ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:Boolean ; + owl:onProperty td:success ], + td:ExpectedResponse ; + skos:definition "Communication metadata describing the expected response message for additional responses." ; + skos:exactMatch hctl:AdditionalExpectedResponse ; + skos:inScheme <td> . + +td:Link a owl:Class, + linkml:ClassDefinition ; + rdfs:label "Link" ; + rdfs:subClassOf [ a owl:Restriction ; + owl:allValuesFrom td:anyUri ; + owl:onProperty td:target ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:relation ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:hintsAtMediaType ], + [ a owl:Restriction ; + owl:minCardinality 1 ; + owl:onProperty td:target ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:hintsAtMediaType ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:relation ], + [ a owl:Restriction ; + owl:allValuesFrom td:anyUri ; + owl:onProperty td:anchor ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:type ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:hreflang ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:relation ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:type ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:anchor ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:sizes ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:hreflang ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:sizes ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:anchor ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:type ], + [ a owl:Restriction ; + owl:allValuesFrom [ a rdfs:Datatype ; + owl:onDatatype xsd:string ; + owl:withRestrictions ( [ xsd:pattern "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$" ] ) ] ; + owl:onProperty td:hreflang ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:sizes ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:target ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:hintsAtMediaType ] ; + skos:definition "A link can be viewed as a statement of the form link context that has a relation type resource at link target\", where the optional target attributes may further describe the resource." ; + skos:exactMatch hctl:Link ; + skos:inScheme <td> . + +td:Thing a owl:Class, + linkml:ClassDefinition ; + rdfs:label "Thing" ; + rdfs:subClassOf [ a owl:Restriction ; + owl:allValuesFrom td:VersionInfo ; + owl:onProperty td:version ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:created ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:securityDefinitions ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:links ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:forms ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:description ], + [ a owl:Restriction ; + owl:allValuesFrom td:anyUri ; + owl:onProperty td:base ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:titles ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:modified ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:title ], + [ a owl:Restriction ; + owl:allValuesFrom td:anyUri ; + owl:onProperty td:id ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty <https://www.w3.org/2019/wot/td#@type> ], + [ a owl:Restriction ; + owl:allValuesFrom td:DataSchema ; + owl:onProperty td:schemaDefinitions ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:properties ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:descriptions ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:supportContact ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:titles ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:version ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:modified ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:titleInLanguage ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:description ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:profile ], + [ a owl:Restriction ; + owl:allValuesFrom [ a rdfs:Datatype ; + owl:unionOf ( linkml:String td:SecuritySchemeType ) ] ; + owl:onProperty td:securityDefinitions ], + [ a owl:Restriction ; + owl:minCardinality 1 ; + owl:onProperty td:id ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:events ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:descriptionInLanguage ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:descriptions ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:security ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:instance ], + [ a owl:Restriction ; + owl:allValuesFrom td:ActionAffordance ; + owl:onProperty td:actions ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:instance ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:title ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:security ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:id ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:created ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:description ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty <https://www.w3.org/2019/wot/td#@type> ], + [ a owl:Restriction ; + owl:allValuesFrom td:Link ; + owl:onProperty td:links ], + [ a owl:Restriction ; + owl:allValuesFrom td:anyUri ; + owl:onProperty td:profile ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:actions ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:instance ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:schemaDefinitions ], + [ a owl:Restriction ; + owl:allValuesFrom td:EventAffordance ; + owl:onProperty td:events ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:base ], + [ a owl:Restriction ; + owl:allValuesFrom td:Form ; + owl:onProperty td:forms ], + [ a owl:Restriction ; + owl:allValuesFrom td:PropertyAffordance ; + owl:onProperty td:properties ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:descriptionInLanguage ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:titleInLanguage ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:titleInLanguage ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:Datetime ; + owl:onProperty td:created ], + [ a owl:Restriction ; + owl:allValuesFrom td:anyUri ; + owl:onProperty td:supportContact ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:base ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:descriptionInLanguage ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:supportContact ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:Datetime ; + owl:onProperty td:modified ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:version ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:title ] ; + skos:definition "An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things." ; + skos:exactMatch td:Thing ; + skos:inScheme <td> . + +td:VersionInfo a owl:Class, + linkml:ClassDefinition ; + rdfs:label "VersionInfo" ; + rdfs:subClassOf [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:instance ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:instance ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:model ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:model ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:model ], + [ a owl:Restriction ; + owl:minCardinality 1 ; + owl:onProperty td:instance ] ; + skos:definition "Provides version information." ; + skos:exactMatch schema1:version ; + skos:inScheme <td> . + +wotsec:APIKeySecurityScheme a owl:Class, + td:SecuritySchemeType ; + rdfs:label "apikey" ; + rdfs:subClassOf td:SecuritySchemeType . + +wotsec:AutoSecurityScheme a owl:Class, + td:SecuritySchemeType ; + rdfs:label "auto" ; + rdfs:subClassOf td:SecuritySchemeType . + +wotsec:BasicSecurityScheme a owl:Class, + td:SecuritySchemeType ; + rdfs:label "basic" ; + rdfs:subClassOf td:SecuritySchemeType . + +wotsec:BearerSecurityScheme a owl:Class, + td:SecuritySchemeType ; + rdfs:label "bearer" ; + rdfs:subClassOf td:SecuritySchemeType . + +wotsec:ComboSecurityScheme a owl:Class, + td:SecuritySchemeType ; + rdfs:label "combo" ; + rdfs:subClassOf td:SecuritySchemeType . + +wotsec:DigestSecurityScheme a owl:Class, + td:SecuritySchemeType ; + rdfs:label "digest" ; + rdfs:subClassOf td:SecuritySchemeType . + +wotsec:NoSecurityScheme a owl:Class, + td:SecuritySchemeType ; + rdfs:label "nosec" ; + rdfs:subClassOf td:SecuritySchemeType . + +wotsec:OAuth2SecurityScheme a owl:Class, + td:SecuritySchemeType ; + rdfs:label "oauth2" ; + rdfs:subClassOf td:SecuritySchemeType . + +wotsec:PSKSecurityScheme a owl:Class, + td:SecuritySchemeType ; + rdfs:label "psk" ; + rdfs:subClassOf td:SecuritySchemeType . + +td:ActionAffordance a owl:Class, + linkml:ClassDefinition ; + rdfs:label "ActionAffordance" ; + rdfs:subClassOf [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:synchronous ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:synchronous ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:safe ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:idempotent ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:idempotent ], + [ a owl:Restriction ; + owl:allValuesFrom td:DataSchema ; + owl:onProperty td:input ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:input ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:output ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:safe ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:Boolean ; + owl:onProperty td:idempotent ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:input ], + [ a owl:Restriction ; + owl:allValuesFrom td:DataSchema ; + owl:onProperty td:output ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:Boolean ; + owl:onProperty td:safe ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:output ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:Boolean ; + owl:onProperty td:synchronous ], + td:InteractionAffordance ; + skos:definition "An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time)." ; + skos:exactMatch td:ActionAffordance ; + skos:inScheme <td> . + +td:EventAffordance a owl:Class, + linkml:ClassDefinition ; + rdfs:label "EventAffordance" ; + rdfs:subClassOf [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:subscription ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:notificationResponse ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:subscription ], + [ a owl:Restriction ; + owl:allValuesFrom td:DataSchema ; + owl:onProperty td:subscription ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:cancellation ], + [ a owl:Restriction ; + owl:allValuesFrom td:DataSchema ; + owl:onProperty td:notificationResponse ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:cancellation ], + [ a owl:Restriction ; + owl:allValuesFrom td:DataSchema ; + owl:onProperty td:notification ], + [ a owl:Restriction ; + owl:allValuesFrom td:DataSchema ; + owl:onProperty td:cancellation ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:notification ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:notification ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:notificationResponse ], + td:InteractionAffordance ; + skos:definition "An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts)." ; + skos:exactMatch td:EventAffordance ; + skos:inScheme <td> . + +td:ExpectedResponse a owl:Class, + linkml:ClassDefinition ; + rdfs:label "ExpectedResponse" ; + rdfs:subClassOf [ a owl:Restriction ; + owl:minCardinality 1 ; + owl:onProperty td:contentType ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:contentType ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:contentType ] ; + skos:definition "Communication metadata describing the expected response message for the primary response." ; + skos:exactMatch hctl:ExpectedResponse ; + skos:inScheme <td> . + +td:Form a owl:Class, + linkml:ClassDefinition ; + rdfs:label "Form" ; + rdfs:subClassOf [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:contentCoding ], + [ a owl:Restriction ; + owl:allValuesFrom td:anyUri ; + owl:onProperty td:target ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:subprotocol ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:returns ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:contentCoding ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:securityDefinitions ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:additionalReturns ], + [ a owl:Restriction ; + owl:allValuesFrom td:OperationTypes ; + owl:onProperty td:operationType ], + [ a owl:Restriction ; + owl:minCardinality 1 ; + owl:onProperty td:target ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:operationType ], + [ a owl:Restriction ; + owl:allValuesFrom td:AdditionalExpectedResponse ; + owl:onProperty td:additionalReturns ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:contentType ], + [ a owl:Restriction ; + owl:allValuesFrom td:anyUri ; + owl:onProperty td:href ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:scopes ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:subprotocol ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:contentCoding ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:href ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:securityDefinitions ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:contentType ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:securityDefinitions ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:subprotocol ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:scopes ], + [ a owl:Restriction ; + owl:allValuesFrom td:ExpectedResponse ; + owl:onProperty td:returns ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:target ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:contentType ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:returns ], + [ a owl:Restriction ; + owl:minCardinality 1 ; + owl:onProperty td:href ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:scopes ] ; + skos:definition "A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions." ; + skos:exactMatch hctl:Form ; + skos:inScheme <td> . + +td:PropertyAffordance a owl:Class, + linkml:ClassDefinition ; + rdfs:label "PropertyAffordance" ; + rdfs:subClassOf [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:observable ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:Boolean ; + owl:onProperty td:observable ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:observable ], + td:DataSchema, + td:InteractionAffordance ; + skos:definition "An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated." ; + skos:exactMatch td:PropertyAffordance ; + skos:inScheme <td> . + +td:actions a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "actions" ; + skos:definition "All Action-based interaction affordances of the Thing." ; + skos:inScheme <td> . + +td:additionalReturns a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "additionalReturns" ; + skos:definition "This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema." ; + skos:inScheme <td> . + +td:cancelAction a owl:Class, + td:OperationTypes ; + rdfs:label "cancelaction" ; + rdfs:subClassOf td:OperationTypes . + +td:events a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "events" ; + skos:definition "All Event-based interaction affordances of the Thing." ; + skos:inScheme <td> . + +td:invokeAction a owl:Class, + td:OperationTypes ; + rdfs:label "invokeaction" ; + rdfs:subClassOf td:OperationTypes . + +td:links a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "links" ; + skos:definition "Provides Web links to arbitrary resources that relate to the specified Thing Description." ; + skos:inScheme <td> . + +td:observeAllProperties a owl:Class, + td:OperationTypes ; + rdfs:label "observeallproperties" ; + rdfs:subClassOf td:OperationTypes . + +td:observeProperty a owl:Class, + td:OperationTypes ; + rdfs:label "observeproperty" ; + rdfs:subClassOf td:OperationTypes . + +td:operationType a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "operationType" ; + skos:definition "Indicates the semantic intention of performing the operation(s) described by the form." ; + skos:inScheme <td> . + +td:profile a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "profile" ; + skos:definition "Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation." ; + skos:inScheme <td> . + +td:properties a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "properties" ; + skos:definition "All Property-based interaction affordances of the Thing." ; + skos:inScheme <td> . + +td:queryAction a owl:Class, + td:OperationTypes ; + rdfs:label "queryaction" ; + rdfs:subClassOf td:OperationTypes . + +td:queryAllActions a owl:Class, + td:OperationTypes ; + rdfs:label "queryallactions" ; + rdfs:subClassOf td:OperationTypes . + +td:readAllProperties a owl:Class, + td:OperationTypes ; + rdfs:label "readallproperties" ; + rdfs:subClassOf td:OperationTypes . + +td:readMultipleProperties a owl:Class, + td:OperationTypes ; + rdfs:label "readmultipleproperties" ; + rdfs:subClassOf td:OperationTypes . + +td:readProperty a owl:Class, + td:OperationTypes ; + rdfs:label "readproperty" ; + rdfs:subClassOf td:OperationTypes . + +td:schemaDefinitions a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "schemaDefinitions" ; + skos:definition "TODO CHECK" ; + skos:inScheme <td> . + +td:security a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "security" ; + skos:definition "A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check" ; + skos:inScheme <td> . + +td:subscribeAllEvents a owl:Class, + td:OperationTypes ; + rdfs:label "subscribeallevents" ; + rdfs:subClassOf td:OperationTypes . + +td:subscribeEvent a owl:Class, + td:OperationTypes ; + rdfs:label "subscribeevent" ; + rdfs:subClassOf td:OperationTypes . + +td:unobserveAllProperties a owl:Class, + td:OperationTypes ; + rdfs:label "unobserveallproperties" ; + rdfs:subClassOf td:OperationTypes . + +td:unobserveProperty a owl:Class, + td:OperationTypes ; + rdfs:label "unobserveproperty" ; + rdfs:subClassOf td:OperationTypes . + +td:unsubscribeAllEvents a owl:Class, + td:OperationTypes ; + rdfs:label "unsubscribeallevents" ; + rdfs:subClassOf td:OperationTypes . + +td:unsubscribeEvent a owl:Class, + td:OperationTypes ; + rdfs:label "unsubscribeevent" ; + rdfs:subClassOf td:OperationTypes . + +td:uriVariables a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "uriVariables" ; + skos:definition "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology." ; + skos:inScheme <td> . + +td:writeMultipleProperties a owl:Class, + td:OperationTypes ; + rdfs:label "writemultipleproperties" ; + rdfs:subClassOf td:OperationTypes . + +td:writeProperty a owl:Class, + td:OperationTypes ; + rdfs:label "writeproperty" ; + rdfs:subClassOf td:OperationTypes . + +<writeAllProperties> a owl:Class, + td:OperationTypes ; + rdfs:label "writeallproperties" ; + rdfs:subClassOf td:OperationTypes . + +td:additionalOutputSchema a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "additionalOutputSchema" ; + skos:definition "This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used." ; + skos:inScheme <td> . + +td:anchor a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "anchor" ; + skos:definition "By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI." ; + skos:inScheme <td> . + +td:base a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "base" ; + skos:definition "Define the base URI that is used for all relative URI references throughout a TD document." ; + skos:inScheme <td> . + +td:cancellation a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "cancellation" ; + skos:definition "Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook." ; + skos:inScheme <td> . + +td:contentCoding a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "contentCoding" ; + skos:definition "Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \\\"gzip\\\", \\\"deflate\\\", etc." ; + skos:inScheme <td> . + +td:created a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "created" ; + skos:definition "Provides information when the TD instance was created." ; + skos:inScheme <td> . + +td:hintsAtMediaType a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "hintsAtMediaType" ; + skos:definition "Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be." ; + skos:inScheme <td> . + +td:href a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "href" ; + skos:inScheme <td> . + +td:hreflang a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "hreflang" ; + skos:definition "The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]." ; + skos:inScheme <td> . + +td:id a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "id" ; + rdfs:range td:anyUri ; + skos:definition "TODO" ; + skos:inScheme <td> . + +td:idempotent a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "idempotent" ; + skos:definition "Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input." ; + skos:inScheme <td> . + +td:input a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "input" ; + skos:definition "Used to define the input data schema of the action." ; + skos:inScheme <td> . + +td:key a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "key" ; + skos:inScheme <td> . + +td:model a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "model" ; + skos:inScheme <td> . + +td:modified a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "modified" ; + skos:definition "Provides information when the TD instance was last modified." ; + skos:inScheme <td> . + +td:name a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "name" ; + skos:definition "Indexing property to store entity names when serializing them in a JSON-LD @index container." ; + skos:inScheme <td> . + +td:notification a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "notification" ; + skos:definition "Defines the data schema of the Event instance messages pushed by the Thing." ; + skos:inScheme <td> . + +td:notificationResponse a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "notificationResponse" ; + skos:definition "Defines the data schema of the Event response messages sent by the consumer in a response to a data message." ; + skos:inScheme <td> . + +td:observable a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "observable" ; + skos:definition "A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property." ; + skos:inScheme <td> . + +td:output a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "output" ; + skos:definition "Used to define the output data schema of the action." ; + skos:inScheme <td> . + +td:propertyName a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "propertyName" ; + skos:definition "Used to store the indexing name in the parent object when this schema appears as a property of an object schema." ; + skos:inScheme <td> . + +td:proxy a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "proxy" ; + skos:definition "URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint." ; + skos:inScheme <td> . + +td:readonly a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "readonly" ; + skos:definition "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false)." ; + skos:inScheme <td> . + +td:relation a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "relation" ; + skos:definition "A link relation type identifies the semantics of a link." ; + skos:inScheme <td> . + +td:returns a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "returns" ; + skos:definition "This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages." ; + skos:inScheme <td> . + +td:safe a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "safe" ; + skos:definition "Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action." ; + skos:inScheme <td> . + +td:schema a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "schema" ; + skos:definition "TODO Check, was not in hctl ontology, if not could be source of discrepancy" ; + skos:inScheme <td> . + +td:scheme a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "scheme" ; + skos:inScheme <td> . + +td:scopes a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "scopes" ; + skos:definition "TODO Check, was not in hctl ontology, if not could be source of discrepancy" ; + skos:inScheme <td> . + +td:sizes a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "sizes" ; + skos:definition "Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \\\"16x16\\\", \\\"16x16 32x32\\\")." ; + skos:inScheme <td> . + +td:subprotocol a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "subprotocol" ; + skos:definition "Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options." ; + skos:inScheme <td> . + +td:subscription a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "subscription" ; + skos:definition "Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks." ; + skos:inScheme <td> . + +td:success a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "success" ; + skos:definition "Signals if the additional response should not be considered an error." ; + skos:inScheme <td> . + +td:supportContact a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "supportContact" ; + skos:definition "Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]])." ; + skos:inScheme <td> . + +td:synchronous a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "synchronous" ; + skos:definition "Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made." ; + skos:inScheme <td> . + +td:type a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "type" ; + skos:inScheme <td> . + +td:version a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "version" ; + skos:inScheme <td> . + +td:writeOnly a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "writeOnly" ; + skos:definition "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false)." ; + skos:inScheme <td> . + +<https://www.w3.org/2019/wot/td#@type> a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "@type" ; + skos:inScheme <td> . + +td:InteractionAffordance a owl:Class, + linkml:ClassDefinition ; + rdfs:label "InteractionAffordance" ; + rdfs:subClassOf [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:name ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:descriptionInLanguage ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:titles ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:uriVariables ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:name ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:description ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:descriptions ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:title ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:title ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:titles ], + [ a owl:Restriction ; + owl:minCardinality 1 ; + owl:onProperty td:name ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:titleInLanguage ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:title ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:forms ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:descriptionInLanguage ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:titleInLanguage ], + [ a owl:Restriction ; + owl:allValuesFrom td:DataSchema ; + owl:onProperty td:uriVariables ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:descriptions ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:descriptionInLanguage ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:titleInLanguage ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:description ], + [ a owl:Restriction ; + owl:allValuesFrom td:Form ; + owl:onProperty td:forms ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:description ] ; + skos:definition "TOOD" ; + skos:exactMatch td:InteractionAffordance ; + skos:inScheme <td> . + +td:forms a owl:ObjectProperty, + linkml:SlotDefinition . + +td:titles a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "titles" ; + rdfs:range td:MultiLanguage ; + skos:inScheme <td> . + +td:securityDefinitions a owl:ObjectProperty, + linkml:SlotDefinition . + +td:contentType a owl:ObjectProperty, + linkml:SlotDefinition . + +td:descriptions a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "descriptions" ; + rdfs:range td:MultiLanguage ; + skos:definition "TODO, check, according to the description a description should not contain a lang tag." ; + skos:inScheme <td> . + +td:instance a owl:ObjectProperty, + linkml:SlotDefinition . + +td:target a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "target" ; + rdfs:range td:anyUri ; + skos:definition "Target IRI of a link or submission target of a Form" ; + skos:inScheme <td> . + +td:DataSchema a owl:Class, + linkml:ClassDefinition ; + rdfs:label "DataSchema" ; + rdfs:subClassOf [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:propertyName ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:writeOnly ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:readonly ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:description ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:title ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:description ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:writeOnly ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:titleInLanguage ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:propertyName ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:propertyName ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:readonly ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:descriptionInLanguage ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:title ], + [ a owl:Restriction ; + owl:allValuesFrom linkml:String ; + owl:onProperty td:writeOnly ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:readonly ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:descriptionInLanguage ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:titleInLanguage ], + [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:descriptionInLanguage ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:titleInLanguage ], + [ a owl:Restriction ; + owl:allValuesFrom td:MultiLanguage ; + owl:onProperty td:description ], + [ a owl:Restriction ; + owl:minCardinality 0 ; + owl:onProperty td:title ] ; + skos:definition "Metadata that describes the data format used. It can be used for validation." ; + skos:exactMatch jsonschema:DataSchema ; + skos:inScheme <td> . + +td:descriptionInLanguage a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "descriptionInLanguage" ; + rdfs:range td:MultiLanguage ; + skos:definition "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + skos:inScheme <td> . + +td:title a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "title" ; + rdfs:range td:MultiLanguage ; + skos:definition "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; + skos:inScheme <td> . + +td:titleInLanguage a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "titleInLanguage" ; + rdfs:range td:MultiLanguage ; + skos:definition "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + skos:inScheme <td> . + +td:anyUri a owl:Class, + linkml:TypeDefinition ; + rdfs:subClassOf [ a owl:Restriction ; + owl:onDataRange td:anyUri ; + owl:onProperty linkml:topValue ; + owl:qualifiedCardinality 1 ] . + +td:description a owl:ObjectProperty, + linkml:SlotDefinition ; + rdfs:label "description" ; + rdfs:range td:MultiLanguage ; + skos:inScheme <td> . + +td:SecuritySchemeType a owl:Class, + linkml:EnumDefinition ; + owl:unionOf ( wotsec:NoSecurityScheme wotsec:ComboSecurityScheme wotsec:BasicSecurityScheme wotsec:DigestSecurityScheme wotsec:BearerSecurityScheme wotsec:PSKSecurityScheme wotsec:OAuth2SecurityScheme wotsec:APIKeySecurityScheme wotsec:AutoSecurityScheme ) ; + linkml:permissible_values wotsec:APIKeySecurityScheme, + wotsec:AutoSecurityScheme, + wotsec:BasicSecurityScheme, + wotsec:BearerSecurityScheme, + wotsec:ComboSecurityScheme, + wotsec:DigestSecurityScheme, + wotsec:NoSecurityScheme, + wotsec:OAuth2SecurityScheme, + wotsec:PSKSecurityScheme . + +td:MultiLanguage a owl:Class, + linkml:ClassDefinition ; + rdfs:label "MultiLanguage" ; + rdfs:subClassOf [ a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty td:key ], + [ a owl:Restriction ; + owl:minCardinality 1 ; + owl:onProperty td:key ], + [ a owl:Restriction ; + owl:allValuesFrom [ a rdfs:Datatype ; + owl:onDatatype xsd:string ; + owl:withRestrictions ( [ xsd:pattern "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$" ] ) ] ; + owl:onProperty td:key ] ; + skos:inScheme <td> . + +td:OperationTypes a owl:Class, + linkml:EnumDefinition ; + owl:unionOf ( td:readProperty td:writeProperty td:observeProperty td:unobserveProperty td:invokeAction td:queryAction td:cancelAction td:subscribeEvent td:unsubscribeEvent td:readAllProperties <writeAllProperties> td:readMultipleProperties td:writeMultipleProperties td:observeAllProperties td:unobserveAllProperties td:subscribeAllEvents td:unsubscribeAllEvents td:queryAllActions ) ; + linkml:permissible_values td:cancelAction, + td:invokeAction, + td:observeAllProperties, + td:observeProperty, + td:queryAction, + td:queryAllActions, + td:readAllProperties, + td:readMultipleProperties, + td:readProperty, + td:subscribeAllEvents, + td:subscribeEvent, + td:unobserveAllProperties, + td:unobserveProperty, + td:unsubscribeAllEvents, + td:unsubscribeEvent, + td:writeMultipleProperties, + td:writeProperty, + <writeAllProperties> . + +<td> a owl:Ontology ; + rdfs:label "thing-description-schema" ; + dct:license "MIT" ; + dct:title "thing-description-schema" ; + rdfs:seeAlso <https://www.w3.org/TR/wot-thing-description11/> ; + skos:definition """LinkML schema for modelling the W3C Web of Things Thing Description information model. This schema is used to generate +JSON Schema, SHACL shapes, and RDF.""" . + diff --git a/resources/gens/protobuf/thing_description_schema.js b/resources/gens/protobuf/thing_description_schema.js new file mode 100644 index 0000000..b960c14 --- /dev/null +++ b/resources/gens/protobuf/thing_description_schema.js @@ -0,0 +1,162 @@ + syntax="proto3"; + package +// metamodel_version: 1.7.0 +// An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time). +message ActionAffordance + { + repeated multiLanguage titles = 0 + repeated multiLanguage descriptions = 0 + multiLanguage title = 0 + multiLanguage description = 0 + multiLanguage titleInLanguage = 0 + multiLanguage descriptionInLanguage = 0 + string name = 0 + repeated dataSchema uriVariables = 0 + repeated form forms = 0 + boolean safe = 0 + boolean synchronous = 0 + boolean idempotent = 0 + dataSchema input = 0 + dataSchema output = 0 + } +// Communication metadata describing the expected response message for additional responses. +message AdditionalExpectedResponse + { + string contentType = 0 + string additionalOutputSchema = 0 + boolean success = 0 + string schema = 0 + } +// Metadata that describes the data format used. It can be used for validation. +message DataSchema + { + multiLanguage description = 0 + multiLanguage title = 0 + multiLanguage titleInLanguage = 0 + multiLanguage descriptionInLanguage = 0 + string propertyName = 0 + string writeOnly = 0 + string readonly = 0 + } +// An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts). +message EventAffordance + { + repeated multiLanguage titles = 0 + repeated multiLanguage descriptions = 0 + multiLanguage title = 0 + multiLanguage description = 0 + multiLanguage titleInLanguage = 0 + multiLanguage descriptionInLanguage = 0 + string name = 0 + repeated dataSchema uriVariables = 0 + repeated form forms = 0 + dataSchema subscription = 0 + dataSchema cancellation = 0 + dataSchema notification = 0 + dataSchema notificationResponse = 0 + } +// Communication metadata describing the expected response message for the primary response. +message ExpectedResponse + { + string contentType = 0 + } +// A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions. +message Form + { + anyUri target = 0 + anyUri href = 0 + string contentType = 0 + string contentCoding = 0 + string securityDefinitions = 0 + string scopes = 0 + expectedResponse returns = 0 + repeated additionalExpectedResponse additionalReturns = 0 + string subprotocol = 0 + repeated operationTypes operationType = 0 + } +// TOOD +message InteractionAffordance + { + repeated multiLanguage titles = 0 + repeated multiLanguage descriptions = 0 + multiLanguage title = 0 + multiLanguage description = 0 + multiLanguage titleInLanguage = 0 + multiLanguage descriptionInLanguage = 0 + string name = 0 + repeated dataSchema uriVariables = 0 + repeated form forms = 0 + } +// A link can be viewed as a statement of the form link context that has a relation type resource at link target", where the optional target attributes may further describe the resource. +message Link + { + anyUri target = 0 + string hintsAtMediaType = 0 + string type = 0 + string relation = 0 + anyUri anchor = 0 + string sizes = 0 + string hreflang = 0 + } +message MultiLanguage + { + string key = 0 + } +// An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated. +message PropertyAffordance + { + repeated multiLanguage titles = 0 + repeated multiLanguage descriptions = 0 + multiLanguage title = 0 + multiLanguage description = 0 + multiLanguage titleInLanguage = 0 + multiLanguage descriptionInLanguage = 0 + string name = 0 + repeated dataSchema uriVariables = 0 + repeated form forms = 0 + boolean observable = 0 + string propertyName = 0 + string writeOnly = 0 + string readonly = 0 + } +message SecurityScheme + { + repeated string @type = 0 + repeated multiLanguage descriptions = 0 + string description = 0 + anyUri proxy = 0 + securitySchemeType scheme = 0 + } +// An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things. +message Thing + { + anyUri id = 0 + multiLanguage title = 0 + multiLanguage description = 0 + repeated multiLanguage titles = 0 + repeated multiLanguage descriptions = 0 + repeated string @type = 0 + multiLanguage titleInLanguage = 0 + multiLanguage descriptionInLanguage = 0 + repeated string securityDefinitions = 0 + repeated string security = 0 + repeated dataSchema schemaDefinitions = 0 + repeated anyUri profile = 0 + string instance = 0 + datetime created = 0 + datetime modified = 0 + anyUri supportContact = 0 + anyUri base = 0 + versionInfo version = 0 + repeated form forms = 0 + repeated link links = 0 + repeated propertyAffordance properties = 0 + repeated actionAffordance actions = 0 + repeated eventAffordance events = 0 + } +// Provides version information. +message VersionInfo + { + string instance = 0 + string model = 0 + } diff --git a/resources/gens/shacl/thing_description_schema.shacl.ttl b/resources/gens/shacl/thing_description_schema.shacl.ttl new file mode 100644 index 0000000..dcf7f0d --- /dev/null +++ b/resources/gens/shacl/thing_description_schema.shacl.ttl @@ -0,0 +1,696 @@ +@prefix hctl: <https://www.w3.org/2019/wot/hypermedia#> . +@prefix jsonschema: <https://www.w3.org/2019/wot/json-schema#> . +@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> . +@prefix schema1: <http://schema.org/> . +@prefix sh: <http://www.w3.org/ns/shacl#> . +@prefix td: <https://www.w3.org/2019/wot/td#> . +@prefix wotsec: <https://www.w3.org/2019/wot/security#> . +@prefix xsd: <http://www.w3.org/2001/XMLSchema#> . + +td:InteractionAffordance a sh:NodeShape ; + sh:closed true ; + sh:description "TOOD" ; + sh:ignoredProperties ( rdf:type ) ; + sh:property [ sh:class hctl:Form ; + sh:description "Set of form hypermedia controls that describe how an operation can be performed." ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 8 ; + sh:path td:forms ], + [ sh:class td:MultiLanguage ; + sh:description "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 4 ; + sh:path td:titleInLanguage ], + [ sh:class td:MultiLanguage ; + sh:description "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 2 ; + sh:path td:title ], + [ sh:class td:MultiLanguage ; + sh:description "TODO, check, according to the description a description should not contain a lang tag." ; + sh:nodeKind sh:IRI ; + sh:order 1 ; + sh:path td:descriptions ], + [ sh:class td:MultiLanguage ; + sh:nodeKind sh:IRI ; + sh:order 0 ; + sh:path td:titles ], + [ sh:class jsonschema:DataSchema ; + sh:description "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology." ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 7 ; + sh:path td:uriVariables ], + [ sh:class td:MultiLanguage ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 3 ; + sh:path td:description ], + [ sh:class td:MultiLanguage ; + sh:description "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 5 ; + sh:path td:descriptionInLanguage ], + [ sh:datatype xsd:string ; + sh:description "Indexing property to store entity names when serializing them in a JSON-LD @index container." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 6 ; + sh:path td:name ] ; + sh:targetClass td:InteractionAffordance . + +td:SecurityScheme a sh:NodeShape ; + sh:closed true ; + sh:ignoredProperties ( rdf:type ) ; + sh:property [ sh:class td:MultiLanguage ; + sh:description "TODO, check, according to the description a description should not contain a lang tag." ; + sh:nodeKind sh:IRI ; + sh:order 1 ; + sh:path td:descriptions ], + [ sh:datatype xsd:string ; + sh:nodeKind sh:Literal ; + sh:order 0 ; + sh:path <https://www.w3.org/2019/wot/td#@type> ], + [ sh:datatype xsd:string ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 2 ; + sh:path td:description ], + [ sh:in ( wotsec:NoSecurityScheme wotsec:ComboSecurityScheme wotsec:BasicSecurityScheme wotsec:DigestSecurityScheme wotsec:BearerSecurityScheme wotsec:PSKSecurityScheme wotsec:OAuth2SecurityScheme wotsec:APIKeySecurityScheme wotsec:AutoSecurityScheme ) ; + sh:maxCount 1 ; + sh:minCount 1 ; + sh:order 4 ; + sh:path td:scheme ], + [ sh:datatype xsd:anyURI ; + sh:description "URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 3 ; + sh:path td:proxy ] ; + sh:targetClass td:SecurityScheme . + +td:Thing a sh:NodeShape ; + sh:closed true ; + sh:description "An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things." ; + sh:ignoredProperties ( rdf:type ) ; + sh:property [ sh:datatype xsd:string ; + sh:nodeKind sh:Literal ; + sh:order 5 ; + sh:path <https://www.w3.org/2019/wot/td#@type> ], + [ sh:class td:MultiLanguage ; + sh:description "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 6 ; + sh:path td:titleInLanguage ], + [ sh:class td:ActionAffordance ; + sh:description "All Action-based interaction affordances of the Thing." ; + sh:nodeKind sh:IRI ; + sh:order 21 ; + sh:path td:actions ], + [ sh:class schema1:version ; + sh:maxCount 1 ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 17 ; + sh:path td:version ], + [ sh:datatype xsd:string ; + sh:description "A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check" ; + sh:nodeKind sh:Literal ; + sh:order 9 ; + sh:path td:security ], + [ sh:class td:MultiLanguage ; + sh:description "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 1 ; + sh:path td:title ], + [ sh:class td:MultiLanguage ; + sh:description "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 7 ; + sh:path td:descriptionInLanguage ], + [ sh:description "A security scheme applied to a (set of) affordance(s). TODO check" ; + sh:or ( [ sh:datatype xsd:string ; + sh:nodeKind sh:Literal ] [ sh:in ( wotsec:NoSecurityScheme wotsec:ComboSecurityScheme wotsec:BasicSecurityScheme wotsec:DigestSecurityScheme wotsec:BearerSecurityScheme wotsec:PSKSecurityScheme wotsec:OAuth2SecurityScheme wotsec:APIKeySecurityScheme wotsec:AutoSecurityScheme ) ] ) ; + sh:order 8 ; + sh:path td:securityDefinitions ], + [ sh:class hctl:Link ; + sh:description "Provides Web links to arbitrary resources that relate to the specified Thing Description." ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 19 ; + sh:path td:links ], + [ sh:class td:MultiLanguage ; + sh:description "TODO, check, according to the description a description should not contain a lang tag." ; + sh:nodeKind sh:IRI ; + sh:order 4 ; + sh:path td:descriptions ], + [ sh:datatype xsd:anyURI ; + sh:description "TODO" ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 0 ; + sh:path td:id ], + [ sh:class hctl:Form ; + sh:description "Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings." ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 18 ; + sh:path td:forms ], + [ sh:datatype xsd:anyURI ; + sh:description "Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]])." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 15 ; + sh:path td:supportContact ], + [ sh:datatype xsd:string ; + sh:description "Provides a version identicator of this TD instance." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 12 ; + sh:path td:instance ], + [ sh:datatype xsd:dateTime ; + sh:description "Provides information when the TD instance was created." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 13 ; + sh:path td:created ], + [ sh:class td:MultiLanguage ; + sh:nodeKind sh:IRI ; + sh:order 3 ; + sh:path td:titles ], + [ sh:class td:MultiLanguage ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 2 ; + sh:path td:description ], + [ sh:datatype xsd:anyURI ; + sh:description "Define the base URI that is used for all relative URI references throughout a TD document." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 16 ; + sh:path td:base ], + [ sh:class jsonschema:DataSchema ; + sh:description "TODO CHECK" ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 10 ; + sh:path td:schemaDefinitions ], + [ sh:class td:EventAffordance ; + sh:description "All Event-based interaction affordances of the Thing." ; + sh:nodeKind sh:IRI ; + sh:order 22 ; + sh:path td:events ], + [ sh:class td:PropertyAffordance ; + sh:description "All Property-based interaction affordances of the Thing." ; + sh:nodeKind sh:IRI ; + sh:order 20 ; + sh:path td:properties ], + [ sh:datatype xsd:anyURI ; + sh:description "Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation." ; + sh:nodeKind sh:Literal ; + sh:order 11 ; + sh:path td:profile ], + [ sh:datatype xsd:dateTime ; + sh:description "Provides information when the TD instance was last modified." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 14 ; + sh:path td:modified ] ; + sh:targetClass td:Thing . + +schema1:version a sh:NodeShape ; + sh:closed true ; + sh:description "Provides version information." ; + sh:ignoredProperties ( rdf:type ) ; + sh:property [ sh:datatype xsd:string ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 1 ; + sh:path td:model ], + [ sh:datatype xsd:string ; + sh:maxCount 1 ; + sh:minCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 0 ; + sh:path td:instance ] ; + sh:targetClass schema1:version . + +hctl:AdditionalExpectedResponse a sh:NodeShape ; + sh:closed true ; + sh:description "Communication metadata describing the expected response message for additional responses." ; + sh:ignoredProperties ( rdf:type ) ; + sh:property [ sh:datatype xsd:string ; + sh:description "TODO Check, was not in hctl ontology, if not could be source of discrepancy" ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 2 ; + sh:path td:schema ], + [ sh:datatype xsd:string ; + sh:description "This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 0 ; + sh:path td:additionalOutputSchema ], + [ sh:datatype xsd:boolean ; + sh:description "Signals if the additional response should not be considered an error." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 1 ; + sh:path td:success ], + [ sh:datatype xsd:string ; + sh:description "TODO Check, was not in hctl ontology, if not could be source of discrepancy" ; + sh:maxCount 1 ; + sh:minCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 3 ; + sh:path td:contentType ] ; + sh:targetClass hctl:AdditionalExpectedResponse . + +hctl:ExpectedResponse a sh:NodeShape ; + sh:closed true ; + sh:description "Communication metadata describing the expected response message for the primary response." ; + sh:ignoredProperties ( rdf:type ) ; + sh:property [ sh:datatype xsd:string ; + sh:description "TODO Check, was not in hctl ontology, if not could be source of discrepancy" ; + sh:maxCount 1 ; + sh:minCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 0 ; + sh:path td:contentType ] ; + sh:targetClass hctl:ExpectedResponse . + +hctl:Link a sh:NodeShape ; + sh:closed true ; + sh:description "A link can be viewed as a statement of the form link context that has a relation type resource at link target\", where the optional target attributes may further describe the resource." ; + sh:ignoredProperties ( rdf:type ) ; + sh:property [ sh:datatype xsd:anyURI ; + sh:description "Target IRI of a link or submission target of a Form" ; + sh:maxCount 1 ; + sh:minCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 0 ; + sh:path hctl:target ], + [ sh:datatype xsd:string ; + sh:description "Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \\\"16x16\\\", \\\"16x16 32x32\\\")." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 5 ; + sh:path td:sizes ], + [ sh:datatype xsd:string ; + sh:description "A link relation type identifies the semantics of a link." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 3 ; + sh:path td:relation ], + [ sh:datatype xsd:string ; + sh:description "Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 1 ; + sh:path td:hintsAtMediaType ], + [ sh:datatype xsd:string ; + sh:description "The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 6 ; + sh:path td:hreflang ; + sh:pattern "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$" ], + [ sh:datatype xsd:anyURI ; + sh:description "By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 4 ; + sh:path td:anchor ], + [ sh:datatype xsd:string ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 2 ; + sh:path td:type ] ; + sh:targetClass hctl:Link . + +td:ActionAffordance a sh:NodeShape ; + sh:closed true ; + sh:description "An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time)." ; + sh:ignoredProperties ( rdf:type ) ; + sh:property [ sh:class hctl:Form ; + sh:description "Set of form hypermedia controls that describe how an operation can be performed." ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 13 ; + sh:path td:forms ], + [ sh:class td:MultiLanguage ; + sh:description "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 7 ; + sh:path td:title ], + [ sh:datatype xsd:string ; + sh:description "Indexing property to store entity names when serializing them in a JSON-LD @index container." ; + sh:maxCount 1 ; + sh:minCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 11 ; + sh:path td:name ], + [ sh:class td:MultiLanguage ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 8 ; + sh:path td:description ], + [ sh:datatype xsd:boolean ; + sh:description "Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 0 ; + sh:path td:safe ], + [ sh:datatype xsd:boolean ; + sh:description "Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 2 ; + sh:path td:idempotent ], + [ sh:class td:MultiLanguage ; + sh:description "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 9 ; + sh:path td:titleInLanguage ], + [ sh:class td:MultiLanguage ; + sh:description "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 10 ; + sh:path td:descriptionInLanguage ], + [ sh:class jsonschema:DataSchema ; + sh:description "Used to define the output data schema of the action." ; + sh:maxCount 1 ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 4 ; + sh:path td:output ], + [ sh:class jsonschema:DataSchema ; + sh:description "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology." ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 12 ; + sh:path td:uriVariables ], + [ sh:class td:MultiLanguage ; + sh:description "TODO, check, according to the description a description should not contain a lang tag." ; + sh:nodeKind sh:IRI ; + sh:order 6 ; + sh:path td:descriptions ], + [ sh:class jsonschema:DataSchema ; + sh:description "Used to define the input data schema of the action." ; + sh:maxCount 1 ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 3 ; + sh:path td:input ], + [ sh:datatype xsd:boolean ; + sh:description "Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 1 ; + sh:path td:synchronous ], + [ sh:class td:MultiLanguage ; + sh:nodeKind sh:IRI ; + sh:order 5 ; + sh:path td:titles ] ; + sh:targetClass td:ActionAffordance . + +td:EventAffordance a sh:NodeShape ; + sh:closed true ; + sh:description "An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts)." ; + sh:ignoredProperties ( rdf:type ) ; + sh:property [ sh:class td:MultiLanguage ; + sh:nodeKind sh:IRI ; + sh:order 4 ; + sh:path td:titles ], + [ sh:class jsonschema:DataSchema ; + sh:description "Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks." ; + sh:maxCount 1 ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 0 ; + sh:path td:subscription ], + [ sh:class jsonschema:DataSchema ; + sh:description "Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook." ; + sh:maxCount 1 ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 1 ; + sh:path td:cancellation ], + [ sh:class td:MultiLanguage ; + sh:description "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 9 ; + sh:path td:descriptionInLanguage ], + [ sh:class td:MultiLanguage ; + sh:description "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 8 ; + sh:path td:titleInLanguage ], + [ sh:class td:MultiLanguage ; + sh:description "TODO, check, according to the description a description should not contain a lang tag." ; + sh:nodeKind sh:IRI ; + sh:order 5 ; + sh:path td:descriptions ], + [ sh:class jsonschema:DataSchema ; + sh:description "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology." ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 11 ; + sh:path td:uriVariables ], + [ sh:class td:MultiLanguage ; + sh:description "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 6 ; + sh:path td:title ], + [ sh:class jsonschema:DataSchema ; + sh:description "Defines the data schema of the Event response messages sent by the consumer in a response to a data message." ; + sh:maxCount 1 ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 3 ; + sh:path td:notificationResponse ], + [ sh:class td:MultiLanguage ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 7 ; + sh:path td:description ], + [ sh:class jsonschema:DataSchema ; + sh:description "Defines the data schema of the Event instance messages pushed by the Thing." ; + sh:maxCount 1 ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 2 ; + sh:path td:notification ], + [ sh:datatype xsd:string ; + sh:description "Indexing property to store entity names when serializing them in a JSON-LD @index container." ; + sh:maxCount 1 ; + sh:minCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 10 ; + sh:path td:name ], + [ sh:class hctl:Form ; + sh:description "Set of form hypermedia controls that describe how an operation can be performed." ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 12 ; + sh:path td:forms ] ; + sh:targetClass td:EventAffordance . + +td:PropertyAffordance a sh:NodeShape ; + sh:closed true ; + sh:description "An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated." ; + sh:ignoredProperties ( rdf:type ) ; + sh:property [ sh:datatype xsd:string ; + sh:description "Used to store the indexing name in the parent object when this schema appears as a property of an object schema." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 5 ; + sh:path td:propertyName ], + [ sh:class td:MultiLanguage ; + sh:description "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 3 ; + sh:path td:titleInLanguage ], + [ sh:class td:MultiLanguage ; + sh:description "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 2 ; + sh:path td:title ], + [ sh:class hctl:Form ; + sh:description "Set of form hypermedia controls that describe how an operation can be performed." ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 12 ; + sh:path td:forms ], + [ sh:datatype xsd:string ; + sh:description "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false)." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 7 ; + sh:path td:readonly ], + [ sh:class td:MultiLanguage ; + sh:description "TODO, check, according to the description a description should not contain a lang tag." ; + sh:nodeKind sh:IRI ; + sh:order 9 ; + sh:path td:descriptions ], + [ sh:datatype xsd:string ; + sh:description "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false)." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 6 ; + sh:path td:writeOnly ], + [ sh:class jsonschema:DataSchema ; + sh:description "Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology." ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 11 ; + sh:path td:uriVariables ], + [ sh:class td:MultiLanguage ; + sh:description "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 4 ; + sh:path td:descriptionInLanguage ], + [ sh:class td:MultiLanguage ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 1 ; + sh:path td:description ], + [ sh:class td:MultiLanguage ; + sh:nodeKind sh:IRI ; + sh:order 8 ; + sh:path td:titles ], + [ sh:datatype xsd:string ; + sh:description "Indexing property to store entity names when serializing them in a JSON-LD @index container." ; + sh:maxCount 1 ; + sh:minCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 10 ; + sh:path td:name ], + [ sh:datatype xsd:boolean ; + sh:description "A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 0 ; + sh:path td:observable ] ; + sh:targetClass td:PropertyAffordance . + +hctl:Form a sh:NodeShape ; + sh:closed true ; + sh:description "A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions." ; + sh:ignoredProperties ( rdf:type ) ; + sh:property [ sh:datatype xsd:string ; + sh:description "Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \\\"gzip\\\", \\\"deflate\\\", etc." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 3 ; + sh:path td:contentCoding ], + [ sh:class hctl:ExpectedResponse ; + sh:description "This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages." ; + sh:maxCount 1 ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 6 ; + sh:path td:returns ], + [ sh:datatype xsd:string ; + sh:description "TODO Check, was not in hctl ontology, if not could be source of discrepancy" ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 5 ; + sh:path td:scopes ], + [ sh:datatype xsd:anyURI ; + sh:description "Target IRI of a link or submission target of a Form" ; + sh:maxCount 1 ; + sh:minCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 0 ; + sh:path hctl:target ], + [ sh:datatype xsd:string ; + sh:description "A security schema applied to a (set of) affordance(s)." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 4 ; + sh:path td:securityDefinitions ], + [ sh:datatype xsd:string ; + sh:description "Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 2 ; + sh:path td:contentType ], + [ sh:datatype xsd:string ; + sh:description "Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 8 ; + sh:path td:subprotocol ], + [ sh:class hctl:AdditionalExpectedResponse ; + sh:description "This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema." ; + sh:nodeKind sh:BlankNodeOrIRI ; + sh:order 7 ; + sh:path td:additionalReturns ], + [ sh:description "Indicates the semantic intention of performing the operation(s) described by the form." ; + sh:in ( td:readProperty td:writeProperty td:observeProperty td:unobserveProperty td:invokeAction td:queryAction td:cancelAction td:subscribeEvent td:unsubscribeEvent td:readAllProperties <writeAllProperties> td:readMultipleProperties td:writeMultipleProperties td:observeAllProperties td:unobserveAllProperties td:subscribeAllEvents td:unsubscribeAllEvents td:queryAllActions ) ; + sh:order 9 ; + sh:path td:operationType ], + [ sh:datatype xsd:anyURI ; + sh:maxCount 1 ; + sh:minCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 1 ; + sh:path td:href ] ; + sh:targetClass hctl:Form . + +jsonschema:DataSchema a sh:NodeShape ; + sh:closed true ; + sh:description "Metadata that describes the data format used. It can be used for validation." ; + sh:ignoredProperties ( rdf:type ) ; + sh:property [ sh:class td:MultiLanguage ; + sh:description "title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 2 ; + sh:path td:titleInLanguage ], + [ sh:class td:MultiLanguage ; + sh:description "description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 3 ; + sh:path td:descriptionInLanguage ], + [ sh:datatype xsd:string ; + sh:description "Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false)." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 6 ; + sh:path td:readonly ], + [ sh:class td:MultiLanguage ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 0 ; + sh:path td:description ], + [ sh:class td:MultiLanguage ; + sh:description "Provides a human-readable title (e.g., display a text for UI representation) based on a default language." ; + sh:maxCount 1 ; + sh:nodeKind sh:IRI ; + sh:order 1 ; + sh:path td:title ], + [ sh:datatype xsd:string ; + sh:description "Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false)." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 5 ; + sh:path td:writeOnly ], + [ sh:datatype xsd:string ; + sh:description "Used to store the indexing name in the parent object when this schema appears as a property of an object schema." ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 4 ; + sh:path td:propertyName ] ; + sh:targetClass jsonschema:DataSchema . + +td:MultiLanguage a sh:NodeShape ; + sh:closed true ; + sh:ignoredProperties ( rdf:type ) ; + sh:property [ sh:datatype xsd:string ; + sh:maxCount 1 ; + sh:nodeKind sh:Literal ; + sh:order 0 ; + sh:path td:key ; + sh:pattern "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$" ] ; + sh:targetClass td:MultiLanguage . + diff --git a/resources/gens/shex/thing_description_schema.shex b/resources/gens/shex/thing_description_schema.shex new file mode 100644 index 0000000..f0e3fdc --- /dev/null +++ b/resources/gens/shex/thing_description_schema.shex @@ -0,0 +1,225 @@ +# metamodel_version: 1.7.0 +BASE <https://www.w3.org/2019/wot/td#> +PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> +PREFIX xsd: <http://www.w3.org/2001/XMLSchema#> +PREFIX linkml: <https://w3id.org/linkml/> +PREFIX jsonschema: <https://www.w3.org/2019/wot/json-schema#> +PREFIX wotsec: <https://www.w3.org/2019/wot/security#> +PREFIX hctl: <https://www.w3.org/2019/wot/hypermedia#> +PREFIX schema1: <http://schema.org/> + + +<AnyUri> IRI + +linkml:String xsd:string + +linkml:Integer xsd:integer + +linkml:Boolean xsd:boolean + +linkml:Float xsd:float + +linkml:Double xsd:double + +linkml:Decimal xsd:decimal + +linkml:Time xsd:time + +linkml:Date xsd:date + +linkml:Datetime xsd:dateTime + +linkml:DateOrDatetime linkml:DateOrDatetime + +linkml:Uriorcurie IRI + +linkml:Curie xsd:string + +linkml:Uri IRI + +linkml:Ncname xsd:string + +linkml:Objectidentifier IRI + +linkml:Nodeidentifier NONLITERAL + +linkml:Jsonpointer xsd:string + +linkml:Jsonpath xsd:string + +linkml:Sparqlpath xsd:string + +<ActionAffordance> CLOSED { + ( $<ActionAffordance_tes> ( &<InteractionAffordance_tes> ; + rdf:type [ <InteractionAffordance> ] ? ; + <safe> @linkml:Boolean ? ; + <synchronous> @linkml:Boolean ? ; + <idempotent> @linkml:Boolean ? ; + <input> @<DataSchema> ? ; + <output> @<DataSchema> ? + ) ; + rdf:type [ <ActionAffordance> ] + ) +} + +<AdditionalExpectedResponse> CLOSED { + ( $<AdditionalExpectedResponse_tes> ( &<ExpectedResponse_tes> ; + rdf:type [ hctl:ExpectedResponse ] ? ; + <additionalOutputSchema> @linkml:String ? ; + <success> @linkml:Boolean ? ; + <schema> @linkml:String ? + ) ; + rdf:type [ hctl:AdditionalExpectedResponse ] ? + ) +} + +<DataSchema> CLOSED { + ( $<DataSchema_tes> ( <description> @<MultiLanguage> ? ; + <title> @<MultiLanguage> ? ; + <titleInLanguage> @<MultiLanguage> ? ; + <descriptionInLanguage> @<MultiLanguage> ? ; + <propertyName> @linkml:String ? ; + <writeOnly> @linkml:String ? ; + <readonly> @linkml:String ? + ) ; + rdf:type [ jsonschema:DataSchema ] ? + ) +} + +<EventAffordance> CLOSED { + ( $<EventAffordance_tes> ( &<InteractionAffordance_tes> ; + rdf:type [ <InteractionAffordance> ] ? ; + <subscription> @<DataSchema> ? ; + <cancellation> @<DataSchema> ? ; + <notification> @<DataSchema> ? ; + <notificationResponse> @<DataSchema> ? + ) ; + rdf:type [ <EventAffordance> ] + ) +} + +<ExpectedResponse> ( + CLOSED { + ( $<ExpectedResponse_tes> <contentType> @linkml:String ; + rdf:type [ hctl:ExpectedResponse ] ? + ) + } OR @<AdditionalExpectedResponse> +) + +<Form> CLOSED { + ( $<Form_tes> ( hctl:target @<AnyUri> ; + <href> @<AnyUri> ; + <contentType> @linkml:String ? ; + <contentCoding> @linkml:String ? ; + <securityDefinitions> @linkml:String ? ; + <scopes> @linkml:String ? ; + <returns> @<ExpectedResponse> ? ; + <additionalReturns> @<AdditionalExpectedResponse> * ; + <subprotocol> @linkml:String ? ; + <operationType> [ <readProperty> <writeProperty> <observeProperty> <unobserveProperty> <invokeAction> <queryAction> + <cancelAction> <subscribeEvent> <unsubscribeEvent> <readAllProperties> <writeAllProperties> <readMultipleProperties> + <writeMultipleProperties> <observeAllProperties> <unobserveAllProperties> <subscribeAllEvents> <unsubscribeAllEvents> + <queryAllActions> ] * + ) ; + rdf:type [ hctl:Form ] ? + ) +} + +<InteractionAffordance> ( + CLOSED { + ( $<InteractionAffordance_tes> ( <titles> @<MultiLanguage> * ; + <descriptions> @<MultiLanguage> * ; + <title> @<MultiLanguage> ? ; + <description> @<MultiLanguage> ? ; + <titleInLanguage> @<MultiLanguage> ? ; + <descriptionInLanguage> @<MultiLanguage> ? ; + <uriVariables> @<DataSchema> * ; + <forms> @<Form> * + ) ; + rdf:type [ <InteractionAffordance> ] + ) + } OR @<ActionAffordance> OR @<EventAffordance> OR @<PropertyAffordance> +) + +<Link> CLOSED { + ( $<Link_tes> ( hctl:target @<AnyUri> ; + <hintsAtMediaType> @linkml:String ? ; + <type> @linkml:String ? ; + <relation> @linkml:String ? ; + <anchor> @<AnyUri> ? ; + <sizes> @linkml:String ? ; + <hreflang> @linkml:String ? + ) ; + rdf:type [ hctl:Link ] ? + ) +} + +<MultiLanguage> CLOSED { + ( $<MultiLanguage_tes> rdf:type . * ; + rdf:type [ <MultiLanguage> ] + ) +} + +<PropertyAffordance> CLOSED { + ( $<PropertyAffordance_tes> ( &<InteractionAffordance_tes> ; + rdf:type [ <InteractionAffordance> ] ? ; + &<DataSchema_tes> ; + rdf:type [ jsonschema:DataSchema ] ? ; + <observable> @linkml:Boolean ? ; + <propertyName> @linkml:String ? ; + <writeOnly> @linkml:String ? ; + <readonly> @linkml:String ? + ) ; + rdf:type [ <PropertyAffordance> ] + ) +} + +<SecurityScheme> CLOSED { + ( $<SecurityScheme_tes> ( <@type> @linkml:String * ; + <descriptions> @<MultiLanguage> * ; + <description> @linkml:String ? ; + <proxy> @<AnyUri> ? ; + <scheme> [ wotsec:NoSecurityScheme wotsec:ComboSecurityScheme wotsec:BasicSecurityScheme wotsec:DigestSecurityScheme + wotsec:BearerSecurityScheme wotsec:PSKSecurityScheme wotsec:OAuth2SecurityScheme wotsec:APIKeySecurityScheme + wotsec:AutoSecurityScheme ] + ) ; + rdf:type [ <SecurityScheme> ] ? + ) +} + +<Thing> CLOSED { + ( $<Thing_tes> ( <title> @<MultiLanguage> ? ; + <description> @<MultiLanguage> ? ; + <titles> @<MultiLanguage> * ; + <descriptions> @<MultiLanguage> * ; + <@type> @linkml:String * ; + <titleInLanguage> @<MultiLanguage> ? ; + <descriptionInLanguage> @<MultiLanguage> ? ; + <securityDefinitions> @linkml:String * ; + <security> @linkml:String * ; + <schemaDefinitions> @<DataSchema> * ; + <profile> @<AnyUri> * ; + <instance> @linkml:String ? ; + <created> @linkml:Datetime ? ; + <modified> @linkml:Datetime ? ; + <supportContact> @<AnyUri> ? ; + <base> @<AnyUri> ? ; + <version> @<VersionInfo> ? ; + <forms> @<Form> * ; + <links> @<Link> * ; + <properties> @<PropertyAffordance> * ; + <actions> @<ActionAffordance> * ; + <events> @<EventAffordance> * + ) ; + rdf:type [ <Thing> ] + ) +} + +<VersionInfo> CLOSED { + ( $<VersionInfo_tes> ( <instance> @linkml:String ; + <model> @linkml:String ? + ) ; + rdf:type [ schema1:version ] ? + ) +} + diff --git a/resources/gens/typescript/thing_description_schema.js b/resources/gens/typescript/thing_description_schema.js new file mode 100644 index 0000000..04b3e50 --- /dev/null +++ b/resources/gens/typescript/thing_description_schema.js @@ -0,0 +1,300 @@ +export type MultiLanguageKey = string; +export type InteractionAffordanceName = string; +export type PropertyAffordanceName = string; +export type ActionAffordanceName = string; +export type EventAffordanceName = string; +export type ThingId = string; +/** +* Enumerations of well-known operation types necessary to implement the WoT interaction model. +*/ +export enum OperationTypes { + + /** Identifies the read operation on Property Affordances to retrieve the corresponding data. */ + readproperty = "readproperty", + /** Identifies the write operation on Property Affordances to update the corresponding data. */ + writeproperty = "writeproperty", + /** Identifies the observe operation on Property Affordances to be notified with the new data when the Property is updated. */ + observeproperty = "observeproperty", + /** Identifies the unobserve operation on Property Affordances to stop the corresponding notifications. */ + unobserveproperty = "unobserveproperty", + /** Identifies the invoke operation on Action Affordances to perform the corresponding action. */ + invokeaction = "invokeaction", + /** Identifies the querying operation on Action Affordances to get the status of the corresponding action. */ + queryaction = "queryaction", + /** Identifies the cancel operation on Action Affordances to cancel the ongoing corresponding action. */ + cancelaction = "cancelaction", + /** Identifies the subscribe operation on Event Affordances to be notified by the Thing when the event occurs. */ + subscribeevent = "subscribeevent", + /** Identifies the unsubscribe operation on Event Affordances to stop the corresponding notifications. */ + unsubscribeevent = "unsubscribeevent", + /** Identifies the readallproperties operation on a Thing to retrieve the data of all Properties in a single interaction. */ + readallproperties = "readallproperties", + /** Identifies the writeallproperties operation on a Thing to update the data of all writable Properties in a single interaction. */ + writeallproperties = "writeallproperties", + /** Identifies the readmultipleproperties operation on a Thing to retrieve the data of selected Properties in a single interaction. */ + readmultipleproperties = "readmultipleproperties", + /** Identifies the writemultipleproperties operation on a Thing to update the data of selected writable Properties in a single interaction. */ + writemultipleproperties = "writemultipleproperties", + /** Identifies the observeallproperties operation on Properties to be notified with new data when any Property is updated. */ + observeallproperties = "observeallproperties", + /** Identifies the unobserveallproperties operation on Properties to stop notifications from all Properties in a single interaction. */ + unobserveallproperties = "unobserveallproperties", + /** Identifies the subscribeallevents operation on Events to subscribe to notifications from all Events in a single interaction. */ + subscribeallevents = "subscribeallevents", + /** Identifies the unsubscribeallevents operation on Events to unsubscribe from notifications from all Events in a single interaction. */ + unsubscribeallevents = "unsubscribeallevents", + /** Identifies the queryallactions operation on a Thing to get the status of all Actions in a single interaction. */ + queryallactions = "queryallactions", +}; + +export enum SecuritySchemeType { + + /** A security configuration corresponding to identified by the Vocabulary Term nosec, indicating there is no authentication or other mechanism required to access the resource. */ + nosec = "nosec", + /** Elements of this scheme define various ways in which other named schemes defined in securityDefinitions, including other ComboSecurityScheme definitions, are to be combined to create a new scheme definition. */ + combo = "combo", + /** Uses an unencrypted username and password. */ + basic = "basic", + /** This scheme is similar to basic authentication but with added features to avoid man-in-the-middle attacks. */ + digest = "digest", + /** Bearer tokens are used independently of OAuth2. */ + bearer = "bearer", + /** This is meant to identify that a standard is used for pre-shared keys such as TLS-PSK [RFC4279], and that the ciphersuite used for keys will be established during protocol negotiation. */ + psk = "psk", + /** OAuth 2.0 authentication security configuration for systems conformant with [RFC6749] and [RFC8252]. */ + oauth2 = "oauth2", + /** This scheme is to be used when the access token is opaque. */ + apikey = "apikey", + /** This scheme indicates that the security parameters are going to be negotiated by the underlying protocols at runtime */ + auto = "auto", +}; + + +/** + * Provides version information. + */ +export interface VersionInfo { + instance: string, + model?: string, +} + + + +export interface MultiLanguage { + key: string, +} + + +/** + * A link can be viewed as a statement of the form link context that has a relation type resource at link target", where the optional target attributes may further describe the resource. + */ +export interface Link { + /** Target IRI of a link or submission target of a Form */ + target: string, + /** Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be. */ + hintsAtMediaType?: string, + type?: string, + /** A link relation type identifies the semantics of a link. */ + relation?: string, + /** By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI. */ + anchor?: string, + /** Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., \"16x16\", \"16x16 32x32\"). */ + sizes?: string, + /** The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]]. */ + hreflang?: string, +} + + +/** + * Communication metadata describing the expected response message for the primary response. + */ +export interface ExpectedResponse { + /** TODO Check, was not in hctl ontology, if not could be source of discrepancy */ + contentType: string, +} + + +/** + * Communication metadata describing the expected response message for additional responses. + */ +export interface AdditionalExpectedResponse extends ExpectedResponse { + /** This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a SchemaDefinitions map must be used. */ + additionalOutputSchema?: string, + /** Signals if the additional response should not be considered an error. */ + success?: boolean, + /** TODO Check, was not in hctl ontology, if not could be source of discrepancy */ + schema?: string, +} + + +/** + * A form can be viewed as a statement of to perform an operation type on form context, make a request method to submission target, where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions. + */ +export interface Form { + /** Target IRI of a link or submission target of a Form */ + target: string, + href: string, + /** Assign a content type based on a media type IANA-MEDIA-TYPES (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type. */ + contentType?: string, + /** Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include \"gzip\", \"deflate\", etc. */ + contentCoding?: string, + /** A security schema applied to a (set of) affordance(s). */ + securityDefinitions?: string, + /** TODO Check, was not in hctl ontology, if not could be source of discrepancy */ + scopes?: string, + /** This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the response messages. */ + returns?: ExpectedResponse, + /** This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema. */ + additionalReturns?: AdditionalExpectedResponse[], + /** Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options. */ + subprotocol?: string, + /** Indicates the semantic intention of performing the operation(s) described by the form. */ + operationType?: string, +} + + + +export interface SecurityScheme { + @type?: string[], + /** TODO, check, according to the description a description should not contain a lang tag. */ + descriptions?: {[index: MultiLanguageKey]: MultiLanguage }, + description?: string, + /** URI of the proxy server this security configuration provides access to. If not given, the corresponding security configuration is for the endpoint. */ + proxy?: string, + scheme: string, +} + + +/** + * Metadata that describes the data format used. It can be used for validation. + */ +export interface DataSchema { + description?: MultiLanguageKey, + /** Provides a human-readable title (e.g., display a text for UI representation) based on a default language. */ + title?: MultiLanguageKey, + /** title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. */ + titleInLanguage?: MultiLanguageKey, + /** description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. */ + descriptionInLanguage?: MultiLanguageKey, + /** Used to store the indexing name in the parent object when this schema appears as a property of an object schema. */ + propertyName?: string, + /** Boolean value that is a hint to indicate whether a property interaction/value is write only (=true) or not (=false). */ + writeOnly?: string, + /** Boolean value that is a hint to indicate whether a property interaction/value is read only (=true) or not (=false). */ + readonly?: string, +} + + +/** + * TOOD + */ +export interface InteractionAffordance { + titles?: {[index: MultiLanguageKey]: MultiLanguage }, + /** TODO, check, according to the description a description should not contain a lang tag. */ + descriptions?: {[index: MultiLanguageKey]: MultiLanguage }, + /** Provides a human-readable title (e.g., display a text for UI representation) based on a default language. */ + title?: MultiLanguageKey, + description?: MultiLanguageKey, + /** title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. */ + titleInLanguage?: MultiLanguageKey, + /** description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. */ + descriptionInLanguage?: MultiLanguageKey, + /** Indexing property to store entity names when serializing them in a JSON-LD @index container. */ + name: string, + /** Define URI template variables according to RFC6570 as collection based on schema specifications. The individual variables DataSchema cannot be an ObjectSchema or an ArraySchema. TODO: range is not obvious from the ontology. */ + uriVariables?: DataSchema[], + /** Set of form hypermedia controls that describe how an operation can be performed. */ + forms?: Form[], +} + + +/** + * An Interaction Affordance that exposes state of the Thing. This state can be retrieved (read) and/or updated. + */ +export interface PropertyAffordance extends InteractionAffordance, DataSchema { + /** A hint that indicates whether Servients hosting the Thing and Intermediaries should probide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property. */ + observable?: boolean, +} + + +/** + * An Interaction Affordance that allows to invoke a function of the Thing, which manipulates state (e.g., toggling a lamp on or off) or triggers a process on the Thing (e.g., dim a lamp over time). + */ +export interface ActionAffordance extends InteractionAffordance { + /** Signals if the action is safe (=true) or not. Used to signal if there is no internal state (cf. resource state) is changed when invoking an Action. */ + safe?: boolean, + /** Indicates whether the action is synchronous (=true) or not. A synchronous action means that the response of action contains all the information about the result of the action and no further querying about the status of the action is needed. Lack of this keyword means that no claim on the synchronicity of the action can be made. */ + synchronous?: boolean, + /** Indicates whether the action is idempotent (=true) or not. Informs whether the action can be called repeatedly with the same results, if present, based on the same input. */ + idempotent?: boolean, + /** Used to define the input data schema of the action. */ + input?: DataSchema, + /** Used to define the output data schema of the action. */ + output?: DataSchema, +} + + +/** + * An Interaction Affordance that describes an event source, which asynchronously pushes event data to Consumers (e.g., overhearing alerts). + */ +export interface EventAffordance extends InteractionAffordance { + /** Defines data that needs to be passed upon subscription, e.g., filters or message format for setting up Webhooks. */ + subscription?: DataSchema, + /** Defines any data that needs to be passed to cancel a subscription, e.g., a specific message to remove a Webhook. */ + cancellation?: DataSchema, + /** Defines the data schema of the Event instance messages pushed by the Thing. */ + notification?: DataSchema, + /** Defines the data schema of the Event response messages sent by the consumer in a response to a data message. */ + notificationResponse?: DataSchema, +} + + +/** + * An abstraction of a physical or a virtual entity whose metadata and interfaces are described by a WoT Thing Description, whereas a virtual entity is the composition of one or more Things. + */ +export interface Thing { + /** TODO */ + id: string, + /** Provides a human-readable title (e.g., display a text for UI representation) based on a default language. */ + title?: MultiLanguageKey, + description?: MultiLanguageKey, + titles?: {[index: MultiLanguageKey]: MultiLanguage }, + /** TODO, check, according to the description a description should not contain a lang tag. */ + descriptions?: {[index: MultiLanguageKey]: MultiLanguage }, + @type?: string[], + /** title of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. */ + titleInLanguage?: MultiLanguageKey, + /** description of the TD element (Thing, interaction affordance, security scheme or data scheme) with language tag. By convention, a language tag must be added to the object of descriptionInLanguage. Otherwise use description. */ + descriptionInLanguage?: MultiLanguageKey, + /** A security scheme applied to a (set of) affordance(s). TODO check */ + securityDefinitions?: string[], + /** A Thing may define abstract security schemes, used to configure the secure access of (a set of) affordance(s). TODO: check */ + security?: string[], + /** TODO CHECK */ + schemaDefinitions?: DataSchema[], + /** Indicates the WoT Profile mechanisms followed by this Thing Description and the corresponding Thing implementation. */ + profile?: string[], + /** Provides a version identicator of this TD instance. */ + instance?: string, + /** Provides information when the TD instance was created. */ + created?: string, + /** Provides information when the TD instance was last modified. */ + modified?: string, + /** Provides information about the TD maintainer as URI scheme (e.g., <code>mailto</code> [[RFC6068]],<code>tel</code> [[RFC3966]],<code>https</code> [[RFC9112]]). */ + supportContact?: string, + /** Define the base URI that is used for all relative URI references throughout a TD document. */ + base?: string, + version?: VersionInfo, + /** Set of form hypermedia controls that describe how an operation can be performed. Forms are serializations of Protocol Bindings. */ + forms?: Form[], + /** Provides Web links to arbitrary resources that relate to the specified Thing Description. */ + links?: Link[], + /** All Property-based interaction affordances of the Thing. */ + properties?: {[index: PropertyAffordanceName]: PropertyAffordance }, + /** All Action-based interaction affordances of the Thing. */ + actions?: {[index: ActionAffordanceName]: ActionAffordance }, + /** All Event-based interaction affordances of the Thing. */ + events?: {[index: EventAffordanceName]: EventAffordance }, +} + +