Skip to content

Commit 7e3fab1

Browse files
authored
add X-Correlator to simple_edge_discovery.yaml
Adds X-Correlator (fix to issue 202, wrongly omitted from previous commit)
1 parent 4c12a5c commit 7e3fab1

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

code/API_definitions/Discovery/simple_edge_discovery.yaml

+59
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,19 @@ paths:
245245
prefixed with '+'.
246246
schema:
247247
$ref: "#/components/schemas/PhoneNumber"
248+
249+
- name: X-Correlator
250+
in: header
251+
required: false
252+
description: |
253+
When the API Consumer includes the "X-Correlator" header in the
254+
request, the API provider must include it in the response with
255+
the same value that was used in the request. Otherwise, it is
256+
optional to include the "X-Correlator" header in the response with
257+
any valid value. Recommendation is to use UUID for values.
258+
schema:
259+
type: string
260+
format: uuid
248261

249262
responses:
250263
"200":
@@ -293,6 +306,19 @@ components:
293306
description: OpenID Provider Configuration Information.
294307
type: openIdConnect
295308
openIdConnectUrl: .well-known/openid-configuration
309+
310+
headers:
311+
X-Correlator:
312+
description: |
313+
When the API Consumer includes the "X-Correlator" header in the request,
314+
the API provider must include it in the response with the same value t
315+
hat was used in the request. Otherwise, it is optional to include the
316+
"X-Correlator" header in the response with any valid value.
317+
Recommendation is to use UUID for values.
318+
required: false
319+
schema:
320+
type: string
321+
format: uuid
296322

297323
schemas:
298324
EdgeCloudZones:
@@ -387,6 +413,9 @@ components:
387413
responses:
388414
400BadRequest:
389415
description: Bad Request
416+
headers:
417+
X-Correlator:
418+
$ref: "#/components/headers/X-Correlator"
390419
content:
391420
application/json:
392421
schema:
@@ -433,6 +462,9 @@ components:
433462
}
434463
401Unauthorized:
435464
description: Unauthorized
465+
headers:
466+
X-Correlator:
467+
$ref: "#/components/headers/X-Correlator"
436468
content:
437469
application/json:
438470
schema:
@@ -449,6 +481,9 @@ components:
449481

450482
403Forbidden:
451483
description: Forbidden
484+
headers:
485+
X-Correlator:
486+
$ref: "#/components/headers/X-Correlator"
452487
content:
453488
application/json:
454489
schema:
@@ -465,6 +500,9 @@ components:
465500

466501
404NotFound:
467502
description: Subscriber Not Found
503+
headers:
504+
X-Correlator:
505+
$ref: "#/components/headers/X-Correlator"
468506
content:
469507
application/json:
470508
schema:
@@ -483,6 +521,9 @@ components:
483521

484522
405MethodNotAllowed:
485523
description: Method Not Allowed
524+
headers:
525+
X-Correlator:
526+
$ref: "#/components/headers/X-Correlator"
486527
content:
487528
application/json:
488529
schema:
@@ -502,6 +543,9 @@ components:
502543

503544
406Unacceptable:
504545
description: Not Acceptable
546+
headers:
547+
X-Correlator:
548+
$ref: "#/components/headers/X-Correlator"
505549
content:
506550
application/json:
507551
schema:
@@ -519,6 +563,9 @@ components:
519563

520564
429TooManyRequests:
521565
description: Too Many Requests
566+
headers:
567+
X-Correlator:
568+
$ref: "#/components/headers/X-Correlator"
522569
content:
523570
application/json:
524571
schema:
@@ -538,6 +585,9 @@ components:
538585

539586
500InternalServerError:
540587
description: Internal Server Error
588+
headers:
589+
X-Correlator:
590+
$ref: "#/components/headers/X-Correlator"
541591
content:
542592
application/json:
543593
schema:
@@ -551,6 +601,9 @@ components:
551601

552602
502BadGateway:
553603
description: Bad Gateway
604+
headers:
605+
X-Correlator:
606+
$ref: "#/components/headers/X-Correlator"
554607
content:
555608
application/json:
556609
schema:
@@ -564,6 +617,9 @@ components:
564617

565618
503ServiceUnavailable:
566619
description: Service Unavailable
620+
headers:
621+
X-Correlator:
622+
$ref: "#/components/headers/X-Correlator"
567623
content:
568624
application/json:
569625
schema:
@@ -577,6 +633,9 @@ components:
577633

578634
504GatewayTimeout:
579635
description: Gateway Time-Out
636+
headers:
637+
X-Correlator:
638+
$ref: "#/components/headers/X-Correlator"
580639
content:
581640
application/json:
582641
schema:

0 commit comments

Comments
 (0)