Datasets:

GSMA
/

camara

	---
	openapi: 3.0.3
	info:
	title: Application Endpoints Registration
	version: wip
	x-camara-commonalities: 0.6
	description: \|
	The Application Endpoints Registration API provides a programmable
	interface for developers to register the endpoints of an application
	which is deployed across various Edge Cloud Zones.
	It allows developers to retrieve, update, and delete those registrations.

	# Introduction

	The API registers the Application Endpoints.
	This information can be used for various use cases like optimal endpoint
	discovery to help end users connect to the most optimal instance of the
	application which is distributed across various Edge Cloud Zones.
	Additionally the information can be used to monitor the edge instances to
	take decisions from a lifecycle management perspective. The API provides
	the ability to register, read and manage the deployed edge instances of
	the application.

	# Relevant terms and definitions

	* Application Endpoint:

	The Endpoint on which the application is accessible.
	It can be a FQDN, IPv4, or IPv6 address with a port number.

	* Application Profile:

	It represents the application's network and
	compute characteristics. This helps distinguish between different
	applications and their specific requirements.

	* Edge Cloud Zone:

	Availability Zone in an Edge Cloud. It is the lowest
	level of abstraction exposed to an Application Provider who wants to
	deploy an Application on Edge Cloud. Availability Zones exist within
	a Region.

	# API functionality

	The API provides the following operations:
	- POST registerApplicationEndpoints: Registers the Application Endpoints
	of a deployed application to a specified edge cloud zone.
	- GET getAllRegisteredApplicationEndpoints: Returns endpoint information for
	all registered Applications.
	- GET getApplicationEndpointsByID: Returns endpoint information for all
	Applications registered to a specified applicationEndpointListId.
	- PUT updateApplicationEndpoint: Update registered application endpoint
	information.
	- DELETE deregisterApplicationEndpoint: Deregister an application's
	Endpoints.
	## Errors

	- If the API call contains a formatting or any other syntactic error,
	a `400 INVALID_ARGUMENT` error is returned.
	- If the API call cannot be authenticated due to missing, invalid, or
	expired credentials, a `401 UNAUTHENTICATED` error is returned.
	- If the API call has a valid access token that does not have the
	required scope, then a `403 PERMISSION_DENIED` error is returned.
	- If the API call has an `applicationEndpointListId` that does not identify
	any registered endpoint on the Edge Cloud, a `404 NOT_FOUND` error
	is returned.

	### Additional CAMARA error responses

	The list of error codes in this API specification is not exhaustive.
	Therefore the API specification may not document some non-mandatory error
	statuses as indicated in `CAMARA API Design Guide`.

	Please refer to the `CAMARA_common.yaml` of the Commonalities Release
	associated to this API version for a complete list of error responses.
	The applicable Commonalities Release can be identified in the `API
	Readiness Checklist` document associated to this API version.

	As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible
	error response if it is explicitly documented in the API.

	# Authorization and authentication

	The "Camara Security and Interoperability Profile" provides details of how
	an API consumer requests an access token. Please refer to
	Identity and Consent Management
	(https://github.com/camaraproject/IdentityAndConsentManagement/)
	for the released version of the profile.

	The specific authorization flows to be used will be agreed upon during the
	onboarding process, happening between the API consumer and the
	API provider, taking into account the declared purpose for accessing the
	API, whilst also being subject to the prevailing legal framework dictated
	by local legislation.

	In cases where personal data is processed by the API and users can exercise
	their rights through mechanisms such as opt-in and/or opt-out, the use of
	three-legged access tokens is mandatory. This ensures that the API remains
	in compliance with privacy regulations, upholding the principles of
	transparency and user-centric privacy-by-design.

	# Further info and support

	[GSMA Mobile Connect Account Takeover Protection specification]
	(https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-
	Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-
	v2.0.pdf)
	was used as source of input for this API. For more about Mobile Connect,
	please see [Mobile Connect website](https://mobileconnect.io/).

	(FAQs will be added in a later version of the documentation)

	license:
	name: Apache 2.0
	url: https://www.apache.org/licenses/LICENSE-2.0.html
	externalDocs:
	description: Project documentation at CAMARA
	url: https://github.com/camaraproject/ApplicationEndpointRegistration

	servers:
	- url: "{apiRoot}/application-endpoint-registration/vwip"
	variables:
	apiRoot:
	default: http://localhost:9091
	description: \|
	API root, defined by service provider, e.g.
	`api.example.com` or `api.example.com/somepath`

	tags:
	- name: Application Endpoint Registration
	description: \|
	Operations to register, read and manage deployed instances of the
	application.

	paths:
	/application-endpoint-lists:
	post:
	security:
	- openId:
	- application-endpoint-registration:application-endpoints:write
	tags:
	- Application Endpoint Registration
	summary: Register endpoints of a deployed application
	description: \|
	Register the endpoints of a deployed application
	to a specified edge cloud zone.
	operationId: registerApplicationEndpoints
	parameters:
	- $ref: "#/components/parameters/x-correlator"
	requestBody:
	description: Array of Application Endpoints for an
	application deployed across various Edge Cloud Zones.
	required: true
	content:
	application/json:
	schema:
	$ref: "#/components/schemas/ApplicationEndpointsInfo"
	responses:
	"200":
	description: Returns an applicationEndpointListId
	headers:
	x-correlator:
	$ref: '#/components/headers/x-correlator'
	content:
	application/json:
	schema:
	$ref: "#/components/schemas/ApplicationEndpointListId"
	"400":
	$ref: "#/components/responses/Generic400"
	"401":
	$ref: "#/components/responses/Generic401"
	"403":
	$ref: "#/components/responses/Generic403"
	"404":
	$ref: "#/components/responses/Generic404"
	"422":
	$ref: "#/components/responses/Generic422"
	"429":
	$ref: "#/components/responses/Generic429"
	get:
	security:
	- openId:
	- application-endpoint-registration:application-endpoints:read
	tags:
	- Application Endpoint Registration
	summary: Get all registered edge application endpoint information
	description: \|
	Returns endpoint information for all
	registered Applications.
	operationId: getAllRegisteredApplicationEndpoints
	parameters:
	- $ref: "#/components/parameters/x-correlator"
	responses:
	"200":
	description: Array of registered Application Endpoints
	headers:
	x-correlator:
	$ref: '#/components/headers/x-correlator'
	content:
	application/json:
	schema:
	type: array
	items:
	$ref: "#/components/schemas/ApplicationEndpointList"
	"400":
	$ref: "#/components/responses/Generic400"
	"401":
	$ref: "#/components/responses/Generic401"
	"403":
	$ref: "#/components/responses/Generic403"
	"404":
	$ref: "#/components/responses/Generic404"
	"422":
	$ref: "#/components/responses/Generic422"
	"429":
	$ref: "#/components/responses/Generic429"

	"/application-endpoint-lists/{applicationEndpointListId}":
	parameters:
	- name: applicationEndpointListId
	in: path
	description: The unique identifier for the application endpoints
	that got created when registering the application endpoints.
	required: true
	schema:
	$ref: "#/components/schemas/ApplicationEndpointListId"
	- $ref: "#/components/parameters/x-correlator"
	get:
	security:
	- openId:
	- application-endpoint-registration:application-endpoints:read
	tags:
	- Application Endpoint Registration
	summary: Get registered edge application endpoint information
	description: \|
	Returns endpoint information of the application based on
	applicationEndpointListId.
	operationId: getApplicationEndpointsById
	responses:
	"200":
	description: Application Endpoint information based on
	given ApplicationEndpointListID
	headers:
	x-correlator:
	$ref: '#/components/headers/x-correlator'
	content:
	application/json:
	schema:
	$ref: "#/components/schemas/ApplicationEndpointList"
	"400":
	$ref: "#/components/responses/Generic400"
	"401":
	$ref: "#/components/responses/Generic401"
	"403":
	$ref: "#/components/responses/Generic403"
	"404":
	$ref: "#/components/responses/Generic404"
	"422":
	$ref: "#/components/responses/Generic422"
	"429":
	$ref: "#/components/responses/Generic429"

	put:
	security:
	- openId:
	- application-endpoint-registration:application-endpoints:update
	tags:
	- Application Endpoint Registration
	summary: Update an application Endpoint
	description: \|
	Update registered application Endpoint information.
	operationId: updateApplicationEndpoint
	requestBody:
	description: Application Endpoint information
	required: true
	content:
	application/json:
	schema:
	$ref: "#/components/schemas/ApplicationEndpointsInfo"
	responses:
	"204":
	description: Updates Application Endpoint Information
	headers:
	x-correlator:
	$ref: '#/components/headers/x-correlator'
	"400":
	$ref: "#/components/responses/Generic400"
	"401":
	$ref: "#/components/responses/Generic401"
	"403":
	$ref: "#/components/responses/Generic403"
	"404":
	$ref: "#/components/responses/Generic404"
	"422":
	$ref: "#/components/responses/Generic422"
	"429":
	$ref: "#/components/responses/Generic429"

	delete:
	security:
	- openId:
	- application-endpoint-registration:application-endpoints:delete
	tags:
	- Application Endpoint Registration
	summary: Deregister an application Endpoint
	description: \|
	Deregister an application's
	Endpoint from the edge cloud zone.
	operationId: deregisterApplicationEndpoint
	responses:
	"204":
	description: Deregister Application Endpoint
	headers:
	x-correlator:
	$ref: '#/components/headers/x-correlator'
	"400":
	$ref: "#/components/responses/Generic400"
	"401":
	$ref: "#/components/responses/Generic401"
	"403":
	$ref: "#/components/responses/Generic403"
	"404":
	$ref: "#/components/responses/Generic404"
	"422":
	$ref: "#/components/responses/Generic422"
	"429":
	$ref: "#/components/responses/Generic429"

	components:
	securitySchemes:
	openId:
	type: openIdConnect
	description: Common security scheme for all CAMARA APIs
	openIdConnectUrl: https://example.com/.well-known/openid-configuration
	headers:
	x-correlator:
	description: Correlation id for the different services
	schema:
	$ref: "#/components/schemas/XCorrelator"
	parameters:
	x-correlator:
	name: x-correlator
	in: header
	description: Correlation id for the different services
	schema:
	$ref: "#/components/schemas/XCorrelator"
	schemas:
	XCorrelator:
	type: string
	pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
	example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"

	ApplicationEndpointsInfo:
	description: Endpoint information of the Application
	deployed across different Edge Cloud Zones.
	type: object
	properties:
	applicationEndpoints:
	type: array
	description: List of endpoints of the application deployed across
	various Edge Cloud Zones
	items:
	$ref: "#/components/schemas/ApplicationEndpoint"
	applicationProviderName:
	type: string
	description: Name of the Application Provider
	example: "AppProvider"
	applicationDescription:
	type: string
	description: Description of the application.
	example: "This is a V2X application."
	applicationProfileId:
	$ref: "#/components/schemas/ApplicationProfileId"
	required:
	- applicationEndpoints
	- applicationProviderName
	- applicationProfileId
	example:
	applicationEndpoints:
	- domainName: "app.example.com"
	port: 8080
	applicationEndpointDescription: "V2X app deployed at ZoneA"
	edgeCloudZone:
	edgeCloudZoneId: "123e4567-e89b-12d3-a456-426614174000"
	edgeCloudZoneName: "ZoneA"
	edgeCloudProvider: "ProviderA"
	edgeCloudRegion: "us-west-1"
	edgeCloudZoneStatus: "active"
	applicationProviderName: "AppProvider"
	applicationDescription: "This is a V2X application."
	applicationProfileId: "123e4567-e89b-12d3-a456-426614174000"

	ApplicationEndpointList:
	type: object
	description: \|
	List of Application endpoints information
	deployed across various cloud zones.
	required:
	- applicationEndpointListId
	- applicationEndpointsInfo
	properties:
	applicationEndpointListId:
	$ref: "#/components/schemas/ApplicationEndpointListId"
	applicationEndpointsInfo:
	$ref: "#/components/schemas/ApplicationEndpointsInfo"

	ApplicationEndpoint:
	type: object
	description: \|
	An application server IP address or FQDN with a port,
	exposed by an application instance deployed on the Edge Cloud
	Zone.
	required:
	- port
	anyOf:
	- required: [domainName]
	- required: [ipv4Address]
	- required: [ipv6Address]
	properties:
	domainName:
	$ref: "#/components/schemas/DomainName"
	ipv4Address:
	$ref: "#/components/schemas/SingleIpv4Addr"
	ipv6Address:
	$ref: "#/components/schemas/SingleIpv6Addr"
	port:
	$ref: "#/components/schemas/Port"
	edgeCloudZone:
	$ref: "#/components/schemas/EdgeCloudZone"
	applicationEndpointDescription:
	type: string
	description: Description of the application endpoint
	example: "V2X app deployed at ZoneA"

	EdgeCloudZone:
	type: object
	description: \|
	An Edge Cloud Zone, uniquely identified by a
	combination of the value of the Edge Cloud Zone Id object
	and the value of the Edge Cloud Provider
	object. This value is used to identify an Edge Cloud zone
	between Edge Clouds from different Edge Cloud Providers.
	required:
	- edgeCloudZoneId
	- edgeCloudZoneName
	- edgeCloudProvider
	properties:
	edgeCloudZoneId:
	$ref: "#/components/schemas/EdgeCloudZoneId"
	edgeCloudZoneName:
	$ref: "#/components/schemas/EdgeCloudZoneName"
	edgeCloudZoneStatus:
	$ref: "#/components/schemas/EdgeCloudZoneStatus"
	edgeCloudProvider:
	$ref: "#/components/schemas/EdgeCloudProvider"
	edgeCloudRegion:
	$ref: "#/components/schemas/EdgeCloudRegion"

	EdgeCloudZoneId:
	description: A unique identifier for the Edge Cloud Zone.
	type: string
	format: uuid
	example: "123e4567-e89b-12d3-a456-426614174000"

	EdgeCloudRegion:
	description: \|
	The EdgeCloudProvider's name for the region where the Edge Cloud
	Zone is located.
	type: string
	pattern: ^[A-Za-z0-9]([A-Za-z0-9-]{0,53}[A-Za-z0-9])?$
	example: "us-west-1"

	EdgeCloudZoneStatus:
	description: Status of the Edge Cloud Zone (default is 'unknown')
	type: string
	enum:
	- active
	- inactive
	- unknown
	default: unknown

	EdgeCloudProvider:
	description: The provider of the Edge Cloud.
	type: string
	pattern: ^[A-Za-z0-9]([A-Za-z0-9-]{0,53}[A-Za-z0-9])?$
	example: "ProviderA"

	EdgeCloudZoneName:
	description: The name of the Edge Cloud Zone.
	type: string
	pattern: ^[A-Za-z0-9]([A-Za-z0-9-]{0,53}[A-Za-z0-9])?$
	example: "ZoneA"

	ApplicationEndpointListId:
	description: \|
	A system-defined string identifier representing
	one or more registered Application Endpoints. This ID is generated
	by the system upon successful registration of an application and is
	used to reference the registered endpoints in subsequent operations.
	type: string
	format: uuid
	readOnly: true
	additionalProperties: false
	example: "98765432-e89b-12d3-a456-426614174999"

	ApplicationProfileId:
	description: \|
	A unique identifier for the application profile. This represents
	the application's network and compute characteristics.
	type: string
	format: uuid
	example: "123e4567-e89b-12d3-a456-426614174000"

	DomainName:
	type: string
	description: \|
	Application's Domain Name, which is a Fully Qualified Domain Name (FQDN).
	pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?)+$
	maxLength: 253
	minLength: 4
	example: "app.example.com"

	SingleIpv4Addr:
	description: A single IPv4 address with no subnet mask
	type: string
	format: ipv4
	example: "84.125.93.10"

	SingleIpv6Addr:
	description: \|
	Single IPv6 address with no subnet mask
	type: string
	format: ipv6
	example: 2001:db8:85a3:8d3:1319:8a2e:370:7344

	Port:
	description: \|
	TCP or UDP port number for the application endpoint.
	Valid range is 0-65535.
	type: integer
	minimum: 0
	maximum: 65535
	example: 8080

	ErrorInfo:
	description: Common schema for errors
	type: object
	required:
	- status
	- code
	- message
	properties:
	status:
	type: integer
	description: HTTP status code returned along with this error response
	code:
	type: string
	description: Code given to this error
	message:
	type: string
	description: Detailed error description
	responses:
	Generic400:
	description: Bad Request
	headers:
	x-correlator:
	$ref: "#/components/headers/x-correlator"
	content:
	application/json:
	schema:
	allOf:
	- $ref: "#/components/schemas/ErrorInfo"
	- type: object
	properties:
	status:
	enum:
	- 400
	code:
	enum:
	- INVALID_ARGUMENT
	- OUT_OF_RANGE
	examples:
	GENERIC_400_INVALID_ARGUMENT:
	description: Invalid Argument. Generic Syntax Exception
	value:
	status: 400
	code: INVALID_ARGUMENT
	message: Client specified an invalid argument,
	request body or query param.
	GENERIC_400_OUT_OF_RANGE:
	description: Out of Range. Specific Syntax Exception used when a
	given field has a pre-defined range or a invalid filter
	criteria combination is requested
	value:
	status: 400
	code: OUT_OF_RANGE
	message: Client specified an invalid range.

	Generic401:
	description: Unauthorized
	headers:
	x-correlator:
	$ref: "#/components/headers/x-correlator"
	content:
	application/json:
	schema:
	allOf:
	- $ref: "#/components/schemas/ErrorInfo"
	- type: object
	properties:
	status:
	enum:
	- 401
	code:
	enum:
	- UNAUTHENTICATED
	examples:
	GENERIC_401_UNAUTHENTICATED:
	description: Request cannot be authenticated and a new
	authentication is required
	value:
	status: 401
	code: UNAUTHENTICATED
	message: Request not authenticated due to missing, invalid,
	or expired credentials. A new authentication is required.

	Generic403:
	description: Forbidden
	headers:
	x-correlator:
	$ref: "#/components/headers/x-correlator"
	content:
	application/json:
	schema:
	allOf:
	- $ref: "#/components/schemas/ErrorInfo"
	- type: object
	properties:
	status:
	enum:
	- 403
	code:
	enum:
	- PERMISSION_DENIED
	- INVALID_TOKEN_CONTEXT
	examples:
	GENERIC_403_PERMISSION_DENIED:
	description: Permission denied. OAuth2 token access does not have
	the required scope or when the user fails operational security
	value:
	status: 403
	code: PERMISSION_DENIED
	message: Client does not have sufficient permissions
	to perform this action.
	GENERIC_403_INVALID_TOKEN_CONTEXT:
	description: Reflect some inconsistency between information in
	some field of the API and the related OAuth2 Token
	value:
	status: 403
	code: INVALID_TOKEN_CONTEXT
	message: "{{field}} is not consistent with access token."

	Generic404:
	description: Not found
	headers:
	x-correlator:
	$ref: "#/components/headers/x-correlator"
	content:
	application/json:
	schema:
	allOf:
	- $ref: "#/components/schemas/ErrorInfo"
	- type: object
	properties:
	status:
	enum:
	- 404
	code:
	enum:
	- NOT_FOUND
	examples:
	GENERIC_404_NOT_FOUND:
	description: Resource is not found
	value:
	status: 404
	code: NOT_FOUND
	message: The specified resource is not found.

	Generic422:
	description: Unprocessable Content
	headers:
	x-correlator:
	$ref: "#/components/headers/x-correlator"
	content:
	application/json:
	schema:
	allOf:
	- $ref: "#/components/schemas/ErrorInfo"
	- type: object
	properties:
	status:
	enum:
	- 422
	code:
	enum:
	- SERVICE_NOT_APPLICABLE
	- UNIDENTIFIABLE_APPLICATION_PROFILE
	examples:
	GENERIC_422_SERVICE_NOT_APPLICABLE:
	description: Service not applicable for the provided identifier.
	value:
	status: 422
	code: SERVICE_NOT_APPLICABLE
	message: Service not supported for this applicationProfileId
	UNIDENTIFIABLE_APPLICATION_PROFILE:
	description: \|
	The Application Profile is not included in the request
	and the profile information cannot be derived
	from the 3-legged access token
	value:
	status: 422
	code: UNIDENTIFIABLE_APPLICATION_PROFILE
	message: The Application Profile cannot be identified

	Generic429:
	description: Too Many Requests
	headers:
	x-correlator:
	$ref: "#/components/headers/x-correlator"
	content:
	application/json:
	schema:
	allOf:
	- $ref: "#/components/schemas/ErrorInfo"
	- type: object
	properties:
	status:
	enum:
	- 429
	code:
	enum:
	- QUOTA_EXCEEDED
	- TOO_MANY_REQUESTS
	examples:
	GENERIC_429_QUOTA_EXCEEDED:
	description: Request is rejected due to exceeding a business
	quota limit
	value:
	status: 429
	code: QUOTA_EXCEEDED
	message: Out of resource quota.
	GENERIC_429_TOO_MANY_REQUESTS:
	description: Access to the API has been temporarily blocked due to
	rate or spike arrest limits being reached
	value:
	status: 429
	code: TOO_MANY_REQUESTS
	message: Rate limit reached.