Skip to content
GitLab
Commit 31d7cf68 authored by Elian Kraja's avatar Elian Kraja
Browse files

Merge branch 'stf606-draft' into 'stf606-final' 

Stf606 draft to final

See merge request !3
parents 7ee34e1a 27e69ae2
Pipeline #9940 failed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
MEC021_AppMobilityService.json
View file @ 31d7cf68
{
"openapi": "3.1.0",
"info": {
"title": "ETSI GS MEC 021 Application Mobility Service API",
"version": "2.1.1",
......@@ -9,20 +10,21 @@
},
"contact": {
"name": "ETSI Forge",
"email": "cti_support@etsi.org",
"url": "https://forge.etsi.org/rep/mec/gs021-amsi-api"
"url": "https://forge.etsi.org/rep/mec/gs021-amsi-api",
"email": "cti_support@etsi.org"
}
},
"externalDocs": {
"description": "ETSI GS MEC 021 Application Mobility Service API, v2.1.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/021/02.01.01_60/gs_mec021v020101p.pdf"
},
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"servers": [
{
"url": "https://localhost/amsi/v1"
"url": "https://localhost/amsi/v1",
"variables": {}
}
],
"openapi": "3.0.0",
"tags": [
{
"name": "adj-app-inst",
......@@ -42,94 +44,300 @@
}
],
"paths": {
"/queries/adjacent_app_instances": {
"get": {
"tags": [
"adj-app-inst"
],
"summary": "Retrieve information about this subscription.",
"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": " Retrieve information about the registered application mobility service.",
"summary": "Retrieve information about the registered application mobility service.",
"description": " Retrieve information about the registered application mobility service.",
"operationId": "app_mobility_serviceGET",
"parameters": [
{
"in": "query",
"name": "filter",
"in": "query",
"description": "Attribute-based filtering parameters according to ETSI GS MEC 011",
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"required": false,
"description": "Attribute-based filtering parameters according to ETSI GS MEC 011"
}
},
{
"in": "query",
"name": "all_fields",
"in": "query",
"description": "Include all complex attributes in the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"required": false,
"description": "Include all complex attributes in the response."
}
},
{
"in": "query",
"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"
},
"required": false,
"description": "Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 011"
}
},
{
"in": "query",
"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"
},
"required": false,
"description": "Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 011"
}
},
{
"in": "query",
"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"
},
"required": false,
"description": "Indicates to exclude the following complex attributes from the response See clause 6.18 in ETSI GS MEC 011 for details."
}
}
],
"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": {
"$ref": "#/components/responses/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": {
"$ref": "#/components/responses/401"
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"$ref": "#/components/responses/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": {
"$ref": "#/components/responses/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": {
"$ref": "#/components/responses/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": [
......@@ -138,20 +346,22 @@
"summary": "Create a new application mobility service for the service requester.",
"description": "Create a new application mobility service for the service requester.",
"operationId": "app_mobility_servicePOST",
"parameters": [],
"requestBody": {
"description": "Application mobility service to be created",
"required": true,
"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": {
......@@ -161,38 +371,77 @@
}
},
"400": {
"$ref": "#/components/responses/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": {
"$ref": "#/components/responses/401"
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"$ref": "#/components/responses/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": {
"$ref": "#/components/responses/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": {
"$ref": "#/components/responses/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}": {
"parameters": [
{
"in": "path",
"name": "appMobilityServiceId",
"schema": {
"type": "string"
},
"required": true,
"description": "It uniquely identifies the created individual application mobility service"
}
],
"get": {
"tags": [
"app-mob-ser"
......@@ -200,9 +449,22 @@
"summary": "Retrieve information about this individual application mobility service",
"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": {
......@@ -212,24 +474,73 @@
}
},
"400": {
"$ref": "#/components/responses/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": {
"$ref": "#/components/responses/401"
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"$ref": "#/components/responses/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": {
"$ref": "#/components/responses/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": {
"$ref": "#/components/responses/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": [
......@@ -238,19 +549,33 @@
"summary": " update the existing individual application mobility service",
"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": {
"required": true,
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegistrationInfo"
}
}
}
},
"required": true