diff --git a/OpenAPI/openapi-AE6.yaml b/OpenAPI/openapi-AE6.yaml index c25781d47692a51ea0d06aa1969c509b22f2c46b..3033c25bc84825c4f4ca68d47c1ce5e10a49c34f 100644 --- a/OpenAPI/openapi-AE6.yaml +++ b/OpenAPI/openapi-AE6.yaml @@ -53,53 +53,28 @@ paths: } } responses: + + '202': + $ref: "#/components/schemas/response202" + + examples: + '0': + value: >- + {"m2m:rce": {"ae": {"rn": "temperature", "api": + "N01.com.company.temperature ", "lbl": ["key1", "key2"], + "rr": true, "srv": ["3"], "poa": + ["http://192.168.1.30:8080"], "ri": "Ctemperature", "ct": + "20210728T095441,065102", "lt": "20210728T095441,065102", + "et": "20220728T095441,065102", "pi": "id-in", "ty": 2, + "aei": "Ctemperature"}, "uri": "cse-in/temperature"}} + + '201': description: Auto generated using Swagger Inspector content: application/json: schema: - type: object - properties: - 'm2m:rce': - type: object - properties: - ae: - type: object - properties: - rr: - type: boolean - poa: - type: array - items: - type: string - aei: - type: string - ty: - type: integer - lt: - type: string - et: - type: string - ct: - type: string - srv: - type: array - items: - type: string - lbl: - type: array - items: - type: string - ri: - type: string - pi: - type: string - api: - type: string - rn: - type: string - uri: - type: string + $ref: "#/components/schemas/response201" examples: '0': value: >- @@ -121,7 +96,7 @@ paths: 'm2m:rce': type: object properties: - 'm2m:ae': + m2m:ae: type: object properties: rr: @@ -411,3 +386,224 @@ paths: - url: 'http://cse-address:8080' servers: - url: 'http://cse-address:8080' +components: + responses: + + + + + response201: + description: >- + Bad Request. + + content: + application/problem+json: + schema: + type: object + properties: + 'm2m:rce': + type: object + properties: + ae: + type: object + properties: + rr: + type: boolean + poa: + type: array + items: + type: string + aei: + type: string + ty: + type: integer + lt: + type: string + et: + type: string + ct: + type: string + srv: + type: array + items: + type: string + lbl: + type: array + items: + type: string + ri: + type: string + pi: + type: string + api: + type: string + rn: + type: string + uri: + type: string + + + response202: + 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: + application/problem+json: + schema: + type: object + properties: + 'm2m:rce': + type: object + properties: + ae: + type: object + properties: + rr: + type: boolean + poa: + type: array + items: + type: string + aei: + type: string + ty: + type: integer + lt: + type: string + et: + type: string + ct: + type: string + srv: + type: array + items: + type: string + lbl: + type: array + items: + type: string + ri: + type: string + pi: + type: string + api: + type: string + rn: + type: string + uri: + type: string + + + Error.403: + 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. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetails" + 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: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetails" + 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: + schema: + $ref: "#/components/schemas/ProblemDetails" + text/plain: + schema: + $ref: '#/components/schemas/Empty' + securitySchemes: + OauthSecurity: + type: oauth2 + flows: + clientCredentials: + tokenUrl: https://oauth.exampleAPI/token + scopes: + all: Single oauth2 scope for API + schemas: + Empty: + description: Empty schema + ProblemDetails: + type: object + properties: + type: + $ref: "#/components/schemas/Problem.type" + title: + $ref: "#/components/schemas/Problem.title" + status: + $ref: "#/components/schemas/Problem.status" + detail: + $ref: "#/components/schemas/Problem.detail" + instance: + $ref: "#/components/schemas/Problem.instance" + Problem.type: + type: string + format: uri + description: A URI reference according to IETF RFC 3986 that identifies the problem + type + Problem.title: + type: string + description: A short, human-readable summary of the problem type + Problem.status: + type: integer + format: uint32 + description: The HTTP status code for this occurrence of the problem + Problem.detail: + type: string + description: A human-readable explanation specific to this occurrence of the problem + Problem.instance: + type: string + format: uri + description: A URI reference that identifies the specific occurrence of the problem + UeIdentityTagInfo: + description: information of UE identity tag used in UE Identity feature + type: object + required: + - ueIdentityTags + properties: + ueIdentityTags: + $ref: "#/components/schemas/UeIdentityTags" + UeIdentityTags: + description: 1 to N tags presented by a ME Application instance to a ME Platform + type: array + items: + required: + - ueIdentityTag + - state + properties: + ueIdentityTag: + $ref: "#/components/schemas/UeIdentityTag" + state: + $ref: "#/components/schemas/State" + 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