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

Jump to bottom

Simple Edge Discovery 1.0.0 #228

Merged
merged 3 commits into from
May 1, 2024
Merged

Simple Edge Discovery 1.0.0 #228

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c12a5c
Update simple_edge_discovery.yaml
Kevsy Apr 17, 2024
7e3fab1
add X-Correlator to simple_edge_discovery.yaml
Kevsy Apr 22, 2024
ed32560
corrected scope to align with Commonalities
Kevsy Apr 30, 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
66 changes: 62 additions & 4 deletions code/API_definitions/Discovery/simple_edge_discovery.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
openapi: 3.0.3
info:
title: Simple Edge Discovery API
version: 0.9.4-rc.1
version: 1.0.0
description: |
# Find the closest Edge Cloud Zone
---
Expand Down Expand Up @@ -149,8 +149,7 @@

CAMARA guidelines defines a set of authorization flows which can grant API
clients access to the API functionality, as outlined in the document
[CAMARA-API-access-and-user-consent.md]
(https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-API-access-and-user-consent.md).
[CAMARA-API-access-and-user-consent.md](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-API-access-and-user-consent.md).
Which specific authorization flows are to be used will be determined during
onboarding process, happening between the API Client and the Telco Operator
exposing the API, taking into account the declared purpose for accessing
Expand Down Expand Up @@ -183,7 +182,7 @@
default: https://localhost:443
description: API root.
basePath:
default: simple-edge-discovery/v0
default: simple-edge-discovery/v1
description: Base path for the Simple Edge Discovery API.

tags:
Expand Down Expand Up @@ -246,6 +245,19 @@
prefixed with '+'.
schema:
$ref: "#/components/schemas/PhoneNumber"

- name: X-Correlator
in: header
required: false
description: |
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
any valid value. Recommendation is to use UUID for values.
schema:
type: string
format: uuid

responses:
"200":
Expand Down Expand Up @@ -294,6 +306,19 @@
description: OpenID Provider Configuration Information.
type: openIdConnect
openIdConnectUrl: .well-known/openid-configuration

headers:
X-Correlator:
description: |
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.
Recommendation is to use UUID for values.
required: false
schema:
type: string
format: uuid

schemas:
EdgeCloudZones:
Expand Down Expand Up @@ -382,12 +407,15 @@
example: 2001:db8:85a3:8d3:1319:8a2e:370:7344


###################################

Check warning on line 410 in code/API_definitions/Discovery/simple_edge_discovery.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter 

410:1 [comments-indentation] comment not indented like content
# RESPONSES
####################################
responses:
400BadRequest:
description: Bad Request
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
content:
application/json:
schema:
Expand Down Expand Up @@ -434,6 +462,9 @@
}
401Unauthorized:
description: Unauthorized
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
content:
application/json:
schema:
Expand All @@ -450,6 +481,9 @@

403Forbidden:
description: Forbidden
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
content:
application/json:
schema:
Expand All @@ -466,6 +500,9 @@

404NotFound:
description: Subscriber Not Found
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
content:
application/json:
schema:
Expand All @@ -484,6 +521,9 @@

405MethodNotAllowed:
description: Method Not Allowed
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
content:
application/json:
schema:
Expand All @@ -503,6 +543,9 @@

406Unacceptable:
description: Not Acceptable
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
content:
application/json:
schema:
Expand All @@ -520,6 +563,9 @@

429TooManyRequests:
description: Too Many Requests
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
content:
application/json:
schema:
Expand All @@ -539,6 +585,9 @@

500InternalServerError:
description: Internal Server Error
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
content:
application/json:
schema:
Expand All @@ -552,6 +601,9 @@

502BadGateway:
description: Bad Gateway
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
content:
application/json:
schema:
Expand All @@ -565,6 +617,9 @@

503ServiceUnavailable:
description: Service Unavailable
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
content:
application/json:
schema:
Expand All @@ -578,6 +633,9 @@

504GatewayTimeout:
description: Gateway Time-Out
headers:
X-Correlator:
$ref: "#/components/headers/X-Correlator"
content:
application/json:
schema:
Expand Down
Loading