Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix x-correlator syntax #10

Merged
merged 4 commits into from
Jun 10, 2024
+328 −3,895
Merged

Fix x-correlator syntax #10

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2397d08
x-correlator fix issue 8
Kevsy Jun 7, 2024
28d0dc6
spectral fixes
Kevsy Jun 7, 2024
960751d
spectral fixes
Kevsy Jun 7, 2024
3672b22
correct .spectral.yml file
Kevsy Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 28 additions & 28 deletions code/API_definitions/simple-edge-discovery.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
Accept: application/json
Phone-Number: +441234567890
```

Check failure on line 82 in code/API_definitions/simple-edge-discovery.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter 

82:1 [trailing-spaces] trailing spaces
Example where API client is on a network-attached device:

```
Expand All @@ -87,7 +87,7 @@
Host: example.com
Accept: application/json
```

Check failure on line 90 in code/API_definitions/simple-edge-discovery.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter 

90:1 [trailing-spaces] trailing spaces
# Responses

## Success
Expand All @@ -95,7 +95,7 @@
A JSON object is returned containing an array with a single member object.
This contains identifiers for the closest Edge Cloud Zone. The HTTP status
code will be`200 OK`. An example response:

Check failure on line 98 in code/API_definitions/simple-edge-discovery.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter 

98:1 [trailing-spaces] trailing spaces
```
[
{
Expand Down Expand Up @@ -207,7 +207,7 @@
schema:
type: string
enum:
- closest

Check failure on line 210 in code/API_definitions/simple-edge-discovery.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter 

210:14 [indentation] wrong indentation: expected 14 but found 13

- name: IPv4-Address
in: header
Expand All @@ -216,7 +216,7 @@
example: "84.125.93.10"
schema:
$ref: "#/components/schemas/SingleIpv4Addr"

Check failure on line 219 in code/API_definitions/simple-edge-discovery.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter 

219:1 [trailing-spaces] trailing spaces
- name: IPv6-Address
in: header
required: false
Expand All @@ -234,7 +234,7 @@
required: false
schema:
$ref: "#/components/schemas/NetworkAccessIdentifier"

Check failure on line 237 in code/API_definitions/simple-edge-discovery.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter 

237:1 [trailing-spaces] trailing spaces
- name: Phone-Number
in: header
example: "+441234567890"
Expand All @@ -245,15 +245,15 @@
prefixed with '+'.
schema:
$ref: "#/components/schemas/PhoneNumber"

Check failure on line 248 in code/API_definitions/simple-edge-discovery.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter 

248:1 [trailing-spaces] trailing spaces
- name: X-Correlator
- name: x-correlator
in: header
required: false
description: |
When the API Consumer includes the "X-Correlator" header in the
When the API Consumer includes the "x-correlator" header in the
request, the API provider must include it in the response with
the same value that was used in the request. Otherwise, it is
optional to include the "X-Correlator" header in the response with
optional to include the "x-correlator" header in the response with
any valid value. Recommendation is to use UUID for values.
schema:
type: string
Expand Down Expand Up @@ -306,14 +306,14 @@
description: OpenID Provider Configuration Information.
type: openIdConnect
openIdConnectUrl: .well-known/openid-configuration

Check failure on line 309 in code/API_definitions/simple-edge-discovery.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter 

309:1 [trailing-spaces] trailing spaces
headers:
X-Correlator:
x-correlator:
description: |
When the API Consumer includes the "X-Correlator" header in the request,
When the API Consumer includes the "x-correlator" header in the request,
the API provider must include it in the response with the same value t
hat was used in the request. Otherwise, it is optional to include the
"X-Correlator" header in the response with any valid value.
"x-correlator" header in the response with any valid value.
Recommendation is to use UUID for values.
required: false
schema:
Expand All @@ -334,7 +334,7 @@

EdgeCloudZone:
type: object
description: |

Check failure on line 337 in code/API_definitions/simple-edge-discovery.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter 

337:20 [colons] too many spaces after colon
An Edge Cloud Zone, uniquely identified by a combination
of the value of the Edge Resource Name object and the value of the
Provider object (the name of the cloud provider or operator hosting that
Expand Down Expand Up @@ -381,7 +381,7 @@
This parameter appears when there is an error.
A human readable explanation specific to this occurrence of the
problem.

Check failure on line 384 in code/API_definitions/simple-edge-discovery.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter 

384:1 [trailing-spaces] trailing spaces
PhoneNumber:
description: A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with '+'.
type: string
Expand Down Expand Up @@ -410,8 +410,8 @@
400BadRequest:
description: Bad Request
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
Expand Down Expand Up @@ -459,8 +459,8 @@
401Unauthorized:
description: Unauthorized
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -478,8 +478,8 @@
403Forbidden:
description: Forbidden
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -497,8 +497,8 @@
404NotFound:
description: Subscriber Not Found
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -518,8 +518,8 @@
405MethodNotAllowed:
description: Method Not Allowed
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -540,8 +540,8 @@
406Unacceptable:
description: Not Acceptable
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -560,8 +560,8 @@
429TooManyRequests:
description: Too Many Requests
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -582,8 +582,8 @@
500InternalServerError:
description: Internal Server Error
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -598,8 +598,8 @@
502BadGateway:
description: Bad Gateway
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -614,8 +614,8 @@
503ServiceUnavailable:
description: Service Unavailable
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -630,8 +630,8 @@
504GatewayTimeout:
description: Gateway Time-Out
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
Expand Down