basyx-typescript-sdk 0.1.10 → 0.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2789 @@
1
+ // This file is auto-generated by @hey-api/openapi-ts
2
+ export const AssetAdministrationShellSchema = {
3
+ allOf: [
4
+ {
5
+ $ref: '#/components/schemas/Identifiable',
6
+ },
7
+ {
8
+ $ref: '#/components/schemas/HasDataSpecification',
9
+ },
10
+ {
11
+ required: ['assetInformation'],
12
+ properties: {
13
+ derivedFrom: {
14
+ $ref: '#/components/schemas/Reference',
15
+ },
16
+ assetInformation: {
17
+ $ref: '#/components/schemas/AssetInformation',
18
+ },
19
+ submodels: {
20
+ minItems: 1,
21
+ type: 'array',
22
+ items: {
23
+ $ref: '#/components/schemas/Reference',
24
+ },
25
+ },
26
+ modelType: {
27
+ pattern: '^AssetAdministrationShell$',
28
+ type: 'string',
29
+ },
30
+ },
31
+ },
32
+ ],
33
+ };
34
+ export const IdentifiableSchema = {
35
+ allOf: [
36
+ {
37
+ $ref: '#/components/schemas/Referable',
38
+ },
39
+ {
40
+ required: ['id'],
41
+ properties: {
42
+ administration: {
43
+ $ref: '#/components/schemas/AdministrativeInformation',
44
+ },
45
+ id: {
46
+ maxLength: 2000,
47
+ minLength: 1,
48
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
49
+ type: 'string',
50
+ },
51
+ },
52
+ },
53
+ ],
54
+ };
55
+ export const ReferableSchema = {
56
+ allOf: [
57
+ {
58
+ $ref: '#/components/schemas/HasExtensions',
59
+ },
60
+ {
61
+ required: ['modelType'],
62
+ properties: {
63
+ category: {
64
+ maxLength: 128,
65
+ minLength: 1,
66
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
67
+ type: 'string',
68
+ },
69
+ idShort: {
70
+ type: 'string',
71
+ allOf: [
72
+ {
73
+ maxLength: 128,
74
+ minLength: 1,
75
+ },
76
+ {
77
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
78
+ },
79
+ {
80
+ pattern: '^[a-zA-Z][a-zA-Z0-9_]*$',
81
+ },
82
+ ],
83
+ },
84
+ displayName: {
85
+ minItems: 1,
86
+ type: 'array',
87
+ items: {
88
+ $ref: '#/components/schemas/LangStringNameType',
89
+ },
90
+ },
91
+ description: {
92
+ minItems: 1,
93
+ type: 'array',
94
+ items: {
95
+ $ref: '#/components/schemas/LangStringTextType',
96
+ },
97
+ },
98
+ modelType: {
99
+ $ref: '#/components/schemas/ModelType',
100
+ },
101
+ },
102
+ },
103
+ ],
104
+ };
105
+ export const HasExtensionsSchema = {
106
+ type: 'object',
107
+ properties: {
108
+ extensions: {
109
+ minItems: 1,
110
+ type: 'array',
111
+ items: {
112
+ $ref: '#/components/schemas/Extension',
113
+ },
114
+ },
115
+ },
116
+ };
117
+ export const ExtensionSchema = {
118
+ allOf: [
119
+ {
120
+ $ref: '#/components/schemas/HasSemantics',
121
+ },
122
+ {
123
+ required: ['name'],
124
+ properties: {
125
+ name: {
126
+ maxLength: 128,
127
+ minLength: 1,
128
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
129
+ type: 'string',
130
+ },
131
+ valueType: {
132
+ $ref: '#/components/schemas/DataTypeDefXsd',
133
+ },
134
+ value: {
135
+ type: 'string',
136
+ },
137
+ refersTo: {
138
+ minItems: 1,
139
+ type: 'array',
140
+ items: {
141
+ $ref: '#/components/schemas/Reference',
142
+ },
143
+ },
144
+ },
145
+ },
146
+ ],
147
+ };
148
+ export const HasSemanticsSchema = {
149
+ type: 'object',
150
+ properties: {
151
+ semanticId: {
152
+ $ref: '#/components/schemas/Reference',
153
+ },
154
+ supplementalSemanticIds: {
155
+ minItems: 1,
156
+ type: 'array',
157
+ items: {
158
+ $ref: '#/components/schemas/Reference',
159
+ },
160
+ },
161
+ },
162
+ };
163
+ export const ReferenceSchema = {
164
+ allOf: [
165
+ {
166
+ $ref: '#/components/schemas/ReferenceParent',
167
+ },
168
+ {
169
+ properties: {
170
+ referredSemanticId: {
171
+ $ref: '#/components/schemas/ReferenceParent',
172
+ },
173
+ },
174
+ },
175
+ ],
176
+ };
177
+ export const ReferenceParentSchema = {
178
+ required: ['keys', 'type'],
179
+ type: 'object',
180
+ properties: {
181
+ type: {
182
+ $ref: '#/components/schemas/ReferenceTypes',
183
+ },
184
+ keys: {
185
+ minItems: 1,
186
+ type: 'array',
187
+ items: {
188
+ $ref: '#/components/schemas/Key',
189
+ },
190
+ },
191
+ },
192
+ };
193
+ export const ReferenceTypesSchema = {
194
+ type: 'string',
195
+ enum: ['ExternalReference', 'ModelReference'],
196
+ };
197
+ export const KeySchema = {
198
+ required: ['type', 'value'],
199
+ type: 'object',
200
+ properties: {
201
+ type: {
202
+ $ref: '#/components/schemas/KeyTypes',
203
+ },
204
+ value: {
205
+ maxLength: 2000,
206
+ minLength: 1,
207
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
208
+ type: 'string',
209
+ },
210
+ },
211
+ };
212
+ export const KeyTypesSchema = {
213
+ type: 'string',
214
+ enum: [
215
+ 'AnnotatedRelationshipElement',
216
+ 'AssetAdministrationShell',
217
+ 'BasicEventElement',
218
+ 'Blob',
219
+ 'Capability',
220
+ 'ConceptDescription',
221
+ 'DataElement',
222
+ 'Entity',
223
+ 'EventElement',
224
+ 'File',
225
+ 'FragmentReference',
226
+ 'GlobalReference',
227
+ 'Identifiable',
228
+ 'MultiLanguageProperty',
229
+ 'Operation',
230
+ 'Property',
231
+ 'Range',
232
+ 'Referable',
233
+ 'ReferenceElement',
234
+ 'RelationshipElement',
235
+ 'Submodel',
236
+ 'SubmodelElement',
237
+ 'SubmodelElementCollection',
238
+ 'SubmodelElementList',
239
+ ],
240
+ };
241
+ export const DataTypeDefXsdSchema = {
242
+ type: 'string',
243
+ enum: [
244
+ 'xs:anyURI',
245
+ 'xs:base64Binary',
246
+ 'xs:boolean',
247
+ 'xs:byte',
248
+ 'xs:date',
249
+ 'xs:dateTime',
250
+ 'xs:decimal',
251
+ 'xs:double',
252
+ 'xs:duration',
253
+ 'xs:float',
254
+ 'xs:gDay',
255
+ 'xs:gMonth',
256
+ 'xs:gMonthDay',
257
+ 'xs:gYear',
258
+ 'xs:gYearMonth',
259
+ 'xs:hexBinary',
260
+ 'xs:int',
261
+ 'xs:integer',
262
+ 'xs:long',
263
+ 'xs:negativeInteger',
264
+ 'xs:nonNegativeInteger',
265
+ 'xs:nonPositiveInteger',
266
+ 'xs:positiveInteger',
267
+ 'xs:short',
268
+ 'xs:string',
269
+ 'xs:time',
270
+ 'xs:unsignedByte',
271
+ 'xs:unsignedInt',
272
+ 'xs:unsignedLong',
273
+ 'xs:unsignedShort',
274
+ ],
275
+ };
276
+ export const LangStringNameTypeSchema = {
277
+ allOf: [
278
+ {
279
+ $ref: '#/components/schemas/AbstractLangString',
280
+ },
281
+ {
282
+ properties: {
283
+ text: {
284
+ maxLength: 128,
285
+ },
286
+ },
287
+ },
288
+ ],
289
+ };
290
+ export const AbstractLangStringSchema = {
291
+ required: ['language', 'text'],
292
+ type: 'object',
293
+ properties: {
294
+ language: {
295
+ 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})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([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)))$',
296
+ type: 'string',
297
+ },
298
+ text: {
299
+ minLength: 1,
300
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
301
+ type: 'string',
302
+ },
303
+ },
304
+ };
305
+ export const LangStringTextTypeSchema = {
306
+ allOf: [
307
+ {
308
+ $ref: '#/components/schemas/AbstractLangString',
309
+ },
310
+ {
311
+ properties: {
312
+ text: {
313
+ maxLength: 1023,
314
+ },
315
+ },
316
+ },
317
+ ],
318
+ };
319
+ export const ModelTypeSchema = {
320
+ type: 'string',
321
+ enum: [
322
+ 'AnnotatedRelationshipElement',
323
+ 'AssetAdministrationShell',
324
+ 'BasicEventElement',
325
+ 'Blob',
326
+ 'Capability',
327
+ 'ConceptDescription',
328
+ 'DataSpecificationIec61360',
329
+ 'Entity',
330
+ 'File',
331
+ 'MultiLanguageProperty',
332
+ 'Operation',
333
+ 'Property',
334
+ 'Range',
335
+ 'ReferenceElement',
336
+ 'RelationshipElement',
337
+ 'Submodel',
338
+ 'SubmodelElementCollection',
339
+ 'SubmodelElementList',
340
+ ],
341
+ };
342
+ export const AdministrativeInformationSchema = {
343
+ allOf: [
344
+ {
345
+ $ref: '#/components/schemas/HasDataSpecification',
346
+ },
347
+ {
348
+ properties: {
349
+ version: {
350
+ type: 'string',
351
+ allOf: [
352
+ {
353
+ maxLength: 4,
354
+ minLength: 1,
355
+ },
356
+ {
357
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
358
+ },
359
+ {
360
+ pattern: '^(0|[1-9][0-9]*)$',
361
+ },
362
+ ],
363
+ },
364
+ revision: {
365
+ type: 'string',
366
+ allOf: [
367
+ {
368
+ maxLength: 4,
369
+ minLength: 1,
370
+ },
371
+ {
372
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
373
+ },
374
+ {
375
+ pattern: '^(0|[1-9][0-9]*)$',
376
+ },
377
+ ],
378
+ },
379
+ creator: {
380
+ $ref: '#/components/schemas/Reference',
381
+ },
382
+ templateId: {
383
+ maxLength: 2000,
384
+ minLength: 1,
385
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
386
+ type: 'string',
387
+ },
388
+ },
389
+ },
390
+ ],
391
+ };
392
+ export const HasDataSpecificationSchema = {
393
+ type: 'object',
394
+ properties: {
395
+ embeddedDataSpecifications: {
396
+ minItems: 1,
397
+ type: 'array',
398
+ items: {
399
+ $ref: '#/components/schemas/EmbeddedDataSpecification',
400
+ },
401
+ },
402
+ },
403
+ };
404
+ export const EmbeddedDataSpecificationSchema = {
405
+ required: ['dataSpecification', 'dataSpecificationContent'],
406
+ type: 'object',
407
+ properties: {
408
+ dataSpecificationContent: {
409
+ $ref: '#/components/schemas/DataSpecificationContent_choice',
410
+ },
411
+ dataSpecification: {
412
+ $ref: '#/components/schemas/Reference',
413
+ },
414
+ },
415
+ };
416
+ export const DataSpecificationContent_choiceSchema = {
417
+ oneOf: [
418
+ {
419
+ $ref: '#/components/schemas/DataSpecificationIec61360',
420
+ },
421
+ ],
422
+ };
423
+ export const DataSpecificationIec61360Schema = {
424
+ allOf: [
425
+ {
426
+ $ref: '#/components/schemas/DataSpecificationContent',
427
+ },
428
+ {
429
+ required: ['preferredName'],
430
+ properties: {
431
+ preferredName: {
432
+ minItems: 1,
433
+ type: 'array',
434
+ items: {
435
+ $ref: '#/components/schemas/LangStringPreferredNameTypeIec61360',
436
+ },
437
+ },
438
+ shortName: {
439
+ minItems: 1,
440
+ type: 'array',
441
+ items: {
442
+ $ref: '#/components/schemas/LangStringShortNameTypeIec61360',
443
+ },
444
+ },
445
+ unit: {
446
+ minLength: 1,
447
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
448
+ type: 'string',
449
+ },
450
+ unitId: {
451
+ $ref: '#/components/schemas/Reference',
452
+ },
453
+ sourceOfDefinition: {
454
+ minLength: 1,
455
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
456
+ type: 'string',
457
+ },
458
+ symbol: {
459
+ minLength: 1,
460
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
461
+ type: 'string',
462
+ },
463
+ dataType: {
464
+ $ref: '#/components/schemas/DataTypeIec61360',
465
+ },
466
+ definition: {
467
+ minItems: 1,
468
+ type: 'array',
469
+ items: {
470
+ $ref: '#/components/schemas/LangStringDefinitionTypeIec61360',
471
+ },
472
+ },
473
+ valueFormat: {
474
+ minLength: 1,
475
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
476
+ type: 'string',
477
+ },
478
+ valueList: {
479
+ $ref: '#/components/schemas/ValueList',
480
+ },
481
+ value: {
482
+ maxLength: 2000,
483
+ minLength: 1,
484
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
485
+ type: 'string',
486
+ },
487
+ levelType: {
488
+ $ref: '#/components/schemas/LevelType',
489
+ },
490
+ modelType: {
491
+ pattern: '^DataSpecificationIec61360$',
492
+ type: 'string',
493
+ },
494
+ },
495
+ },
496
+ ],
497
+ };
498
+ export const DataSpecificationContentSchema = {
499
+ required: ['modelType'],
500
+ type: 'object',
501
+ properties: {
502
+ modelType: {
503
+ $ref: '#/components/schemas/ModelType',
504
+ },
505
+ },
506
+ };
507
+ export const LangStringPreferredNameTypeIec61360Schema = {
508
+ allOf: [
509
+ {
510
+ $ref: '#/components/schemas/AbstractLangString',
511
+ },
512
+ {
513
+ properties: {
514
+ text: {
515
+ maxLength: 255,
516
+ },
517
+ },
518
+ },
519
+ ],
520
+ };
521
+ export const LangStringShortNameTypeIec61360Schema = {
522
+ allOf: [
523
+ {
524
+ $ref: '#/components/schemas/AbstractLangString',
525
+ },
526
+ {
527
+ properties: {
528
+ text: {
529
+ maxLength: 18,
530
+ },
531
+ },
532
+ },
533
+ ],
534
+ };
535
+ export const DataTypeIec61360Schema = {
536
+ type: 'string',
537
+ enum: [
538
+ 'BLOB',
539
+ 'BOOLEAN',
540
+ 'DATE',
541
+ 'FILE',
542
+ 'HTML',
543
+ 'INTEGER_COUNT',
544
+ 'INTEGER_CURRENCY',
545
+ 'INTEGER_MEASURE',
546
+ 'IRDI',
547
+ 'IRI',
548
+ 'RATIONAL',
549
+ 'RATIONAL_MEASURE',
550
+ 'REAL_COUNT',
551
+ 'REAL_CURRENCY',
552
+ 'REAL_MEASURE',
553
+ 'STRING',
554
+ 'STRING_TRANSLATABLE',
555
+ 'TIME',
556
+ 'TIMESTAMP',
557
+ ],
558
+ };
559
+ export const LangStringDefinitionTypeIec61360Schema = {
560
+ allOf: [
561
+ {
562
+ $ref: '#/components/schemas/AbstractLangString',
563
+ },
564
+ {
565
+ properties: {
566
+ text: {
567
+ maxLength: 1023,
568
+ },
569
+ },
570
+ },
571
+ ],
572
+ };
573
+ export const ValueListSchema = {
574
+ required: ['valueReferencePairs'],
575
+ type: 'object',
576
+ properties: {
577
+ valueReferencePairs: {
578
+ minItems: 1,
579
+ type: 'array',
580
+ items: {
581
+ $ref: '#/components/schemas/ValueReferencePair',
582
+ },
583
+ },
584
+ },
585
+ };
586
+ export const ValueReferencePairSchema = {
587
+ required: ['value', 'valueId'],
588
+ type: 'object',
589
+ properties: {
590
+ value: {
591
+ maxLength: 2000,
592
+ minLength: 1,
593
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
594
+ type: 'string',
595
+ },
596
+ valueId: {
597
+ $ref: '#/components/schemas/Reference',
598
+ },
599
+ },
600
+ };
601
+ export const LevelTypeSchema = {
602
+ required: ['max', 'min', 'nom', 'typ'],
603
+ type: 'object',
604
+ properties: {
605
+ min: {
606
+ type: 'boolean',
607
+ },
608
+ nom: {
609
+ type: 'boolean',
610
+ },
611
+ typ: {
612
+ type: 'boolean',
613
+ },
614
+ max: {
615
+ type: 'boolean',
616
+ },
617
+ },
618
+ };
619
+ export const AssetInformationSchema = {
620
+ required: ['assetKind'],
621
+ type: 'object',
622
+ properties: {
623
+ assetKind: {
624
+ $ref: '#/components/schemas/AssetKind',
625
+ },
626
+ globalAssetId: {
627
+ maxLength: 2000,
628
+ minLength: 1,
629
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
630
+ type: 'string',
631
+ },
632
+ specificAssetIds: {
633
+ minItems: 1,
634
+ type: 'array',
635
+ items: {
636
+ $ref: '#/components/schemas/SpecificAssetId',
637
+ },
638
+ },
639
+ assetType: {
640
+ maxLength: 2000,
641
+ minLength: 1,
642
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
643
+ type: 'string',
644
+ },
645
+ defaultThumbnail: {
646
+ $ref: '#/components/schemas/Resource',
647
+ },
648
+ },
649
+ };
650
+ export const AssetKindSchema = {
651
+ type: 'string',
652
+ enum: ['Instance', 'NotApplicable', 'Type'],
653
+ };
654
+ export const SpecificAssetIdSchema = {
655
+ allOf: [
656
+ {
657
+ $ref: '#/components/schemas/HasSemantics',
658
+ },
659
+ {
660
+ required: ['name', 'value'],
661
+ properties: {
662
+ name: {
663
+ maxLength: 64,
664
+ minLength: 1,
665
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
666
+ type: 'string',
667
+ },
668
+ value: {
669
+ maxLength: 2000,
670
+ minLength: 1,
671
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
672
+ type: 'string',
673
+ },
674
+ externalSubjectId: {
675
+ $ref: '#/components/schemas/Reference',
676
+ },
677
+ },
678
+ },
679
+ ],
680
+ };
681
+ export const ResourceSchema = {
682
+ required: ['path'],
683
+ type: 'object',
684
+ properties: {
685
+ path: {
686
+ maxLength: 2000,
687
+ minLength: 1,
688
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
689
+ type: 'string',
690
+ },
691
+ contentType: {
692
+ type: 'string',
693
+ allOf: [
694
+ {
695
+ maxLength: 100,
696
+ minLength: 1,
697
+ },
698
+ {
699
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
700
+ },
701
+ {
702
+ pattern: `^([!#$%&'*+\-.^_\`|~0-9a-zA-Z])+/([!#$%&'*+\-.^_\`|~0-9a-zA-Z])+([ \t]*;[ \t]*([!#$%&'*+\-.^_\`|~0-9a-zA-Z])+=(([!#$%&'*+\-.^_\`|~0-9a-zA-Z])+|"(([\t !#-\[\]-~]|[-ÿ])|\\([\t !-~]|[-ÿ]))*"))*$`,
703
+ },
704
+ ],
705
+ },
706
+ },
707
+ };
708
+ export const ResultSchema = {
709
+ type: 'object',
710
+ properties: {
711
+ messages: {
712
+ type: 'array',
713
+ items: {
714
+ $ref: '#/components/schemas/Message',
715
+ },
716
+ },
717
+ },
718
+ };
719
+ export const MessageSchema = {
720
+ type: 'object',
721
+ properties: {
722
+ code: {
723
+ maxLength: 32,
724
+ minLength: 1,
725
+ type: 'string',
726
+ },
727
+ correlationId: {
728
+ maxLength: 128,
729
+ minLength: 1,
730
+ type: 'string',
731
+ },
732
+ messageType: {
733
+ type: 'string',
734
+ enum: ['Undefined', 'Info', 'Warning', 'Error', 'Exception'],
735
+ },
736
+ text: {
737
+ type: 'string',
738
+ },
739
+ timestamp: {
740
+ pattern: '^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\\.[0-9]+)?)|24:00:00(\\.0+)?)(Z|\\+00:00|-00:00)$',
741
+ type: 'string',
742
+ },
743
+ },
744
+ };
745
+ export const GetReferencesResultSchema = {
746
+ allOf: [
747
+ {
748
+ $ref: '#/components/schemas/PagedResult',
749
+ },
750
+ {
751
+ type: 'object',
752
+ properties: {
753
+ result: {
754
+ type: 'array',
755
+ items: {
756
+ $ref: '#/components/schemas/Reference',
757
+ },
758
+ },
759
+ },
760
+ },
761
+ ],
762
+ };
763
+ export const PagedResultSchema = {
764
+ type: 'object',
765
+ properties: {
766
+ paging_metadata: {
767
+ $ref: '#/components/schemas/PagedResult_paging_metadata',
768
+ },
769
+ },
770
+ };
771
+ export const SubmodelSchema = {
772
+ allOf: [
773
+ {
774
+ $ref: '#/components/schemas/Identifiable',
775
+ },
776
+ {
777
+ $ref: '#/components/schemas/HasKind',
778
+ },
779
+ {
780
+ $ref: '#/components/schemas/HasSemantics',
781
+ },
782
+ {
783
+ $ref: '#/components/schemas/Qualifiable',
784
+ },
785
+ {
786
+ $ref: '#/components/schemas/HasDataSpecification',
787
+ },
788
+ {
789
+ properties: {
790
+ submodelElements: {
791
+ minItems: 1,
792
+ type: 'array',
793
+ items: {
794
+ $ref: '#/components/schemas/SubmodelElement_choice',
795
+ },
796
+ },
797
+ modelType: {
798
+ pattern: '^Submodel$',
799
+ type: 'string',
800
+ },
801
+ },
802
+ },
803
+ ],
804
+ };
805
+ export const HasKindSchema = {
806
+ type: 'object',
807
+ properties: {
808
+ kind: {
809
+ $ref: '#/components/schemas/ModellingKind',
810
+ },
811
+ },
812
+ };
813
+ export const ModellingKindSchema = {
814
+ type: 'string',
815
+ enum: ['Instance', 'Template'],
816
+ };
817
+ export const QualifiableSchema = {
818
+ required: ['modelType'],
819
+ type: 'object',
820
+ properties: {
821
+ qualifiers: {
822
+ minItems: 1,
823
+ type: 'array',
824
+ items: {
825
+ $ref: '#/components/schemas/Qualifier',
826
+ },
827
+ },
828
+ modelType: {
829
+ $ref: '#/components/schemas/ModelType',
830
+ },
831
+ },
832
+ };
833
+ export const QualifierSchema = {
834
+ allOf: [
835
+ {
836
+ $ref: '#/components/schemas/HasSemantics',
837
+ },
838
+ {
839
+ required: ['type', 'valueType'],
840
+ properties: {
841
+ kind: {
842
+ $ref: '#/components/schemas/QualifierKind',
843
+ },
844
+ type: {
845
+ maxLength: 128,
846
+ minLength: 1,
847
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
848
+ type: 'string',
849
+ },
850
+ valueType: {
851
+ $ref: '#/components/schemas/DataTypeDefXsd',
852
+ },
853
+ value: {
854
+ type: 'string',
855
+ },
856
+ valueId: {
857
+ $ref: '#/components/schemas/Reference',
858
+ },
859
+ },
860
+ },
861
+ ],
862
+ };
863
+ export const QualifierKindSchema = {
864
+ type: 'string',
865
+ enum: ['ConceptQualifier', 'TemplateQualifier', 'ValueQualifier'],
866
+ };
867
+ export const SubmodelElement_choiceSchema = {
868
+ oneOf: [
869
+ {
870
+ $ref: '#/components/schemas/RelationshipElement',
871
+ },
872
+ {
873
+ $ref: '#/components/schemas/AnnotatedRelationshipElement',
874
+ },
875
+ {
876
+ $ref: '#/components/schemas/BasicEventElement',
877
+ },
878
+ {
879
+ $ref: '#/components/schemas/Blob',
880
+ },
881
+ {
882
+ $ref: '#/components/schemas/Capability',
883
+ },
884
+ {
885
+ $ref: '#/components/schemas/Entity',
886
+ },
887
+ {
888
+ $ref: '#/components/schemas/File',
889
+ },
890
+ {
891
+ $ref: '#/components/schemas/MultiLanguageProperty',
892
+ },
893
+ {
894
+ $ref: '#/components/schemas/Operation',
895
+ },
896
+ {
897
+ $ref: '#/components/schemas/Property',
898
+ },
899
+ {
900
+ $ref: '#/components/schemas/Range',
901
+ },
902
+ {
903
+ $ref: '#/components/schemas/ReferenceElement',
904
+ },
905
+ {
906
+ $ref: '#/components/schemas/SubmodelElementCollection',
907
+ },
908
+ {
909
+ $ref: '#/components/schemas/SubmodelElementList',
910
+ },
911
+ ],
912
+ };
913
+ export const RelationshipElementSchema = {
914
+ allOf: [
915
+ {
916
+ $ref: '#/components/schemas/RelationshipElement_abstract',
917
+ },
918
+ {
919
+ properties: {
920
+ modelType: {
921
+ pattern: '^RelationshipElement$',
922
+ type: 'string',
923
+ },
924
+ },
925
+ },
926
+ ],
927
+ };
928
+ export const RelationshipElement_abstractSchema = {
929
+ allOf: [
930
+ {
931
+ $ref: '#/components/schemas/SubmodelElement',
932
+ },
933
+ {
934
+ required: ['first', 'second'],
935
+ properties: {
936
+ first: {
937
+ $ref: '#/components/schemas/Reference',
938
+ },
939
+ second: {
940
+ $ref: '#/components/schemas/Reference',
941
+ },
942
+ },
943
+ },
944
+ ],
945
+ };
946
+ export const SubmodelElementSchema = {
947
+ allOf: [
948
+ {
949
+ $ref: '#/components/schemas/Referable',
950
+ },
951
+ {
952
+ $ref: '#/components/schemas/HasSemantics',
953
+ },
954
+ {
955
+ $ref: '#/components/schemas/Qualifiable',
956
+ },
957
+ {
958
+ $ref: '#/components/schemas/HasDataSpecification',
959
+ },
960
+ ],
961
+ };
962
+ export const AnnotatedRelationshipElementSchema = {
963
+ allOf: [
964
+ {
965
+ $ref: '#/components/schemas/RelationshipElement_abstract',
966
+ },
967
+ {
968
+ properties: {
969
+ annotations: {
970
+ minItems: 1,
971
+ type: 'array',
972
+ items: {
973
+ $ref: '#/components/schemas/DataElement_choice',
974
+ },
975
+ },
976
+ modelType: {
977
+ pattern: '^AnnotatedRelationshipElement$',
978
+ type: 'string',
979
+ },
980
+ },
981
+ },
982
+ ],
983
+ };
984
+ export const DataElement_choiceSchema = {
985
+ oneOf: [
986
+ {
987
+ $ref: '#/components/schemas/Blob',
988
+ },
989
+ {
990
+ $ref: '#/components/schemas/File',
991
+ },
992
+ {
993
+ $ref: '#/components/schemas/MultiLanguageProperty',
994
+ },
995
+ {
996
+ $ref: '#/components/schemas/Property',
997
+ },
998
+ {
999
+ $ref: '#/components/schemas/Range',
1000
+ },
1001
+ {
1002
+ $ref: '#/components/schemas/ReferenceElement',
1003
+ },
1004
+ ],
1005
+ };
1006
+ export const BlobSchema = {
1007
+ allOf: [
1008
+ {
1009
+ $ref: '#/components/schemas/DataElement',
1010
+ },
1011
+ {
1012
+ required: ['contentType'],
1013
+ properties: {
1014
+ value: {
1015
+ type: 'string',
1016
+ format: 'byte',
1017
+ },
1018
+ contentType: {
1019
+ type: 'string',
1020
+ allOf: [
1021
+ {
1022
+ maxLength: 100,
1023
+ minLength: 1,
1024
+ },
1025
+ {
1026
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
1027
+ },
1028
+ {
1029
+ pattern: `^([!#$%&'*+\-.^_\`|~0-9a-zA-Z])+/([!#$%&'*+\-.^_\`|~0-9a-zA-Z])+([ \t]*;[ \t]*([!#$%&'*+\-.^_\`|~0-9a-zA-Z])+=(([!#$%&'*+\-.^_\`|~0-9a-zA-Z])+|"(([\t !#-\[\]-~]|[-ÿ])|\\([\t !-~]|[-ÿ]))*"))*$`,
1030
+ },
1031
+ ],
1032
+ },
1033
+ modelType: {
1034
+ pattern: '^Blob$',
1035
+ type: 'string',
1036
+ },
1037
+ },
1038
+ },
1039
+ ],
1040
+ };
1041
+ export const DataElementSchema = {
1042
+ allOf: [
1043
+ {
1044
+ $ref: '#/components/schemas/Referable',
1045
+ },
1046
+ {
1047
+ $ref: '#/components/schemas/HasSemantics',
1048
+ },
1049
+ {
1050
+ $ref: '#/components/schemas/Qualifiable',
1051
+ },
1052
+ {
1053
+ $ref: '#/components/schemas/HasDataSpecification',
1054
+ },
1055
+ ],
1056
+ };
1057
+ export const FileSchema = {
1058
+ allOf: [
1059
+ {
1060
+ $ref: '#/components/schemas/DataElement',
1061
+ },
1062
+ {
1063
+ required: ['contentType'],
1064
+ properties: {
1065
+ value: {
1066
+ maxLength: 2000,
1067
+ minLength: 1,
1068
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
1069
+ type: 'string',
1070
+ },
1071
+ contentType: {
1072
+ type: 'string',
1073
+ allOf: [
1074
+ {
1075
+ maxLength: 100,
1076
+ minLength: 1,
1077
+ },
1078
+ {
1079
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
1080
+ },
1081
+ {
1082
+ pattern: `^([!#$%&'*+\-.^_\`|~0-9a-zA-Z])+/([!#$%&'*+\-.^_\`|~0-9a-zA-Z])+([ \t]*;[ \t]*([!#$%&'*+\-.^_\`|~0-9a-zA-Z])+=(([!#$%&'*+\-.^_\`|~0-9a-zA-Z])+|"(([\t !#-\[\]-~]|[-ÿ])|\\([\t !-~]|[-ÿ]))*"))*$`,
1083
+ },
1084
+ ],
1085
+ },
1086
+ modelType: {
1087
+ pattern: '^File$',
1088
+ type: 'string',
1089
+ },
1090
+ },
1091
+ },
1092
+ ],
1093
+ };
1094
+ export const MultiLanguagePropertySchema = {
1095
+ allOf: [
1096
+ {
1097
+ $ref: '#/components/schemas/DataElement',
1098
+ },
1099
+ {
1100
+ properties: {
1101
+ value: {
1102
+ minItems: 1,
1103
+ type: 'array',
1104
+ items: {
1105
+ $ref: '#/components/schemas/LangStringTextType',
1106
+ },
1107
+ },
1108
+ valueId: {
1109
+ $ref: '#/components/schemas/Reference',
1110
+ },
1111
+ modelType: {
1112
+ pattern: '^MultiLanguageProperty$',
1113
+ type: 'string',
1114
+ },
1115
+ },
1116
+ },
1117
+ ],
1118
+ };
1119
+ export const PropertySchema = {
1120
+ allOf: [
1121
+ {
1122
+ $ref: '#/components/schemas/DataElement',
1123
+ },
1124
+ {
1125
+ required: ['valueType'],
1126
+ properties: {
1127
+ valueType: {
1128
+ $ref: '#/components/schemas/DataTypeDefXsd',
1129
+ },
1130
+ value: {
1131
+ type: 'string',
1132
+ },
1133
+ valueId: {
1134
+ $ref: '#/components/schemas/Reference',
1135
+ },
1136
+ modelType: {
1137
+ pattern: '^Property$',
1138
+ type: 'string',
1139
+ },
1140
+ },
1141
+ },
1142
+ ],
1143
+ };
1144
+ export const RangeSchema = {
1145
+ allOf: [
1146
+ {
1147
+ $ref: '#/components/schemas/DataElement',
1148
+ },
1149
+ {
1150
+ required: ['valueType'],
1151
+ properties: {
1152
+ valueType: {
1153
+ $ref: '#/components/schemas/DataTypeDefXsd',
1154
+ },
1155
+ min: {
1156
+ type: 'string',
1157
+ },
1158
+ max: {
1159
+ type: 'string',
1160
+ },
1161
+ modelType: {
1162
+ pattern: '^Range$',
1163
+ type: 'string',
1164
+ },
1165
+ },
1166
+ },
1167
+ ],
1168
+ };
1169
+ export const ReferenceElementSchema = {
1170
+ allOf: [
1171
+ {
1172
+ $ref: '#/components/schemas/DataElement',
1173
+ },
1174
+ {
1175
+ properties: {
1176
+ value: {
1177
+ $ref: '#/components/schemas/Reference',
1178
+ },
1179
+ modelType: {
1180
+ pattern: '^ReferenceElement$',
1181
+ type: 'string',
1182
+ },
1183
+ },
1184
+ },
1185
+ ],
1186
+ };
1187
+ export const BasicEventElementSchema = {
1188
+ allOf: [
1189
+ {
1190
+ $ref: '#/components/schemas/EventElement',
1191
+ },
1192
+ {
1193
+ required: ['direction', 'observed', 'state'],
1194
+ properties: {
1195
+ observed: {
1196
+ $ref: '#/components/schemas/Reference',
1197
+ },
1198
+ direction: {
1199
+ $ref: '#/components/schemas/Direction',
1200
+ },
1201
+ state: {
1202
+ $ref: '#/components/schemas/StateOfEvent',
1203
+ },
1204
+ messageTopic: {
1205
+ maxLength: 255,
1206
+ minLength: 1,
1207
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
1208
+ type: 'string',
1209
+ },
1210
+ messageBroker: {
1211
+ $ref: '#/components/schemas/Reference',
1212
+ },
1213
+ lastUpdate: {
1214
+ pattern: '^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\\.[0-9]+)?)|24:00:00(\\.0+)?)(Z|\\+00:00|-00:00)$',
1215
+ type: 'string',
1216
+ },
1217
+ minInterval: {
1218
+ pattern: '^-?P((([0-9]+Y([0-9]+M)?([0-9]+D)?|([0-9]+M)([0-9]+D)?|([0-9]+D))(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S)))?)|(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S))))$',
1219
+ type: 'string',
1220
+ },
1221
+ maxInterval: {
1222
+ pattern: '^-?P((([0-9]+Y([0-9]+M)?([0-9]+D)?|([0-9]+M)([0-9]+D)?|([0-9]+D))(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S)))?)|(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S))))$',
1223
+ type: 'string',
1224
+ },
1225
+ modelType: {
1226
+ pattern: '^BasicEventElement$',
1227
+ type: 'string',
1228
+ },
1229
+ },
1230
+ },
1231
+ ],
1232
+ };
1233
+ export const EventElementSchema = {
1234
+ allOf: [
1235
+ {
1236
+ $ref: '#/components/schemas/Referable',
1237
+ },
1238
+ {
1239
+ $ref: '#/components/schemas/HasSemantics',
1240
+ },
1241
+ {
1242
+ $ref: '#/components/schemas/Qualifiable',
1243
+ },
1244
+ {
1245
+ $ref: '#/components/schemas/HasDataSpecification',
1246
+ },
1247
+ ],
1248
+ };
1249
+ export const DirectionSchema = {
1250
+ type: 'string',
1251
+ enum: ['input', 'output'],
1252
+ };
1253
+ export const StateOfEventSchema = {
1254
+ type: 'string',
1255
+ enum: ['off', 'on'],
1256
+ };
1257
+ export const CapabilitySchema = {
1258
+ allOf: [
1259
+ {
1260
+ $ref: '#/components/schemas/SubmodelElement',
1261
+ },
1262
+ {
1263
+ properties: {
1264
+ modelType: {
1265
+ pattern: '^Capability$',
1266
+ type: 'string',
1267
+ },
1268
+ },
1269
+ },
1270
+ ],
1271
+ };
1272
+ export const EntitySchema = {
1273
+ allOf: [
1274
+ {
1275
+ $ref: '#/components/schemas/SubmodelElement',
1276
+ },
1277
+ {
1278
+ required: ['entityType'],
1279
+ properties: {
1280
+ statements: {
1281
+ minItems: 1,
1282
+ type: 'array',
1283
+ items: {
1284
+ $ref: '#/components/schemas/SubmodelElement_choice',
1285
+ },
1286
+ },
1287
+ entityType: {
1288
+ $ref: '#/components/schemas/EntityType',
1289
+ },
1290
+ globalAssetId: {
1291
+ maxLength: 2000,
1292
+ minLength: 1,
1293
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
1294
+ type: 'string',
1295
+ },
1296
+ specificAssetIds: {
1297
+ minItems: 1,
1298
+ type: 'array',
1299
+ items: {
1300
+ $ref: '#/components/schemas/SpecificAssetId',
1301
+ },
1302
+ },
1303
+ modelType: {
1304
+ pattern: '^Entity$',
1305
+ type: 'string',
1306
+ },
1307
+ },
1308
+ },
1309
+ ],
1310
+ };
1311
+ export const EntityTypeSchema = {
1312
+ type: 'string',
1313
+ enum: ['CoManagedEntity', 'SelfManagedEntity'],
1314
+ };
1315
+ export const OperationSchema = {
1316
+ allOf: [
1317
+ {
1318
+ $ref: '#/components/schemas/SubmodelElement',
1319
+ },
1320
+ {
1321
+ properties: {
1322
+ inputVariables: {
1323
+ minItems: 1,
1324
+ type: 'array',
1325
+ items: {
1326
+ $ref: '#/components/schemas/OperationVariable',
1327
+ },
1328
+ },
1329
+ outputVariables: {
1330
+ minItems: 1,
1331
+ type: 'array',
1332
+ items: {
1333
+ $ref: '#/components/schemas/OperationVariable',
1334
+ },
1335
+ },
1336
+ inoutputVariables: {
1337
+ minItems: 1,
1338
+ type: 'array',
1339
+ items: {
1340
+ $ref: '#/components/schemas/OperationVariable',
1341
+ },
1342
+ },
1343
+ modelType: {
1344
+ pattern: '^Operation$',
1345
+ type: 'string',
1346
+ },
1347
+ },
1348
+ },
1349
+ ],
1350
+ };
1351
+ export const OperationVariableSchema = {
1352
+ required: ['value'],
1353
+ type: 'object',
1354
+ properties: {
1355
+ value: {
1356
+ $ref: '#/components/schemas/SubmodelElement_choice',
1357
+ },
1358
+ },
1359
+ };
1360
+ export const SubmodelElementCollectionSchema = {
1361
+ allOf: [
1362
+ {
1363
+ $ref: '#/components/schemas/SubmodelElement',
1364
+ },
1365
+ {
1366
+ properties: {
1367
+ value: {
1368
+ minItems: 1,
1369
+ type: 'array',
1370
+ items: {
1371
+ $ref: '#/components/schemas/SubmodelElement_choice',
1372
+ },
1373
+ },
1374
+ modelType: {
1375
+ pattern: '^SubmodelElementCollection$',
1376
+ type: 'string',
1377
+ },
1378
+ },
1379
+ },
1380
+ ],
1381
+ };
1382
+ export const SubmodelElementListSchema = {
1383
+ allOf: [
1384
+ {
1385
+ $ref: '#/components/schemas/SubmodelElement',
1386
+ },
1387
+ {
1388
+ required: ['typeValueListElement'],
1389
+ properties: {
1390
+ orderRelevant: {
1391
+ type: 'boolean',
1392
+ },
1393
+ semanticIdListElement: {
1394
+ $ref: '#/components/schemas/Reference',
1395
+ },
1396
+ typeValueListElement: {
1397
+ $ref: '#/components/schemas/AasSubmodelElements',
1398
+ },
1399
+ valueTypeListElement: {
1400
+ $ref: '#/components/schemas/DataTypeDefXsd',
1401
+ },
1402
+ value: {
1403
+ minItems: 1,
1404
+ type: 'array',
1405
+ items: {
1406
+ $ref: '#/components/schemas/SubmodelElement_choice',
1407
+ },
1408
+ },
1409
+ modelType: {
1410
+ pattern: '^SubmodelElementList$',
1411
+ type: 'string',
1412
+ },
1413
+ },
1414
+ },
1415
+ ],
1416
+ };
1417
+ export const AasSubmodelElementsSchema = {
1418
+ type: 'string',
1419
+ enum: [
1420
+ 'AnnotatedRelationshipElement',
1421
+ 'BasicEventElement',
1422
+ 'Blob',
1423
+ 'Capability',
1424
+ 'DataElement',
1425
+ 'Entity',
1426
+ 'EventElement',
1427
+ 'File',
1428
+ 'MultiLanguageProperty',
1429
+ 'Operation',
1430
+ 'Property',
1431
+ 'Range',
1432
+ 'ReferenceElement',
1433
+ 'RelationshipElement',
1434
+ 'SubmodelElement',
1435
+ 'SubmodelElementCollection',
1436
+ 'SubmodelElementList',
1437
+ ],
1438
+ };
1439
+ export const SubmodelMetadataSchema = {
1440
+ allOf: [
1441
+ {
1442
+ $ref: '#/components/schemas/Identifiable',
1443
+ },
1444
+ {
1445
+ $ref: '#/components/schemas/HasDataSpecification',
1446
+ },
1447
+ {
1448
+ $ref: '#/components/schemas/Qualifiable',
1449
+ },
1450
+ {
1451
+ $ref: '#/components/schemas/HasSemantics',
1452
+ },
1453
+ {
1454
+ $ref: '#/components/schemas/HasKind',
1455
+ },
1456
+ ],
1457
+ };
1458
+ export const SubmodelValueSchema = {
1459
+ type: 'object',
1460
+ description: "The ValueOnly serialization (patternProperties and propertyNames will be supported probably with OpenApi 3.1). For the full description of the generic JSON validation schema see the ValueOnly-Serialization as defined in the 'Specification of the Asset Administration Shell - Part 2'.",
1461
+ };
1462
+ export const PathItemSchema = {
1463
+ pattern: '^([A-Za-z][A-Za-z0-9_]+)((\\.[A-Za-z][A-Za-z0-9_]+)|(\\[(0|[1-9][0-9]*)\\])){0,}$',
1464
+ type: 'string',
1465
+ };
1466
+ export const GetSubmodelElementsResultSchema = {
1467
+ allOf: [
1468
+ {
1469
+ $ref: '#/components/schemas/PagedResult',
1470
+ },
1471
+ {
1472
+ type: 'object',
1473
+ properties: {
1474
+ result: {
1475
+ type: 'array',
1476
+ items: {
1477
+ $ref: '#/components/schemas/SubmodelElement',
1478
+ },
1479
+ },
1480
+ },
1481
+ },
1482
+ ],
1483
+ };
1484
+ export const GetSubmodelElementsMetadataResultSchema = {
1485
+ allOf: [
1486
+ {
1487
+ $ref: '#/components/schemas/PagedResult',
1488
+ },
1489
+ {
1490
+ type: 'object',
1491
+ properties: {
1492
+ result: {
1493
+ type: 'array',
1494
+ items: {
1495
+ $ref: '#/components/schemas/SubmodelElementMetadata',
1496
+ },
1497
+ },
1498
+ },
1499
+ },
1500
+ ],
1501
+ };
1502
+ export const SubmodelElementMetadataSchema = {
1503
+ oneOf: [
1504
+ {
1505
+ $ref: '#/components/schemas/BlobMetadata',
1506
+ },
1507
+ {
1508
+ $ref: '#/components/schemas/FileMetadata',
1509
+ },
1510
+ {
1511
+ $ref: '#/components/schemas/CapabilityMetadata',
1512
+ },
1513
+ {
1514
+ $ref: '#/components/schemas/EntityMetadata',
1515
+ },
1516
+ {
1517
+ $ref: '#/components/schemas/BasicEventElementMetadata',
1518
+ },
1519
+ {
1520
+ $ref: '#/components/schemas/MultiLanguagePropertyMetadata',
1521
+ },
1522
+ {
1523
+ $ref: '#/components/schemas/OperationMetadata',
1524
+ },
1525
+ {
1526
+ $ref: '#/components/schemas/PropertyMetadata',
1527
+ },
1528
+ {
1529
+ $ref: '#/components/schemas/RangeMetadata',
1530
+ },
1531
+ {
1532
+ $ref: '#/components/schemas/ReferenceElementMetadata',
1533
+ },
1534
+ {
1535
+ $ref: '#/components/schemas/AnnotatedRelationshipElementMetadata',
1536
+ },
1537
+ {
1538
+ $ref: '#/components/schemas/RelationshipElementMetadata',
1539
+ },
1540
+ {
1541
+ $ref: '#/components/schemas/SubmodelElementListMetadata',
1542
+ },
1543
+ {
1544
+ $ref: '#/components/schemas/SubmodelElementCollectionMetadata',
1545
+ },
1546
+ ],
1547
+ };
1548
+ export const BlobMetadataSchema = {
1549
+ allOf: [
1550
+ {
1551
+ $ref: '#/components/schemas/Referable_1',
1552
+ },
1553
+ {
1554
+ $ref: '#/components/schemas/HasDataSpecification',
1555
+ },
1556
+ {
1557
+ $ref: '#/components/schemas/HasSemantics_1',
1558
+ },
1559
+ {
1560
+ $ref: '#/components/schemas/Qualifiable_1',
1561
+ },
1562
+ {
1563
+ $ref: '#/components/schemas/HasKind_1',
1564
+ },
1565
+ ],
1566
+ };
1567
+ export const FileMetadataSchema = {
1568
+ allOf: [
1569
+ {
1570
+ $ref: '#/components/schemas/SubmodelElementAttributes',
1571
+ },
1572
+ ],
1573
+ };
1574
+ export const SubmodelElementAttributesSchema = {
1575
+ allOf: [
1576
+ {
1577
+ $ref: '#/components/schemas/Referable_1',
1578
+ },
1579
+ {
1580
+ $ref: '#/components/schemas/HasDataSpecification',
1581
+ },
1582
+ {
1583
+ $ref: '#/components/schemas/HasSemantics_1',
1584
+ },
1585
+ {
1586
+ $ref: '#/components/schemas/Qualifiable_1',
1587
+ },
1588
+ {
1589
+ $ref: '#/components/schemas/HasKind_1',
1590
+ },
1591
+ ],
1592
+ };
1593
+ export const Referable_1Schema = {
1594
+ allOf: [
1595
+ {
1596
+ $ref: '#/components/schemas/HasExtensions',
1597
+ },
1598
+ {
1599
+ required: ['modelType'],
1600
+ properties: {
1601
+ category: {
1602
+ maxLength: 128,
1603
+ minLength: 1,
1604
+ pattern: '^([\\t\\n\\r -퟿-�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
1605
+ type: 'string',
1606
+ },
1607
+ idShort: {
1608
+ type: 'string',
1609
+ allOf: [
1610
+ {
1611
+ maxLength: 128,
1612
+ minLength: 1,
1613
+ },
1614
+ {
1615
+ pattern: '^([\\t\\n\\r -퟿-�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
1616
+ },
1617
+ {
1618
+ pattern: '^[a-zA-Z][a-zA-Z0-9_]*$',
1619
+ },
1620
+ ],
1621
+ },
1622
+ displayName: {
1623
+ minItems: 1,
1624
+ type: 'array',
1625
+ items: {
1626
+ $ref: '#/components/schemas/LangStringNameType',
1627
+ },
1628
+ },
1629
+ description: {
1630
+ minItems: 1,
1631
+ type: 'array',
1632
+ items: {
1633
+ $ref: '#/components/schemas/LangStringTextType',
1634
+ },
1635
+ },
1636
+ modelType: {
1637
+ $ref: '#/components/schemas/ModelType',
1638
+ },
1639
+ },
1640
+ },
1641
+ ],
1642
+ };
1643
+ export const HasSemantics_1Schema = {
1644
+ type: 'object',
1645
+ properties: {
1646
+ semanticId: {
1647
+ $ref: '#/components/schemas/Reference',
1648
+ },
1649
+ supplementalSemanticIds: {
1650
+ minItems: 1,
1651
+ type: 'array',
1652
+ items: {
1653
+ $ref: '#/components/schemas/Reference',
1654
+ },
1655
+ },
1656
+ },
1657
+ };
1658
+ export const Qualifiable_1Schema = {
1659
+ required: ['modelType'],
1660
+ type: 'object',
1661
+ properties: {
1662
+ qualifiers: {
1663
+ minItems: 1,
1664
+ type: 'array',
1665
+ items: {
1666
+ $ref: '#/components/schemas/Qualifier_1',
1667
+ },
1668
+ },
1669
+ modelType: {
1670
+ $ref: '#/components/schemas/ModelType',
1671
+ },
1672
+ },
1673
+ };
1674
+ export const Qualifier_1Schema = {
1675
+ allOf: [
1676
+ {
1677
+ $ref: '#/components/schemas/HasSemantics_1',
1678
+ },
1679
+ {
1680
+ required: ['type', 'valueType'],
1681
+ properties: {
1682
+ kind: {
1683
+ $ref: '#/components/schemas/QualifierKind',
1684
+ },
1685
+ type: {
1686
+ maxLength: 128,
1687
+ minLength: 1,
1688
+ pattern: '^([\\t\\n\\r -퟿-�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
1689
+ type: 'string',
1690
+ },
1691
+ valueType: {
1692
+ $ref: '#/components/schemas/DataTypeDefXsd',
1693
+ },
1694
+ value: {
1695
+ type: 'string',
1696
+ },
1697
+ valueId: {
1698
+ $ref: '#/components/schemas/Reference',
1699
+ },
1700
+ },
1701
+ },
1702
+ ],
1703
+ };
1704
+ export const HasKind_1Schema = {
1705
+ type: 'object',
1706
+ properties: {
1707
+ kind: {
1708
+ $ref: '#/components/schemas/ModellingKind',
1709
+ },
1710
+ },
1711
+ };
1712
+ export const CapabilityMetadataSchema = {
1713
+ allOf: [
1714
+ {
1715
+ $ref: '#/components/schemas/SubmodelElementAttributes',
1716
+ },
1717
+ ],
1718
+ };
1719
+ export const EntityMetadataSchema = {
1720
+ allOf: [
1721
+ {
1722
+ $ref: '#/components/schemas/SubmodelElementAttributes',
1723
+ },
1724
+ ],
1725
+ };
1726
+ export const BasicEventElementMetadataSchema = {
1727
+ allOf: [
1728
+ {
1729
+ $ref: '#/components/schemas/SubmodelElementAttributes',
1730
+ },
1731
+ {
1732
+ properties: {
1733
+ direction: {
1734
+ $ref: '#/components/schemas/Direction',
1735
+ },
1736
+ state: {
1737
+ $ref: '#/components/schemas/StateOfEvent',
1738
+ },
1739
+ messageTopic: {
1740
+ maxLength: 255,
1741
+ type: 'string',
1742
+ },
1743
+ messageBroker: {
1744
+ $ref: '#/components/schemas/Reference',
1745
+ },
1746
+ lastUpdate: {
1747
+ type: 'string',
1748
+ },
1749
+ minInterval: {
1750
+ type: 'string',
1751
+ },
1752
+ maxInterval: {
1753
+ type: 'string',
1754
+ },
1755
+ },
1756
+ },
1757
+ ],
1758
+ };
1759
+ export const MultiLanguagePropertyMetadataSchema = {
1760
+ allOf: [
1761
+ {
1762
+ $ref: '#/components/schemas/SubmodelElementAttributes',
1763
+ },
1764
+ ],
1765
+ };
1766
+ export const OperationMetadataSchema = {
1767
+ allOf: [
1768
+ {
1769
+ $ref: '#/components/schemas/SubmodelElementAttributes',
1770
+ },
1771
+ ],
1772
+ };
1773
+ export const PropertyMetadataSchema = {
1774
+ properties: {
1775
+ valueType: {
1776
+ $ref: '#/components/schemas/DataTypeDefXsd',
1777
+ },
1778
+ },
1779
+ allOf: [
1780
+ {
1781
+ $ref: '#/components/schemas/SubmodelElementAttributes',
1782
+ },
1783
+ ],
1784
+ };
1785
+ export const RangeMetadataSchema = {
1786
+ properties: {
1787
+ valueType: {
1788
+ $ref: '#/components/schemas/DataTypeDefXsd',
1789
+ },
1790
+ },
1791
+ allOf: [
1792
+ {
1793
+ $ref: '#/components/schemas/SubmodelElementAttributes',
1794
+ },
1795
+ ],
1796
+ };
1797
+ export const ReferenceElementMetadataSchema = {
1798
+ allOf: [
1799
+ {
1800
+ $ref: '#/components/schemas/SubmodelElementAttributes',
1801
+ },
1802
+ ],
1803
+ };
1804
+ export const AnnotatedRelationshipElementMetadataSchema = {
1805
+ allOf: [
1806
+ {
1807
+ $ref: '#/components/schemas/Referable_1',
1808
+ },
1809
+ {
1810
+ $ref: '#/components/schemas/HasDataSpecification',
1811
+ },
1812
+ {
1813
+ $ref: '#/components/schemas/HasSemantics_1',
1814
+ },
1815
+ {
1816
+ $ref: '#/components/schemas/Qualifiable_1',
1817
+ },
1818
+ {
1819
+ $ref: '#/components/schemas/HasKind_1',
1820
+ },
1821
+ ],
1822
+ };
1823
+ export const RelationshipElementMetadataSchema = {
1824
+ allOf: [
1825
+ {
1826
+ $ref: '#/components/schemas/SubmodelElementAttributes',
1827
+ },
1828
+ ],
1829
+ };
1830
+ export const SubmodelElementListMetadataSchema = {
1831
+ properties: {
1832
+ orderRelevant: {
1833
+ type: 'boolean',
1834
+ },
1835
+ semanticIdListElement: {
1836
+ $ref: '#/components/schemas/Reference',
1837
+ },
1838
+ typeValueListElement: {
1839
+ $ref: '#/components/schemas/ModelType',
1840
+ },
1841
+ valueTypeListElement: {
1842
+ $ref: '#/components/schemas/DataTypeDefXsd',
1843
+ },
1844
+ },
1845
+ allOf: [
1846
+ {
1847
+ $ref: '#/components/schemas/SubmodelElementAttributes',
1848
+ },
1849
+ ],
1850
+ };
1851
+ export const SubmodelElementCollectionMetadataSchema = {
1852
+ allOf: [
1853
+ {
1854
+ $ref: '#/components/schemas/SubmodelElementAttributes',
1855
+ },
1856
+ ],
1857
+ };
1858
+ export const GetSubmodelElementsValueResultSchema = {
1859
+ allOf: [
1860
+ {
1861
+ $ref: '#/components/schemas/PagedResult',
1862
+ },
1863
+ {
1864
+ type: 'object',
1865
+ properties: {
1866
+ result: {
1867
+ type: 'array',
1868
+ items: {
1869
+ $ref: '#/components/schemas/SubmodelElementValue',
1870
+ },
1871
+ },
1872
+ },
1873
+ },
1874
+ ],
1875
+ };
1876
+ export const SubmodelElementValueSchema = {
1877
+ oneOf: [
1878
+ {
1879
+ $ref: '#/components/schemas/BasicEventElementValue',
1880
+ },
1881
+ {
1882
+ $ref: '#/components/schemas/PropertyValue',
1883
+ },
1884
+ {
1885
+ $ref: '#/components/schemas/MultiLanguagePropertyValue',
1886
+ },
1887
+ {
1888
+ $ref: '#/components/schemas/BlobValue',
1889
+ },
1890
+ {
1891
+ $ref: '#/components/schemas/FileValue',
1892
+ },
1893
+ {
1894
+ $ref: '#/components/schemas/RangeValue',
1895
+ },
1896
+ {
1897
+ $ref: '#/components/schemas/ReferenceElementValue',
1898
+ },
1899
+ {
1900
+ $ref: '#/components/schemas/RelationshipElementValue',
1901
+ },
1902
+ {
1903
+ $ref: '#/components/schemas/AnnotatedRelationshipElementValue',
1904
+ },
1905
+ {
1906
+ $ref: '#/components/schemas/EntityValue',
1907
+ },
1908
+ {
1909
+ $ref: '#/components/schemas/SubmodelElementCollectionValue',
1910
+ },
1911
+ {
1912
+ $ref: '#/components/schemas/SubmodelElementListValue',
1913
+ },
1914
+ ],
1915
+ };
1916
+ export const BasicEventElementValueSchema = {
1917
+ required: ['observed'],
1918
+ type: 'object',
1919
+ properties: {
1920
+ observed: {
1921
+ $ref: '#/components/schemas/ReferenceValue',
1922
+ },
1923
+ },
1924
+ };
1925
+ export const ReferenceValueSchema = {
1926
+ type: 'object',
1927
+ properties: {
1928
+ type: {
1929
+ $ref: '#/components/schemas/ReferenceTypes',
1930
+ },
1931
+ keys: {
1932
+ type: 'array',
1933
+ items: {
1934
+ $ref: '#/components/schemas/Key',
1935
+ },
1936
+ },
1937
+ },
1938
+ };
1939
+ export const PropertyValueSchema = {
1940
+ oneOf: [
1941
+ {
1942
+ $ref: '#/components/schemas/StringValue',
1943
+ },
1944
+ {
1945
+ $ref: '#/components/schemas/NumberValue',
1946
+ },
1947
+ {
1948
+ $ref: '#/components/schemas/BooleanValue',
1949
+ },
1950
+ ],
1951
+ };
1952
+ export const StringValueSchema = {
1953
+ type: 'string',
1954
+ };
1955
+ export const NumberValueSchema = {
1956
+ type: 'number',
1957
+ };
1958
+ export const BooleanValueSchema = {
1959
+ type: 'boolean',
1960
+ };
1961
+ export const MultiLanguagePropertyValueSchema = {
1962
+ type: 'object',
1963
+ description: 'Since patternProperties and propertyNames are not supported by OpenApi yet, the ValueOnly serialization for this elements works with the key-attribute as the JSON-property name and the value-attribute as the corresponding value.',
1964
+ };
1965
+ export const BlobValueSchema = {
1966
+ required: ['contentType'],
1967
+ type: 'object',
1968
+ properties: {
1969
+ contentType: {
1970
+ maxLength: 100,
1971
+ minLength: 1,
1972
+ type: 'string',
1973
+ },
1974
+ value: {
1975
+ type: 'string',
1976
+ },
1977
+ },
1978
+ };
1979
+ export const FileValueSchema = {
1980
+ required: ['contentType', 'value'],
1981
+ type: 'object',
1982
+ properties: {
1983
+ contentType: {
1984
+ maxLength: 100,
1985
+ minLength: 1,
1986
+ type: 'string',
1987
+ },
1988
+ value: {
1989
+ maxLength: 2000,
1990
+ minLength: 1,
1991
+ type: 'string',
1992
+ },
1993
+ },
1994
+ };
1995
+ export const RangeValueSchema = {
1996
+ type: 'object',
1997
+ properties: {
1998
+ max: {
1999
+ $ref: '#/components/schemas/RangeValueType',
2000
+ },
2001
+ min: {
2002
+ $ref: '#/components/schemas/RangeValueType',
2003
+ },
2004
+ },
2005
+ };
2006
+ export const RangeValueTypeSchema = {
2007
+ oneOf: [
2008
+ {
2009
+ $ref: '#/components/schemas/StringValue',
2010
+ },
2011
+ {
2012
+ $ref: '#/components/schemas/NumberValue',
2013
+ },
2014
+ {
2015
+ $ref: '#/components/schemas/BooleanValue',
2016
+ },
2017
+ ],
2018
+ };
2019
+ export const ReferenceElementValueSchema = {
2020
+ type: 'object',
2021
+ properties: {
2022
+ type: {
2023
+ $ref: '#/components/schemas/ReferenceTypes',
2024
+ },
2025
+ keys: {
2026
+ type: 'array',
2027
+ items: {
2028
+ $ref: '#/components/schemas/Key',
2029
+ },
2030
+ },
2031
+ },
2032
+ };
2033
+ export const RelationshipElementValueSchema = {
2034
+ required: ['first', 'second'],
2035
+ type: 'object',
2036
+ properties: {
2037
+ first: {
2038
+ $ref: '#/components/schemas/ReferenceValue',
2039
+ },
2040
+ second: {
2041
+ $ref: '#/components/schemas/ReferenceValue',
2042
+ },
2043
+ },
2044
+ };
2045
+ export const AnnotatedRelationshipElementValueSchema = {
2046
+ required: ['first', 'second'],
2047
+ type: 'object',
2048
+ properties: {
2049
+ first: {
2050
+ $ref: '#/components/schemas/ReferenceValue',
2051
+ },
2052
+ second: {
2053
+ $ref: '#/components/schemas/ReferenceValue',
2054
+ },
2055
+ annotations: {
2056
+ type: 'array',
2057
+ items: {
2058
+ $ref: '#/components/schemas/ValueOnly',
2059
+ },
2060
+ },
2061
+ },
2062
+ };
2063
+ export const ValueOnlySchema = {
2064
+ type: 'object',
2065
+ description: "The ValueOnly serialization (patternProperties and propertyNames will be supported probably with OpenApi 3.1). For the full description of the generic JSON validation schema see the ValueOnly-Serialization as defined in the 'Specification of the Asset Administration Shell - Part 2'.",
2066
+ };
2067
+ export const EntityValueSchema = {
2068
+ required: ['entityType'],
2069
+ type: 'object',
2070
+ properties: {
2071
+ entityType: {
2072
+ $ref: '#/components/schemas/EntityType',
2073
+ },
2074
+ globalAssetId: {
2075
+ maxLength: 2000,
2076
+ minLength: 1,
2077
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
2078
+ type: 'string',
2079
+ },
2080
+ specificAssetIds: {
2081
+ type: 'array',
2082
+ items: {
2083
+ $ref: '#/components/schemas/SpecificAssetIdValue',
2084
+ },
2085
+ },
2086
+ statements: {
2087
+ type: 'array',
2088
+ items: {
2089
+ $ref: '#/components/schemas/ValueOnly',
2090
+ },
2091
+ },
2092
+ },
2093
+ };
2094
+ export const SpecificAssetIdValueSchema = {
2095
+ type: 'object',
2096
+ description: 'Since patternProperties and propertyNames are not supported by OpenApi yet, the ValueOnly serialization for this elements works with the key-attribute as the JSON-property name and the value-attribute as the corresponding value.',
2097
+ };
2098
+ export const SubmodelElementCollectionValueSchema = {
2099
+ type: 'object',
2100
+ description: 'Since patternProperties and propertyNames are not supported by OpenApi yet, the ValueOnly serialization for this elements works with the key-attribute as the JSON-property name and the value-attribute as the corresponding value.',
2101
+ };
2102
+ export const SubmodelElementListValueSchema = {
2103
+ type: 'array',
2104
+ items: {
2105
+ $ref: '#/components/schemas/SubmodelElementValue',
2106
+ },
2107
+ };
2108
+ export const GetPathItemsResultSchema = {
2109
+ allOf: [
2110
+ {
2111
+ $ref: '#/components/schemas/PagedResult',
2112
+ },
2113
+ {
2114
+ type: 'object',
2115
+ properties: {
2116
+ result: {
2117
+ type: 'array',
2118
+ items: {
2119
+ $ref: '#/components/schemas/PathItem',
2120
+ },
2121
+ },
2122
+ },
2123
+ },
2124
+ ],
2125
+ };
2126
+ export const OperationRequestSchema = {
2127
+ type: 'object',
2128
+ properties: {
2129
+ inoutputArguments: {
2130
+ type: 'array',
2131
+ items: {
2132
+ $ref: '#/components/schemas/OperationVariable',
2133
+ },
2134
+ },
2135
+ inputArguments: {
2136
+ type: 'array',
2137
+ items: {
2138
+ $ref: '#/components/schemas/OperationVariable',
2139
+ },
2140
+ },
2141
+ clientTimeoutDuration: {
2142
+ pattern: '^-?P((([0-9]+Y([0-9]+M)?([0-9]+D)?|([0-9]+M)([0-9]+D)?|([0-9]+D))(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S)))?)|(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S))))$',
2143
+ type: 'string',
2144
+ },
2145
+ },
2146
+ };
2147
+ export const OperationResultSchema = {
2148
+ type: 'object',
2149
+ allOf: [
2150
+ {
2151
+ $ref: '#/components/schemas/BaseOperationResult',
2152
+ },
2153
+ {
2154
+ properties: {
2155
+ inoutputArguments: {
2156
+ type: 'array',
2157
+ items: {
2158
+ $ref: '#/components/schemas/OperationVariable',
2159
+ },
2160
+ },
2161
+ outputArguments: {
2162
+ type: 'array',
2163
+ items: {
2164
+ $ref: '#/components/schemas/OperationVariable',
2165
+ },
2166
+ },
2167
+ },
2168
+ },
2169
+ ],
2170
+ };
2171
+ export const BaseOperationResultSchema = {
2172
+ allOf: [
2173
+ {
2174
+ $ref: '#/components/schemas/Result',
2175
+ },
2176
+ {
2177
+ properties: {
2178
+ executionState: {
2179
+ $ref: '#/components/schemas/ExecutionState',
2180
+ },
2181
+ success: {
2182
+ type: 'boolean',
2183
+ },
2184
+ },
2185
+ },
2186
+ ],
2187
+ };
2188
+ export const ExecutionStateSchema = {
2189
+ type: 'string',
2190
+ enum: ['Initiated', 'Running', 'Completed', 'Canceled', 'Failed', 'Timeout'],
2191
+ };
2192
+ export const OperationRequestValueOnlySchema = {
2193
+ required: ['clientTimeoutDuration'],
2194
+ type: 'object',
2195
+ properties: {
2196
+ inoutputArguments: {
2197
+ $ref: '#/components/schemas/ValueOnly',
2198
+ },
2199
+ inputArguments: {
2200
+ $ref: '#/components/schemas/ValueOnly',
2201
+ },
2202
+ clientTimeoutDuration: {
2203
+ pattern: '^-?P((([0-9]+Y([0-9]+M)?([0-9]+D)?|([0-9]+M)([0-9]+D)?|([0-9]+D))(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S)))?)|(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S))))$',
2204
+ type: 'string',
2205
+ },
2206
+ },
2207
+ };
2208
+ export const OperationResultValueOnlySchema = {
2209
+ type: 'object',
2210
+ allOf: [
2211
+ {
2212
+ $ref: '#/components/schemas/BaseOperationResult',
2213
+ },
2214
+ {
2215
+ properties: {
2216
+ inoutputArguments: {
2217
+ $ref: '#/components/schemas/ValueOnly',
2218
+ },
2219
+ outputArguments: {
2220
+ $ref: '#/components/schemas/ValueOnly',
2221
+ },
2222
+ },
2223
+ },
2224
+ ],
2225
+ };
2226
+ export const GetAssetAdministrationShellsResultSchema = {
2227
+ allOf: [
2228
+ {
2229
+ $ref: '#/components/schemas/PagedResult',
2230
+ },
2231
+ {
2232
+ type: 'object',
2233
+ properties: {
2234
+ result: {
2235
+ type: 'array',
2236
+ items: {
2237
+ $ref: '#/components/schemas/AssetAdministrationShell',
2238
+ },
2239
+ },
2240
+ },
2241
+ },
2242
+ ],
2243
+ };
2244
+ export const GetSubmodelsResultSchema = {
2245
+ allOf: [
2246
+ {
2247
+ $ref: '#/components/schemas/PagedResult',
2248
+ },
2249
+ {
2250
+ type: 'object',
2251
+ properties: {
2252
+ result: {
2253
+ type: 'array',
2254
+ items: {
2255
+ $ref: '#/components/schemas/Submodel',
2256
+ },
2257
+ },
2258
+ },
2259
+ },
2260
+ ],
2261
+ };
2262
+ export const GetSubmodelsMetadataResultSchema = {
2263
+ allOf: [
2264
+ {
2265
+ $ref: '#/components/schemas/PagedResult',
2266
+ },
2267
+ {
2268
+ type: 'object',
2269
+ properties: {
2270
+ result: {
2271
+ type: 'array',
2272
+ items: {
2273
+ $ref: '#/components/schemas/SubmodelMetadata',
2274
+ },
2275
+ },
2276
+ },
2277
+ },
2278
+ ],
2279
+ };
2280
+ export const GetSubmodelsValueResultSchema = {
2281
+ allOf: [
2282
+ {
2283
+ $ref: '#/components/schemas/PagedResult',
2284
+ },
2285
+ {
2286
+ type: 'object',
2287
+ properties: {
2288
+ result: {
2289
+ type: 'array',
2290
+ items: {
2291
+ $ref: '#/components/schemas/SubmodelValue',
2292
+ },
2293
+ },
2294
+ },
2295
+ },
2296
+ ],
2297
+ };
2298
+ export const GetConceptDescriptionsResultSchema = {
2299
+ allOf: [
2300
+ {
2301
+ $ref: '#/components/schemas/PagedResult',
2302
+ },
2303
+ {
2304
+ type: 'object',
2305
+ properties: {
2306
+ result: {
2307
+ type: 'array',
2308
+ items: {
2309
+ $ref: '#/components/schemas/ConceptDescription',
2310
+ },
2311
+ },
2312
+ },
2313
+ },
2314
+ ],
2315
+ };
2316
+ export const ConceptDescriptionSchema = {
2317
+ allOf: [
2318
+ {
2319
+ $ref: '#/components/schemas/Identifiable',
2320
+ },
2321
+ {
2322
+ $ref: '#/components/schemas/HasDataSpecification',
2323
+ },
2324
+ {
2325
+ properties: {
2326
+ isCaseOf: {
2327
+ minItems: 1,
2328
+ type: 'array',
2329
+ items: {
2330
+ $ref: '#/components/schemas/Reference',
2331
+ },
2332
+ },
2333
+ modelType: {
2334
+ pattern: '^ConceptDescription$',
2335
+ type: 'string',
2336
+ },
2337
+ },
2338
+ },
2339
+ ],
2340
+ };
2341
+ export const GetAssetAdministrationShellDescriptorsResultSchema = {
2342
+ allOf: [
2343
+ {
2344
+ $ref: '#/components/schemas/PagedResult',
2345
+ },
2346
+ {
2347
+ type: 'object',
2348
+ properties: {
2349
+ result: {
2350
+ type: 'array',
2351
+ items: {
2352
+ $ref: '#/components/schemas/AssetAdministrationShellDescriptor',
2353
+ },
2354
+ },
2355
+ },
2356
+ },
2357
+ ],
2358
+ };
2359
+ export const AssetAdministrationShellDescriptorSchema = {
2360
+ required: ['id'],
2361
+ type: 'object',
2362
+ example: '{ "id": "https://example.org/aas/motor", "endpoints": [ { "protocolInformation": { "href": "https://localhost:1234/api/v3.0/aas", "endpointProtocol": "HTTP", "endpointProtocolVersion": ["1.1"] }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "opc.tcp://localhost:4840" }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "https://localhost:5678", "endpointProtocol": "HTTP", "endpointProtocolVersion": ["1.1"], "subprotocol": "OPC UA Basic SOAP", "subprotocolBody": "ns=2;s=MyAAS", "subprotocolBodyEncoding": "application/soap+xml" }, "interface": "AAS-3.0" } ] }',
2363
+ allOf: [
2364
+ {
2365
+ $ref: '#/components/schemas/Descriptor',
2366
+ },
2367
+ {
2368
+ properties: {
2369
+ administration: {
2370
+ $ref: '#/components/schemas/AdministrativeInformation',
2371
+ },
2372
+ assetKind: {
2373
+ $ref: '#/components/schemas/AssetKind',
2374
+ },
2375
+ assetType: {
2376
+ maxLength: 2000,
2377
+ minLength: 1,
2378
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
2379
+ type: 'string',
2380
+ },
2381
+ endpoints: {
2382
+ minItems: 1,
2383
+ type: 'array',
2384
+ items: {
2385
+ $ref: '#/components/schemas/Endpoint',
2386
+ },
2387
+ },
2388
+ globalAssetId: {
2389
+ maxLength: 2000,
2390
+ minLength: 1,
2391
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
2392
+ type: 'string',
2393
+ },
2394
+ idShort: {
2395
+ maxLength: 128,
2396
+ type: 'string',
2397
+ },
2398
+ id: {
2399
+ maxLength: 2000,
2400
+ minLength: 1,
2401
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
2402
+ type: 'string',
2403
+ },
2404
+ specificAssetIds: {
2405
+ type: 'array',
2406
+ items: {
2407
+ $ref: '#/components/schemas/SpecificAssetId',
2408
+ },
2409
+ },
2410
+ submodelDescriptors: {
2411
+ type: 'array',
2412
+ items: {
2413
+ $ref: '#/components/schemas/SubmodelDescriptor',
2414
+ },
2415
+ },
2416
+ },
2417
+ },
2418
+ ],
2419
+ };
2420
+ export const DescriptorSchema = {
2421
+ type: 'object',
2422
+ properties: {
2423
+ description: {
2424
+ type: 'array',
2425
+ items: {
2426
+ $ref: '#/components/schemas/LangStringTextType',
2427
+ },
2428
+ },
2429
+ displayName: {
2430
+ type: 'array',
2431
+ items: {
2432
+ $ref: '#/components/schemas/LangStringNameType',
2433
+ },
2434
+ },
2435
+ extensions: {
2436
+ minItems: 1,
2437
+ type: 'array',
2438
+ items: {
2439
+ $ref: '#/components/schemas/Extension',
2440
+ },
2441
+ },
2442
+ },
2443
+ example: '{ "endpoints": [ { "protocolInformation": { "href": "https://localhost:1234/api/v3.0/aas", "endpointProtocolVersion": ["1.1"] }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "opc.tcp://localhost:4840" }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "https://localhost:5678", "endpointProtocolVersion": ["1.1"], "subprotocol": "OPC UA Basic SOAP", "subprotocolBody": "ns=2;s=MyAAS", "subprotocolBodyEncoding": "application/soap+xml" }, "interface": "AAS-3.0" } ] }',
2444
+ };
2445
+ export const EndpointSchema = {
2446
+ required: ['interface', 'protocolInformation'],
2447
+ type: 'object',
2448
+ properties: {
2449
+ interface: {
2450
+ maxLength: 128,
2451
+ type: 'string',
2452
+ },
2453
+ protocolInformation: {
2454
+ $ref: '#/components/schemas/ProtocolInformation',
2455
+ },
2456
+ },
2457
+ };
2458
+ export const ProtocolInformationSchema = {
2459
+ required: ['href'],
2460
+ type: 'object',
2461
+ properties: {
2462
+ href: {
2463
+ maxLength: 2048,
2464
+ type: 'string',
2465
+ },
2466
+ endpointProtocol: {
2467
+ maxLength: 128,
2468
+ type: 'string',
2469
+ },
2470
+ endpointProtocolVersion: {
2471
+ type: 'array',
2472
+ items: {
2473
+ maxLength: 128,
2474
+ type: 'string',
2475
+ },
2476
+ },
2477
+ subprotocol: {
2478
+ maxLength: 128,
2479
+ type: 'string',
2480
+ },
2481
+ subprotocolBody: {
2482
+ maxLength: 128,
2483
+ type: 'string',
2484
+ },
2485
+ subprotocolBodyEncoding: {
2486
+ maxLength: 128,
2487
+ type: 'string',
2488
+ },
2489
+ securityAttributes: {
2490
+ minItems: 1,
2491
+ type: 'array',
2492
+ items: {
2493
+ $ref: '#/components/schemas/ProtocolInformation_securityAttributes',
2494
+ },
2495
+ },
2496
+ },
2497
+ };
2498
+ export const SubmodelDescriptorSchema = {
2499
+ required: ['endpoints', 'id'],
2500
+ type: 'object',
2501
+ properties: {
2502
+ administration: {
2503
+ $ref: '#/components/schemas/AdministrativeInformation',
2504
+ },
2505
+ endpoints: {
2506
+ minItems: 1,
2507
+ type: 'array',
2508
+ items: {
2509
+ $ref: '#/components/schemas/Endpoint',
2510
+ },
2511
+ },
2512
+ idShort: {
2513
+ maxLength: 128,
2514
+ type: 'string',
2515
+ },
2516
+ id: {
2517
+ maxLength: 2000,
2518
+ minLength: 1,
2519
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
2520
+ type: 'string',
2521
+ },
2522
+ semanticId: {
2523
+ $ref: '#/components/schemas/Reference',
2524
+ },
2525
+ supplementalSemanticId: {
2526
+ minItems: 1,
2527
+ type: 'array',
2528
+ items: {
2529
+ $ref: '#/components/schemas/Reference',
2530
+ },
2531
+ },
2532
+ },
2533
+ example: '{ "id": "https://admin-shell.io/zvei/nameplate/1/0/Nameplate", "endpoints": [ { "href": { "href": "https://localhost:1234/api/v3.0/submodel", "endpointProtocol": "HTTP", "endpointProtocolVersion": ["1.1"] }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "opc.tcp://localhost:4840" }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "https://localhost:5678", "endpointProtocol": "HTTP", "endpointProtocolVersion": ["1.1"], "subprotocol": "OPC UA Basic SOAP", "subprotocolBody": "ns=2;s=MyAAS", "subprotocolBodyEncoding": "application/soap+xml" }, "interface": "AAS-3.0" } ] }',
2534
+ allOf: [
2535
+ {
2536
+ $ref: '#/components/schemas/Descriptor',
2537
+ },
2538
+ ],
2539
+ };
2540
+ export const GetSubmodelDescriptorsResultSchema = {
2541
+ allOf: [
2542
+ {
2543
+ $ref: '#/components/schemas/PagedResult',
2544
+ },
2545
+ {
2546
+ type: 'object',
2547
+ properties: {
2548
+ result: {
2549
+ type: 'array',
2550
+ items: {
2551
+ $ref: '#/components/schemas/SubmodelDescriptor',
2552
+ },
2553
+ },
2554
+ },
2555
+ },
2556
+ ],
2557
+ };
2558
+ export const GetPackageDescriptionsResultSchema = {
2559
+ allOf: [
2560
+ {
2561
+ $ref: '#/components/schemas/PagedResult',
2562
+ },
2563
+ {
2564
+ type: 'object',
2565
+ properties: {
2566
+ result: {
2567
+ type: 'array',
2568
+ items: {
2569
+ $ref: '#/components/schemas/PackageDescription',
2570
+ },
2571
+ },
2572
+ },
2573
+ },
2574
+ ],
2575
+ };
2576
+ export const PackageDescriptionSchema = {
2577
+ type: 'object',
2578
+ properties: {
2579
+ aasIds: {
2580
+ type: 'array',
2581
+ items: {
2582
+ maxLength: 2000,
2583
+ pattern: '^([\\x09\\x0a\\x0d\\x20-\퟿\-\�]|\�[\�-\�]|[\�-\�][\�-\�]|\�[\�-\�])*$',
2584
+ type: 'string',
2585
+ },
2586
+ },
2587
+ packageId: {
2588
+ maxLength: 128,
2589
+ type: 'string',
2590
+ },
2591
+ },
2592
+ };
2593
+ export const EnvironmentSchema = {
2594
+ type: 'object',
2595
+ properties: {
2596
+ assetAdministrationShells: {
2597
+ minItems: 1,
2598
+ type: 'array',
2599
+ items: {
2600
+ $ref: '#/components/schemas/AssetAdministrationShell',
2601
+ },
2602
+ },
2603
+ submodels: {
2604
+ minItems: 1,
2605
+ type: 'array',
2606
+ items: {
2607
+ $ref: '#/components/schemas/Submodel',
2608
+ },
2609
+ },
2610
+ conceptDescriptions: {
2611
+ minItems: 1,
2612
+ type: 'array',
2613
+ items: {
2614
+ $ref: '#/components/schemas/ConceptDescription',
2615
+ },
2616
+ },
2617
+ },
2618
+ };
2619
+ export const ServiceDescriptionSchema = {
2620
+ type: 'object',
2621
+ properties: {
2622
+ profiles: {
2623
+ minItems: 1,
2624
+ type: 'array',
2625
+ items: {
2626
+ type: 'string',
2627
+ example: '["https://admin-shell.io/aas/API/3/0/AssetAdministrationShellServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-003","https://admin-shell.io/aas/API/3/0/AasxFileServerServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/DiscoveryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-003","https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-004","https://admin-shell.io/aas/API/3/0/ConceptDescriptionServiceSpecification/SSP-001"]',
2628
+ },
2629
+ },
2630
+ },
2631
+ description: 'The Description object enables servers to present their capabilities to the clients, in particular which profiles they implement. At least one defined profile is required. Additional, proprietary attributes might be included. Nevertheless, the server must not expect that a regular client understands them.',
2632
+ example: `{
2633
+ "profiles": [
2634
+ "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-002",
2635
+ "https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-002"
2636
+ ]
2637
+ }`,
2638
+ };
2639
+ export const assetinformation_thumbnail_bodySchema = {
2640
+ type: 'object',
2641
+ properties: {
2642
+ fileName: {
2643
+ type: 'string',
2644
+ },
2645
+ file: {
2646
+ type: 'string',
2647
+ format: 'binary',
2648
+ },
2649
+ },
2650
+ };
2651
+ export const idShortPath_attachment_bodySchema = {
2652
+ type: 'object',
2653
+ properties: {
2654
+ fileName: {
2655
+ type: 'string',
2656
+ },
2657
+ file: {
2658
+ type: 'string',
2659
+ format: 'binary',
2660
+ },
2661
+ },
2662
+ };
2663
+ export const idShortPath_attachment_body_1Schema = {
2664
+ type: 'object',
2665
+ properties: {
2666
+ fileName: {
2667
+ type: 'string',
2668
+ },
2669
+ file: {
2670
+ type: 'string',
2671
+ format: 'binary',
2672
+ },
2673
+ },
2674
+ };
2675
+ export const assetinformation_thumbnail_body_1Schema = {
2676
+ type: 'object',
2677
+ properties: {
2678
+ fileName: {
2679
+ type: 'string',
2680
+ },
2681
+ file: {
2682
+ type: 'string',
2683
+ format: 'binary',
2684
+ },
2685
+ },
2686
+ };
2687
+ export const idShortPath_attachment_body_2Schema = {
2688
+ type: 'object',
2689
+ properties: {
2690
+ fileName: {
2691
+ type: 'string',
2692
+ },
2693
+ file: {
2694
+ type: 'string',
2695
+ format: 'binary',
2696
+ },
2697
+ },
2698
+ };
2699
+ export const idShortPath_attachment_body_3Schema = {
2700
+ type: 'object',
2701
+ properties: {
2702
+ fileName: {
2703
+ type: 'string',
2704
+ },
2705
+ file: {
2706
+ type: 'string',
2707
+ format: 'binary',
2708
+ },
2709
+ },
2710
+ };
2711
+ export const inline_response_200Schema = {
2712
+ allOf: [
2713
+ {
2714
+ $ref: '#/components/schemas/PagedResult',
2715
+ },
2716
+ {
2717
+ type: 'object',
2718
+ properties: {
2719
+ result: {
2720
+ type: 'array',
2721
+ items: {
2722
+ type: 'string',
2723
+ },
2724
+ },
2725
+ },
2726
+ },
2727
+ ],
2728
+ };
2729
+ export const packages_bodySchema = {
2730
+ type: 'object',
2731
+ properties: {
2732
+ aasIds: {
2733
+ type: 'array',
2734
+ items: {
2735
+ type: 'string',
2736
+ },
2737
+ },
2738
+ file: {
2739
+ type: 'string',
2740
+ format: 'binary',
2741
+ },
2742
+ fileName: {
2743
+ type: 'string',
2744
+ },
2745
+ },
2746
+ };
2747
+ export const packages_packageId_bodySchema = {
2748
+ type: 'object',
2749
+ properties: {
2750
+ aasIds: {
2751
+ type: 'array',
2752
+ items: {
2753
+ type: 'string',
2754
+ },
2755
+ },
2756
+ file: {
2757
+ type: 'string',
2758
+ format: 'binary',
2759
+ },
2760
+ fileName: {
2761
+ type: 'string',
2762
+ },
2763
+ },
2764
+ };
2765
+ export const PagedResult_paging_metadataSchema = {
2766
+ type: 'object',
2767
+ properties: {
2768
+ cursor: {
2769
+ type: 'string',
2770
+ example: 'wJlCDLIl6KTWypN7T6vc6nWEmEYe99Hjf1XY1xmqV-M=#',
2771
+ },
2772
+ },
2773
+ };
2774
+ export const ProtocolInformation_securityAttributesSchema = {
2775
+ required: ['key', 'type', 'value'],
2776
+ type: 'object',
2777
+ properties: {
2778
+ type: {
2779
+ type: 'string',
2780
+ enum: ['NONE', 'RFC_TLSA', 'W3C_DID'],
2781
+ },
2782
+ key: {
2783
+ type: 'string',
2784
+ },
2785
+ value: {
2786
+ type: 'string',
2787
+ },
2788
+ },
2789
+ };