Skip to content
GitLab
Commit f4317ace authored by piscione's avatar piscione
Browse files

First draft of OAS3.1.0 added.

parent 7ee34e1a
Pipeline #9723 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
OAS3.1.0/MEC021_AppMobilityService.yaml-OpenApi31Yaml.yaml 0 → 100644
View file @ f4317ace
openapi: 3.1.0
info:
title: ETSI GS MEC 021 Application Mobility Service API
description: ETSI GS MEC 021 Application Mobility Service API described using OpenAPI.
contact:
name: ETSI Forge
url: https://forge.etsi.org/rep/mec/gs021-amsi-api
email: cti_support@etsi.org
version: '2.1.1'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
servers:
- url: https://localhost/amsi/v1
variables: {}
paths:
/queries/adjacent_app_instances:
get:
tags:
- adj-app-inst
summary: adj_app_instGET
description: Retrieve information about this subscription.
operationId: adj_app_instGET
parameters:
- name: filter
in: query
description: Attribute-based filtering parameters according to ETSI GS MEC 011
style: form
explode: true
schema:
type: string
- name: all_fields
in: query
description: Include all complex attributes in the response.
style: form
explode: true
schema:
type: string
- name: fields
in: query
description: Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 011
style: form
explode: true
schema:
type: string
- name: exclude_fields
in: query
description: Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 011
style: form
explode: true
schema:
type: string
- name: exclude_default
in: query
description: Indicates to exclude the following complex attributes from the response See clause 6.18 in ETSI GS MEC 011 for details.
style: form
explode: true
schema:
type: string
responses:
'200':
description: A response body containing zero or more adjacent application instances
headers: {}
content:
application/json:
schema:
minItems: 0
type: array
items:
$ref: '#/components/schemas/AdjacentAppInstanceInfo'
description: ''
contentMediaType: application/json
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_mobility_services:
get:
tags:
- app-mob-ser
summary: app_mobility_serviceGET
description: ' Retrieve information about the registered application mobility service.'
operationId: app_mobility_serviceGET
parameters:
- name: filter
in: query
description: Attribute-based filtering parameters according to ETSI GS MEC 011
style: form
explode: true
schema:
type: string
- name: all_fields
in: query
description: Include all complex attributes in the response.
style: form
explode: true
schema:
type: string
- name: fields
in: query
description: Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 011
style: form
explode: true
schema:
type: string
- name: exclude_fields
in: query
description: Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 011
style: form
explode: true
schema:
type: string
- name: exclude_default
in: query
description: Indicates to exclude the following complex attributes from the response See clause 6.18 in ETSI GS MEC 011 for details.
style: form
explode: true
schema:
type: string
responses:
'200':
description: Contains in an array the representations of zero or more application mobility services.
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RegistrationInfo'
description: ''
contentMediaType: application/json
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
post:
tags:
- app-mob-ser
summary: app_mobility_servicePOST
description: Create a new application mobility service for the service requester.
operationId: app_mobility_servicePOST
parameters: []
requestBody:
description: Application mobility service to be created
content:
application/json:
schema:
$ref: '#/components/schemas/RegistrationInfo'
required: true
responses:
'201':
description: Successful response for application mobility service creation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RegistrationInfo'
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_mobility_services/{appMobilityServiceId}:
get:
tags:
- app-mob-ser
summary: app_mobility_service_by_idGET
description: Retrieve information about this individual application mobility service
operationId: app_mobility_service_by_idGET
parameters:
- name: appMobilityServiceId
in: path
description: It uniquely identifies the created individual application mobility service
required: true
style: simple
schema:
type: string
responses:
'200':
description: Contains a representation of the application mobility service.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RegistrationInfo'
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- app-mob-ser
summary: app_mobility_service_by_idPUT
description: ' update the existing individual application mobility service'
operationId: app_mobility_service_by_idPUT
parameters:
- name: appMobilityServiceId
in: path
description: It uniquely identifies the created individual application mobility service
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RegistrationInfo'
required: true
responses:
'200':
description: Contains a data type describing the updated application mobility service.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RegistrationInfo'
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'412':
description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'422':
description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
delete:
tags:
- app-mob-ser
summary: app_mobility_service_by_idDELETE
description: ' deregister the individual application mobility service'
operationId: app_mobility_service_by_idDELETE
parameters:
- name: appMobilityServiceId
in: path
description: It uniquely identifies the created individual application mobility service
required: true
style: simple
schema:
type: string
responses:
'204':
description: No Content
headers: {}
content: {}
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_mobility_services/{appMobilityServiceId}/deregister_task:
post:
tags:
- app-mob-ser-der
summary: app_mobility_service_derPOST
description: ' deregister the individual application mobility service'
operationId: app_mobility_service_derPOST
parameters:
- name: appMobilityServiceId
in: path
description: It uniquely identifies the created individual application mobility service
required: true
style: simple
schema:
type: string
responses:
'204':
description: No Content
headers: {}
content: {}
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/subscriptions/:
get:
tags:
- subscriptions
summary: subGET
description: Retrieve information about the subscriptions for this requestor.
operationId: subGET
parameters:
- name: subscriptionType
in: query
description: 'Query parameter to filter on a specific subscription type. Permitted values: mobility_proc or adj_app_info'
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: Contains the list of links to requestor subscriptions.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionLinkList'
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content: