Skip to content
GitLab
Commits (7)
Hide whitespace changes
Inline Side-by-side
UEidentityAPI.json
View file @ f89b803d
{ {
"openapi": "3.1.0", "openapi": "3.1.0",
"info": { "info": {
"title": "UE Identity API", "title": "UE Identity API",
"version": "1.1.1", "version": "2.1.1",
"description": "The ETSI MEC ISG MEC014 UE Identity API described using OpenAPI", "description": "The ETSI MEC ISG MEC014 UE Identity API described using OpenAPI",
"license": { "license": {
"name": "BSD-3-Clause", "name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters" "url": "https://forge.etsi.org/legal-matters"
}, },
"contact": { "contact": {
"email": "cti_support@etsi.org" "email": "cti_support@etsi.org"
} }
}, },
"externalDocs": { "externalDocs": {
"description": "ETSI GS MEC014 UE Identity API, V1.1.1", "description": "ETSI GS MEC014 UE Identity API, V2.1.1",
"url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/014/01.01.01_60/gs_mec014v010101p.pdf" "url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/014/02.01.01_60/gs_mec014v020101p.pdf"
}, },
"security": [ "security": [{
{ "OauthSecurity": [
"OauthSecurity": [ "all"
"all" ]
] }],
} "servers": [{
], "url": "https://127.0.0.1:8081/ui/v1"
"servers": [ }],
{ "tags": [{
"url": "http://127.0.0.1:8081/ui/v1" "name": "ueIdentityTagInfo"
}, }],
{ "paths": {
"url": "https://127.0.0.1:8081/ui/v1" "/{appInstanceId}/ue_identity_tag_info": {
} "parameters": [{
], "$ref": "#/components/parameters/Path.AppInstanceId"
"tags": [ }],
{ "get": {
"name": "ueIdentityTagInfo" "description": "Retrieves information about a specific UeIdentityTagInfo resource",
} "operationId": "UeIdentityTagInfo_GET",
], "tags": [
"paths": { "ueIdentityTagInfo"
"/{appInstanceId}/ue_identity_tag_info": { ],
"parameters": [ "parameters": [{
{ "$ref": "#/components/parameters/Query.UeIdentityTag"
"$ref": "#/components/parameters/Path.AppInstanceId" }],
} "responses": {
], "200": {
"get": { "description": "It is used to indicate nonspecific success. The response body contains a representation of the UeIdentityTagInfo resource.",
"description": "Retrieves information about a specific UeIdentityTagInfo resource", "content": {
"operationId": "UeIdentityTagInfo_GET", "application/json": {
"tags": [ "schema": {
"ueIdentityTagInfo" "$ref": "#/components/schemas/UeIdentityTagInfo"
], }
"parameters": [ }
{ }
"$ref": "#/components/parameters/Query.UeIdentityTag" },
} "400": {
], "$ref": "#/components/responses/Error.400"
"responses": { },
"200": { "403": {
"description": "It is used to indicate nonspecific success. The response body contains a representation of the UeIdentityTagInfo resource.", "$ref": "#/components/responses/Error.403"
"content": { },
"application/json": { "404": {
"schema": { "$ref": "#/components/responses/Error.404"
"$ref": "#/components/schemas/UeIdentityTagInfo" }
} }
} },
} "put": {
}, "description": "Register/De-register the information about specific a UeIdentityTagInfo resource",
"400": { "operationId": "UeIdentityTagInfo_PUT",
"$ref": "#/components/responses/Error.400" "tags": [
}, "ueIdentityTagInfo"
"403": { ],
"$ref": "#/components/responses/Error.403" "requestBody": {
}, "content": {
"404": { "application/json": {
"$ref": "#/components/responses/Error.404" "schema": {
} "$ref": "#/components/schemas/UeIdentityTagInfo"
} }
}, }
"put": { },
"description": "Register/De-register the information about specific a UeIdentityTagInfo resource", "description": "'The updated \"state\" for each included UE Identity tag is included in the entity body of the request'",
"operationId": "UeIdentityTagInfo_PUT", "required": true
"tags": [ },
"ueIdentityTagInfo" "responses": {
], "200": {
"requestBody": { "description": "It is used to indicate success. The response body contains a representation of the UeIdentityTagInfo resource",
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/UeIdentityTagInfo" "$ref": "#/components/schemas/UeIdentityTagInfo"
} }
} }
}, }
"description": "'The updated \"state\" for each included UE Identity tag is included in the entity body of the request'", },
"required": true "400": {
}, "$ref": "#/components/responses/Error.400"
"responses": { },
"200": { "403": {
"description": "It is used to indicate success. The response body contains a representation of the UeIdentityTagInfo resource", "$ref": "#/components/responses/Error.403"
"content": { },
"application/json": { "404": {
"schema": { "$ref": "#/components/responses/Error.404"
"$ref": "#/components/schemas/UeIdentityTagInfo" },
} "412": {
} "$ref": "#/components/responses/Error.412"
} }
}, }
"400": { }
"$ref": "#/components/responses/Error.400" }
}, },
"403": { "components": {
"$ref": "#/components/responses/Error.403" "parameters": {
}, "Path.AppInstanceId": {
"404": { "name": "appInstanceId",
"$ref": "#/components/responses/Error.404" "in": "path",
}, "description": "Represents a mobile edge application instance",
"412": { "required": true,
"$ref": "#/components/responses/Error.412" "schema": {
} "type": "string"
} }
} },
} "Query.UeIdentityTag": {
}, "name": "ueIdentityTag",
"components": { "in": "query",
"parameters": { "description": "Represents a UE",
"Path.AppInstanceId": { "required": true,
"name": "appInstanceId", "schema": {
"in": "path", "type": "array",
"description": "Represents a mobile edge application instance", "items": {
"required": true, "type": "string"
"schema": { }
"type": "string" }
} }
}, },
"Query.UeIdentityTag": { "responses": {
"name": "ueIdentityTag", "Error.400": {
"in": "query", "description": "Bad Request. Incorrect parameters were passed in the request.In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"description": "Represents a UE", "content": {
"required": true, "application/problem+json": {
"schema": { "schema": {
"type": "array", "$ref": "#/components/schemas/ProblemDetails"
"items": { }
"type": "string" },
} "text/plain": {
} "schema": {
} "$ref": "#/components/schemas/Empty"
}, }
"responses": { }
"Error.400": { }
"description": "Bad Request. Incorrect parameters were passed in the request.In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.", },
"content": { "Error.403": {
"application/problem+json": { "description": "Forbidden. The operation is not allowed given the current status of the resource. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
"schema": { "content": {
"$ref": "#/components/schemas/ProblemDetails" "application/problem+json": {
} "schema": {
}, "$ref": "#/components/schemas/ProblemDetails"
"text/plain": { }
"schema": { }
"$ref": "#/components/schemas/Empty" }
} },
} "Error.404": {
} "description": "Not Found. The client provided a URI that cannot be mapped to a valid resource URL. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
}, "content": {
"Error.403": { "application/problem+json": {
"description": "Forbidden. The operation is not allowed given the current status of the resource. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.", "schema": {
"content": { "$ref": "#/components/schemas/ProblemDetails"
"application/problem+json": { }
"schema": { },
"$ref": "#/components/schemas/ProblemDetails" "text/plain": {
} "schema": {
} "$ref": "#/components/schemas/Empty"
} }
}, }
"Error.404": { }
"description": "Not Found. The client provided a URI that cannot be mapped to a valid resource URL. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.", },
"content": { "Error.412": {
"application/problem+json": { "description": "Precondition Failed. It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts.In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"schema": { "content": {
"$ref": "#/components/schemas/ProblemDetails" "application/problem+json": {
} "schema": {
}, "$ref": "#/components/schemas/ProblemDetails"
"text/plain": { }
"schema": { },
"$ref": "#/components/schemas/Empty" "text/plain": {
} "schema": {
} "$ref": "#/components/schemas/Empty"
} }
}, }
"Error.412": { }
"description": "Precondition Failed. It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts.In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.", }
"content": { },
"application/problem+json": { "securitySchemes": {
"schema": { "OauthSecurity": {
"$ref": "#/components/schemas/ProblemDetails" "type": "oauth2",
} "flows": {
}, "clientCredentials": {
"text/plain": { "tokenUrl": "https://oauth.exampleAPI/token",
"schema": { "scopes": {
"$ref": "#/components/schemas/Empty" "all": "Single oauth2 scope for API"
} }
} }
} }
} }
}, },
"securitySchemes": { "schemas": {
"OauthSecurity": { "Empty": {
"type": "oauth2", "description": "Empty schema"
"flows": { },
"clientCredentials": { "ProblemDetails": {
"tokenUrl": "https://oauth.exampleAPI/token", "type": "object",
"scopes": { "properties": {
"all": "Single oauth2 scope for API" "type": {
} "$ref": "#/components/schemas/Problem.type"
} },
} "title": {
} "$ref": "#/components/schemas/Problem.title"
}, },
"schemas": { "status": {
"Empty": { "$ref": "#/components/schemas/Problem.status"
"description": "Empty schema" },
}, "detail": {
"ProblemDetails": { "$ref": "#/components/schemas/Problem.detail"
"type": "object", },
"properties": { "instance": {
"type": { "$ref": "#/components/schemas/Problem.instance"
"$ref": "#/components/schemas/Problem.type" }
}, }
"title": { },
"$ref": "#/components/schemas/Problem.title" "Problem.type": {
}, "type": "string",
"status": { "format": "uri",
"$ref": "#/components/schemas/Problem.status" "description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
}, },
"detail": { "Problem.title": {
"$ref": "#/components/schemas/Problem.detail" "type": "string",
}, "description": "A short, human-readable summary of the problem type"
"instance": { },
"$ref": "#/components/schemas/Problem.instance" "Problem.status": {
} "type": "integer",
} "format": "uint32",
}, "description": "The HTTP status code for this occurrence of the problem"
"Problem.type": { },
"type": "string", "Problem.detail": {
"format": "uri", "type": "string",
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type" "description": "A human-readable explanation specific to this occurrence of the problem"
}, },
"Problem.title": { "Problem.instance": {
"type": "string", "type": "string",
"description": "A short, human-readable summary of the problem type" "format": "uri",
}, "description": "A URI reference that identifies the specific occurrence of the problem"
"Problem.status": { },
"type": "integer", "UeIdentityTagInfo": {
"format": "uint32", "description": "information of UE identity tag used in UE Identity feature",
"description": "The HTTP status code for this occurrence of the problem" "type": "object",
}, "required": [
"Problem.detail": { "ueIdentityTags"
"type": "string", ],
"description": "A human-readable explanation specific to this occurrence of the problem" "properties": {
}, "ueIdentityTags": {
"Problem.instance": { "$ref": "#/components/schemas/UeIdentityTags"
"type": "string", }
"format": "uri", }
"description": "A URI reference that identifies the specific occurrence of the problem" },
}, "UeIdentityTags": {
"UeIdentityTagInfo": { "description": "1 to N tags presented by a MEC Application instance to a MEC Platform",
"description": "information of UE identity tag used in UE Identity feature", "type": "array",
"type": "object", "items": {
"required": [ "required": [
"ueIdentityTags" "ueIdentityTag",
], "state"
"properties": { ],
"ueIdentityTags": { "properties": {
"$ref": "#/components/schemas/UeIdentityTags" "ueIdentityTag": {
} "$ref": "#/components/schemas/UeIdentityTag"
} },
}, "state": {
"UeIdentityTags": { "$ref": "#/components/schemas/State"
"description": "1 to N tags presented by a ME Application instance to a ME Platform", }
"type": "array", }
"items": { }
"required": [ },
"ueIdentityTag", "UeIdentityTag": {
"state" "description": "Specific tag presented by a MEC Application instance to a MEC Platform",
], "type": "string",
"properties": { "example": "UeTagA"
"ueIdentityTag": { },
"$ref": "#/components/schemas/UeIdentityTag" "State": {
}, "description": "Status of the resource ueIdentityTagInfo",
"state": { "type": "string",
"$ref": "#/components/schemas/State" "enum": [
} "UNREGISTERED",
} "REGISTERED"
} ],
}, "example": "REGISTERED"
"UeIdentityTag": { }
"description": "Specific tag presented by a ME Application instance to a ME Platform", }
"type": "string", }
"example": "UeTagA"
},
"State": {
"description": "Status of the resource ueIdentityTagInfo",
"type": "string",
"enum": [
"UNREGISTERED",
"REGISTERED"
],
"example": "REGISTERED"
}
}
}
} }
\ No newline at end of file
UEidentityAPI.yaml
View file @ f89b803d
openapi: 3.1.0 openapi: 3.1.0
info: info:
title: UE Identity API title: UE Identity API
version: 1.1.1 version: 2.1.1
description: The ETSI MEC ISG MEC014 UE Identity API described using OpenAPI description: The ETSI MEC ISG MEC014 UE Identity API described using OpenAPI
license: license:
name: BSD-3-Clause name: BSD-3-Clause
...@@ -9,13 +9,12 @@ info: ...@@ -9,13 +9,12 @@ info:
contact: contact:
email: cti_support@etsi.org email: cti_support@etsi.org
externalDocs: externalDocs:
description: ETSI GS MEC014 UE Identity API, V1.1.1 description: ETSI GS MEC014 UE Identity API, V2.1.1
url: http://www.etsi.org/deliver/etsi_gs/MEC/001_099/014/01.01.01_60/gs_mec014v010101p.pdf url: http://www.etsi.org/deliver/etsi_gs/MEC/001_099/014/02.01.01_60/gs_mec014v020101p.pdf
security: security:
- OauthSecurity: - OauthSecurity:
- all - all
servers: servers:
- url: http://127.0.0.1:8081/ui/v1
- url: https://127.0.0.1:8081/ui/v1 - url: https://127.0.0.1:8081/ui/v1
tags: tags:
- name: ueIdentityTagInfo - name: ueIdentityTagInfo
...@@ -195,7 +194,7 @@ components: ...@@ -195,7 +194,7 @@ components:
ueIdentityTags: ueIdentityTags:
$ref: "#/components/schemas/UeIdentityTags" $ref: "#/components/schemas/UeIdentityTags"
UeIdentityTags: UeIdentityTags:
description: 1 to N tags presented by a ME Application instance to a ME Platform description: 1 to N tags presented by a MEC Application instance to a MEC Platform
type: array type: array
items: items:
required: required:
...@@ -207,7 +206,7 @@ components: ...@@ -207,7 +206,7 @@ components:
state: state:
$ref: "#/components/schemas/State" $ref: "#/components/schemas/State"
UeIdentityTag: UeIdentityTag:
description: Specific tag presented by a ME Application instance to a ME Platform description: Specific tag presented by a MEC Application instance to a MEC Platform
type: string type: string
example: UeTagA example: UeTagA
State: State:
......