This repository has been archived by the owner on May 17, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
core-metadata.yaml
2348 lines (2348 loc) · 79.2 KB
/
core-metadata.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: Edgex Foundry - Core Metadata API
description: "This is the definition of the API for the Core Metadata service in the EdgeX Foundry IOT microservice platform. Core Metadata is responsible for all information related to provisioned devices and their associated services."
version: 2.x
servers:
- url: 'http://localhost:48081/api/v2'
description: URL for local development and testing
components:
schemas:
AddAddressableRequest:
allOf:
- $ref: '#/components/schemas/CorrelatedRequest'
description: "A request to add a new addressable."
type: object
properties:
name:
type: string
protocol:
type: string
method:
type: string
address:
type: string
port:
type: integer
path:
type: string
publisher:
type: string
user:
type: string
password:
type: string
topic:
type: string
required:
- name
- protocol
- address
AddAddressableResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
description: "A response type for use in adding an Addressable. The ID of the new record will be returned to the caller. An optional message property allows for miscellaneous information to be returned."
type: object
properties:
id:
type: string
format: uuid
message:
type: string
required:
- id
AddDeviceRequest:
allOf:
- $ref: '#/components/schemas/CorrelatedRequest'
description: "A request to add a new device associated with a specific device service and conforming to a specific device profile."
type: object
properties:
deviceName:
type: string
serviceName:
type: string
profileName:
type: string
adminState:
type: string
operatingState:
type: string
autoEvents:
type: array
items:
$ref: '#/components/schemas/AutoEvent'
protocols:
type: object
additionalProperties:
$ref: '#/components/schemas/ProtocolProperties'
required:
- deviceName
- serviceName
- profileName
- protocols
AddDeviceResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
description: "A response type for use in adding a Device. The ID of the new record will be returned to the caller. An optional message property allows for miscellaneous information to be returned."
type: object
properties:
id:
type: string
format: uuid
message:
type: string
required:
- id
AddDeviceProfileRequest:
allOf:
- $ref: '#/components/schemas/CorrelatedRequest'
description: "A request to add a new device profile. When making this request, the ID property should not be populated."
type: object
properties:
profile:
$ref: '#/components/schemas/DeviceProfile'
AddDeviceProfileResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
description: "A response type for use in adding a Device Profile. The ID of the new record will be returned to the caller. An optional message property allows for miscellaneous information to be returned."
type: object
properties:
id:
type: string
format: uuid
message:
type: string
required:
- id
AddDeviceServiceRequest:
allOf:
- $ref: '#/components/schemas/CorrelatedRequest'
description: "A request to add a new DeviceService - name must be unique and the specified addressable must already exist"
type: object
properties:
deviceServiceName:
type: string
addressableName:
type: string
operatingState:
description: "Can only be set to ENABLED or DISABLED"
type: string
labels:
type: array
items:
type: string
adminState:
description: "Can only be set to LOCKED or UNLOCKED"
type: string
required:
- deviceServiceName
- addressableName
- operatingState
- adminState
AddDeviceServiceResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
description: "A response type for use in adding a Device Service. The ID of the new record will be returned to the caller. An optional message property allows for miscellaneous information to be returned."
type: object
properties:
id:
type: string
format: uuid
message:
type: string
required:
- id
AddressableResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
type: object
properties:
addressable:
$ref: '#/components/schemas/Addressable'
Addressable:
type: object
properties:
id:
type: string
format: uuid
created:
type: integer
modified:
type: integer
name:
type: string
protocol:
type: string
method:
type: string
address:
type: string
port:
type: integer
path:
type: string
publisher:
type: string
user:
type: string
password:
type: string
topic:
type: string
AutoEvent:
type: object
properties:
frequency:
type: string
onChange:
type: boolean
resource:
type: string
Command:
type: object
properties:
created:
type: integer
modified:
type: integer
id:
type: string
format: uuid
name:
type: string
get:
$ref: '#/components/schemas/CommandAction'
put:
$ref: '#/components/schemas/CommandAction'
CommandAction:
type: object
properties:
path:
type: string
responses:
type: array
items:
$ref: '#/components/schemas/CommandResponse'
url:
type: string
CommandResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
description: "In the context of a device profile, defines an expected response from a command issued to a device via the core-command service."
type: object
properties:
code:
type: string
description:
type: string
expectedValues:
type: array
items:
type: string
CorrelatedRequest:
description: "Provides a correlation ID that can be used when grouping multiple requests into a single batch. For example, multiple devices can be posted at once. Each AddDeviceRequest has its own request identifier while the batch has an overall identifier. This allows for visibility into whether or not a response was obtained for every request in the batch."
type: object
properties:
correlationId:
description: "Identifies the batch to which this request belongs. If used via REST, this value should be the same as that of the ''X-Correlation-ID'' HTTP header."
type: string
format: uuid
example: "82eb2e26-0f24-48aa-ae4c-de9dac3fb9bc"
requestId:
description: "Uniquely identifies this request apart from its peers in the batch. For implementation, recommend this value be generated by the type's constructor."
type: string
format: uuid
example: "e6e8a2f4-eb14-4649-9e2b-175247911369"
required:
- correlationId
- requestId
CorrelatedResponse:
description: "Provides a correlation ID that can be used when grouping multiple responses into a single batch. For example, multiple devices can be posted at once. The responses can be returned as a batch or individually. It doesn't matter as long as both of these properties are correctly set because either way the caller will have visibility into whether or not a response was obtained for every request in the batch."
type: object
properties:
correlationId:
description: "Identifies the batch to which this response belongs. If used via REST, this value should be the same as that of the ''X-Correlation-ID'' HTTP header."
type: string
format: uuid
example: "82eb2e26-0f24-48aa-ae4c-de9dac3fb9bc"
requestId:
description: "Uniquely identifies the request within the larger batch resulting in this response."
type: string
format: uuid
example: "e6e8a2f4-eb14-4649-9e2b-175247911369"
statusCode:
description: "A numeric code signifying the operational status of the response."
type: integer
message:
description: "A field that can contain a free-form message, such as an error message."
type: string
required:
- correlationId
- requestId
Device:
type: object
properties:
id:
type: string
format: uuid
created:
type: integer
modified:
type: integer
name:
type: string
description:
type: string
adminState:
type: string
operatingState:
type: string
addressableId:
type: string
addressableName:
type: string
lastConnected:
type: integer
lastReported:
type: integer
labels:
type: array
items:
type: string
location:
type: object
serviceId:
type: string
serviceName:
type: string
profileId:
type: string
profileName:
type: string
autoEvents:
type: array
items:
$ref: '#/components/schemas/AutoEvent'
protocols:
type: object
additionalProperties:
$ref: '#/components/schemas/ProtocolProperties'
DeviceProfile:
description: "A profile defining a class of device to be onboarded, including its capabilities and data format."
type: object
properties:
created:
type: integer
modified:
type: integer
description:
type: string
id:
type: string
format: uuid
name:
type: string
manufacturer:
type: string
model:
type: string
labels:
type: array
items:
type: string
deviceResources:
type: array
items:
$ref: '#/components/schemas/DeviceResource'
deviceCommands:
type: array
items:
$ref: '#/components/schemas/ProfileResource'
coreCommands:
type: array
items:
$ref: '#/components/schemas/Command'
DeviceProfileResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
type: object
properties:
profile:
$ref: '#/components/schemas/DeviceProfile'
DeviceResource:
description: "DeviceResource represents a value on a device that can be read or written."
type: object
properties:
description:
type: string
name:
type: string
tag:
type: string
properties:
$ref: '#/components/schemas/ProfileProperty'
attributes:
type: object
additionalProperties:
type: string
DeviceResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
type: object
properties:
device:
$ref: '#/components/schemas/Device'
DeviceService:
description: "A DeviceService is responsible for proxying connectivity between a set of devices and the EdgeX Foundry core services."
type: object
properties:
created:
type: integer
modified:
type: integer
description:
type: string
id:
type: string
format: uuid
name:
type: string
lastConnected:
type: integer
lastReported:
type: integer
operatingState:
type: string
labels:
type: array
items:
type: string
addressable:
$ref: '#/components/schemas/Addressable'
adminState:
type: string
DeviceServiceResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
type: object
properties:
service:
$ref: '#/components/schemas/DeviceService'
PingResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
type: object
properties:
timestamp:
description: "Outputs the current server timestamp in RFC1123 format"
example: "Mon, 02 Jan 2006 15:04:05 MST"
type: string
ProfileProperty:
description: "A property defining the data type of a device's reading"
type: object
properties:
value:
$ref: '#/components/schemas/PropertyValue'
units:
$ref: '#/components/schemas/Units'
ProfileResource:
description: "Defines read/write capabilities native to the device"
type: object
properties:
name:
type: string
get:
type: array
items:
$ref: '#/components/schemas/ResourceOperation'
set:
type: array
items:
$ref: '#/components/schemas/ResourceOperation'
PropertyValue:
description: "Defines constraints with regard to the range of acceptable values assigned to an event reading and defined as a property within a device profile."
type: object
properties:
type:
type: string
readWrite:
type: string
minimum:
type: string
maximum:
type: string
defaultValue:
type: string
size:
type: string
mask:
type: string
shift:
type: string
scale:
type: string
offset:
type: string
base:
type: string
assertion:
type: string
precision:
type: string
floatEncoding:
type: string
mediaType:
type: string
ProtocolProperties:
type: object
additionalProperties:
type: string
ResourceOperation:
description: "Defines an operation of which a device is capable."
type: object
properties:
index:
type: string
operation:
type: string
object:
type: string
deviceResource:
type: string
parameter:
type: string
resource:
type: string
deviceCommand:
type: string
secondary:
type: array
items:
type: string
mappings:
type: object
additionalProperties:
type: string
RequestEnvelope:
description: "A wrapper type for use when sending a request to the /batch endpoint. Each individual request type in the HTTP request should be wrapped in an envelope to facilitate instantiation of the correct routing handler. See property descriptions below for more details."
type: object
properties:
action:
type: string
description: "Indicates the type of operation applicable to the wrapped request. Valid values are 'create','read','update','delete', and 'command'"
content:
type: string
format: byte
description: "A byte array containing a marshalled request type instance. This is the specific, semantically identifiable request -- such as an AddDeviceRequest."
strategy:
type: string
description: "Indicates the expectation of whether a response should be produced synchronously or asynchronously. If asynchronously, desire for either a polling or push/callback should be provided. Valid values are 'sync','async-push','async-poll'"
type:
type: string
description: "The name of the type applicable to the request instance contained in the 'content' property."
version:
description: "Proposed field for explicitly defining version of request DTO. This is for advertising compatibility between a publisher/subscriber or requester/receiver"
type: string
example: "2.0.x"
required:
- action
- content
- strategy
- type
- version
ResponseEnvelope:
description: "A wrapper type for use when receiving a response from the /batch endpoint. Each individual response type in the HTTP response should be wrapped in an envelope to facilitate unmarshalling by the client. See property descriptions below for more details."
type: object
properties:
action:
type: string
description: "Indicates the type of operation applicable to the wrapped response. This should be recapitulated from the originating request. Valid values are 'create','read','update','delete', and 'command'"
content:
type: string
format: byte
description: "A byte array containing a marshalled response type instance. This is the specific, semantically identifiable response -- such as an AddDeviceResponse."
strategy:
type: string
description: "Recapitulates the expectation with regard to the delivery of response that was specified on the originating request. Valid values are 'sync','async-push','async-poll'"
type:
type: string
description: "The name of the type applicable to the response instance contained in the 'content' property."
version:
description: "Proposed field for explicitly defining version of response DTO. This is for advertising compatibility between a publisher/subscriber or requester/receiver"
type: string
example: "2.0.x"
required:
- action
- content
- strategy
- type
- version
Units:
type: object
properties:
type:
type: string
readWrite:
type: string
defaultValue:
type: string
UpdateAddressableRequest:
allOf:
- $ref: '#/components/schemas/CorrelatedRequest'
description: "A request to update an existing addressable definition. 'id' and 'name' must be populated in order to identify the addressable. Any other property that is populated in the request will be updated. Empty/blank properties will not be considered."
type: object
properties:
id:
type: string
format: uuid
name:
type: string
protocol:
type: string
method:
type: string
address:
type: string
port:
type: integer
path:
type: string
publisher:
type: string
user:
type: string
password:
type: string
topic:
type: string
required:
- id
- name
UpdateAddressableResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
description: "A response type for use in updating an Addressable. The ID of the affected record will be returned to the caller."
type: object
properties:
id:
type: string
format: uuid
required:
- id
UpdateDeviceRequest:
allOf:
- $ref: '#/components/schemas/CorrelatedRequest'
description: "A request to update an existing device definition. 'id' and 'deviceName' must be populated in order to identify the device. If the 'notify' property is set to true, the device service managing the device will receive a notification. Any other property that is populated in the request will be updated. Empty/blank properties will not be considered."
type: object
properties:
adminState:
type: string
autoEvents:
type: array
items:
$ref: '#/components/schemas/AutoEvent'
deviceName:
type: string
id:
type: string
format: uuid
lastConnected:
type: integer
lastReported:
type: integer
notify:
type: boolean
operatingState:
type: string
profileName:
type: string
protocols:
type: object
additionalProperties:
$ref: '#/components/schemas/ProtocolProperties'
serviceName:
type: string
required:
- id
- deviceName
UpdateDeviceResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
description: "A response type for use in updating the state of a device. The ID of the affected record will be returned to the caller."
type: object
properties:
id:
type: string
format: uuid
required:
- id
UpdateDeviceProfileRequest:
allOf:
- $ref: '#/components/schemas/CorrelatedRequest'
description: "A request to update an existing device profile definition. 'id' and 'name' must be populated in order to identify the profile. Any other property that is populated in the request will be updated. Empty/blank properties will not be considered."
type: object
properties:
profile:
$ref: '#/components/schemas/DeviceProfile'
UpdateDeviceProfileResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
description: "A response type for use in updating a device profile. The ID of the affected record will be returned to the caller."
type: object
properties:
id:
type: string
format: uuid
required:
- id
UpdateDeviceServiceRequest:
allOf:
- $ref: '#/components/schemas/CorrelatedRequest'
description: "A request to update an existing device service definition. 'id' and 'deviceServiceName' must be populated in order to identify the service. Any other property that is populated in the request will be updated. Empty/blank properties will not be considered."
type: object
properties:
addressableName:
type: string
adminState:
description: "Can only be set to LOCKED or UNLOCKED"
type: string
deviceServiceName:
type: string
id:
type: string
format: uuid
labels:
type: array
items:
type: string
operatingState:
description: "Can only be set to ENABLED or DISABLED"
type: string
required:
- id
- deviceServiceName
UpdateDeviceServiceResponse:
allOf:
- $ref: '#/components/schemas/CorrelatedResponse'
description: "A response type for use in updating a device service. The ID of the affected record will be returned to the caller."
type: object
properties:
id:
type: string
format: uuid
required:
- id
parameters:
offsetParam:
in: query
name: offset
required: false
schema:
type: integer
minimum: 0
description: "The number of items to skip before starting to collect the result set."
limitParam:
in: query
name: limit
required: false
schema:
type: integer
minimum: 1
maximum: 50
default: 20
description: "The numbers of items to return."
correlatedRequestHeader:
in: header
name: X-Correlation-ID
description: "A unique identifier correlating a request to its associated response, facilitating tracing through being included on requests originating from the initiating request."
schema:
type: string
format: uuid
required: true
example: "14a42ea6-c394-41c3-8bcd-a29b9f5e6835"
labelsParam:
in: query
name: labels
required: false
schema:
type: string
description: "Allows for querying a given object by associated user-defined label. More than one label may be specified via a comma-delimited list."
headers:
correlatedResponseHeader:
description: "A response header that returns the unique correlation ID used to initiate the request."
schema:
type: string
format: uuid
required: true
example: "14a42ea6-c394-41c3-8bcd-a29b9f5e6835"
paths:
/addressable:
parameters:
- $ref: '#/components/parameters/correlatedRequestHeader'
post:
summary: "Allows definition of new addressables"
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AddAddressableRequest'
responses:
'207':
description: "Indicates a multi-part response supportive of accepting multiple requests at once. The 'statusCode' property of each response in the returned array will indicate success or failure."
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AddAddressableResponse'
patch:
summary: "Allows updates to an existing addressable"
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UpdateAddressableRequest'
responses:
'207':
description: "Indicates a multi-part response supportive of accepting multiple requests at once. The 'statusCode' property of each response in the returned array will indicate success or failure."
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UpdateAddressableResponse'
/addressable/all:
parameters:
- $ref: '#/components/parameters/correlatedRequestHeader'
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
get:
summary: "Given the entire range of addressables sorted by last modified descending, returns a portion of that range according to the offset and limit parameters."
responses:
'200':
description: "OK"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AddressableResponse'
'500':
description: "An unexpected error occurred on the server"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AddressableResponse'
/addressable/host/{host}:
parameters:
- $ref: '#/components/parameters/correlatedRequestHeader'
- name: host
in: path
required: true
schema:
type: string
description: "The hostname or IP address of the addressable you wish to load."
get:
summary: "Returns an addressable by its host"
responses:
'200':
description: "OK"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
$ref: '#/components/schemas/Addressable'
'404':
description: "The requested resource does not exist"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
$ref: '#/components/schemas/AddressableResponse'
'500':
description: "An unexpected error occurred on the server"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
$ref: '#/components/schemas/AddressableResponse'
/addressable/id/{id}:
parameters:
- $ref: '#/components/parameters/correlatedRequestHeader'
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: "An ID of datatype string, by default a GUID."
get:
summary: "Returns an addressable by ID"
responses:
'200':
description: "OK"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
$ref: '#/components/schemas/AddressableResponse'
'404':
description: "The requested resource does not exist"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
$ref: '#/components/schemas/AddressableResponse'
'500':
description: "An unexpected error occurred on the server"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
$ref: '#/components/schemas/AddressableResponse'
delete:
summary: "Delete an addressable by ID"
responses:
'204':
description: "Delete successful"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
'400':
description: "Request is in an invalid state"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
$ref: '#/components/schemas/AddressableResponse'
'500':
description: "An unexpected error occurred on the server"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
$ref: '#/components/schemas/AddressableResponse'
/addressable/name/{name}:
parameters:
- $ref: '#/components/parameters/correlatedRequestHeader'
- name: name
in: path
required: true
schema:
type: string
description: "The name of the addressable you wish to load, datatype string."
get:
summary: "Returns an addressable by name"
responses:
'200':
description: "OK"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
$ref: '#/components/schemas/AddressableResponse'
'404':
description: "The requested resource does not exist"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
$ref: '#/components/schemas/AddressableResponse'
'500':
description: "An unexpected error occurred on the server"
headers:
X-Correlation-ID:
$ref: '#/components/headers/correlatedResponseHeader'
content:
application/json:
schema:
$ref: '#/components/schemas/AddressableResponse'
delete: