Skip to content
GitLab
Commit 23d079bc authored by Michel Roy's avatar Michel Roy
Browse files

implicit naming

parent 5a216022
Pipeline #5072 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
LocationAPI.json
View file @ 23d079bc
...@@ -2257,7 +2257,7 @@ ...@@ -2257,7 +2257,7 @@
} }
}, },
"example": { "example": {
"zonalTrafiicSubscription": { "zonalTrafficSubscription": {
"clientCorrelator": "0123", "clientCorrelator": "0123",
"callbackReference": { "callbackReference": {
"notifyURL": "http://my.callback.com/location_notifications/some-id" "notifyURL": "http://my.callback.com/location_notifications/some-id"
...@@ -2762,14 +2762,9 @@ ...@@ -2762,14 +2762,9 @@
"400": { "400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": { "content": {
"application/json": { "application/problem+json": {
"schema": { "schema": {
"type": "object", "$ref": "#/components/schemas/ProblemDetails"
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
} }
} }
} }
...@@ -2777,14 +2772,9 @@ ...@@ -2777,14 +2772,9 @@
"401": { "401": {
"description": "Unauthorized : used when the client did not submit credentials.", "description": "Unauthorized : used when the client did not submit credentials.",
"content": { "content": {
"application/json": { "application/problem+json": {
"schema": { "schema": {
"type": "object", "$ref": "#/components/schemas/ProblemDetails"
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
} }
} }
} }
...@@ -2792,17 +2782,9 @@ ...@@ -2792,17 +2782,9 @@
"403": { "403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.", "description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": { "content": {
"application/json": { "application/problem+json": {
"schema": { "schema": {
"type": "object", "$ref": "#/components/schemas/ProblemDetails"
"required": [
"problemDetails"
],
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
} }
} }
} }
...@@ -2810,14 +2792,9 @@ ...@@ -2810,14 +2792,9 @@
"404": { "404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": { "content": {
"application/json": { "application/problem+json": {
"schema": { "schema": {
"type": "object", "$ref": "#/components/schemas/ProblemDetails"
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
} }
} }
} }
...@@ -2825,14 +2802,9 @@ ...@@ -2825,14 +2802,9 @@
"406": { "406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": { "content": {
"application/json": { "application/problem+json": {
"schema": { "schema": {
"type": "object", "$ref": "#/components/schemas/ProblemDetails"
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
} }
} }
} }
...@@ -2840,14 +2812,9 @@ ...@@ -2840,14 +2812,9 @@
"412": { "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", "description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
"content": { "content": {
"application/json": { "application/problem+json": {
"schema": { "schema": {
"type": "object", "$ref": "#/components/schemas/ProblemDetails"
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
} }
} }
} }
...@@ -2855,14 +2822,9 @@ ...@@ -2855,14 +2822,9 @@
"414": { "414": {
"description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.", "description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.",
"content": { "content": {
"application/json": { "application/problem+json": {
"schema": { "schema": {
"type": "object", "$ref": "#/components/schemas/ProblemDetails"
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
} }
} }
} }
...@@ -2870,14 +2832,9 @@ ...@@ -2870,14 +2832,9 @@
"415": { "415": {
"description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.", "description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.",
"content": { "content": {
"application/json": { "application/problem+json": {
"schema": { "schema": {
"type": "object", "$ref": "#/components/schemas/ProblemDetails"
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
} }
} }
} }
...@@ -2885,24 +2842,17 @@ ...@@ -2885,24 +2842,17 @@
"422": { "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.", "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.",
"content": { "content": {
"application/json": { "application/problem+json": {
"schema": { "schema": {
"type": "object", "$ref": "#/components/schemas/ProblemDetails"
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}, },
"example": { "example": {
"application/problem+json": { "application/problem+json": {
"ProblemDetails": { "type": "https://meAppServer.example.com/rni/v2/probs/too-many targets",
"type": "https://meAppServer.example.com/rni/v2/probs/too-many targets", "title": "Too many targets",
"title": "Too many targets", "status": "422",
"status": "422", "detail": "The target area for the request is considered too large",
"detail": "The target area for the request is considered too large", "instance": "/meAppClient.example.com/77777/msgs/abc"
"instance": "/meAppClient.example.com/77777/msgs/abc"
}
} }
} }
} }
...@@ -2911,14 +2861,9 @@ ...@@ -2911,14 +2861,9 @@
"429": { "429": {
"description": "Too Many Requests : used when a rate limiter has triggered.", "description": "Too Many Requests : used when a rate limiter has triggered.",
"content": { "content": {
"application/json": { "application/problem+json": {
"schema": { "schema": {
"type": "object", "$ref": "#/components/schemas/ProblemDetails"
"properties": {
"problemDetails": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
} }
} }
} }
......
LocationAPI.yaml
View file @ 23d079bc
...@@ -1484,7 +1484,7 @@ paths: ...@@ -1484,7 +1484,7 @@ paths:
zonalTrafficSubscription: zonalTrafficSubscription:
$ref: '#/components/schemas/ZonalTrafficSubscription' $ref: '#/components/schemas/ZonalTrafficSubscription'
example: example:
zonalTrafiicSubscription: zonalTrafficSubscription:
clientCorrelator: '0123' clientCorrelator: '0123'
callbackReference: callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id' notifyURL: 'http://my.callback.com/location_notifications/some-id'
...@@ -1803,108 +1803,75 @@ components: ...@@ -1803,108 +1803,75 @@ components:
400: 400:
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
content: content:
application/json: application/problem+json:
schema: schema:
type: object $ref: '#/components/schemas/ProblemDetails'
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
401: 401:
description: 'Unauthorized : used when the client did not submit credentials.' description: 'Unauthorized : used when the client did not submit credentials.'
content: content:
application/json: application/problem+json:
schema: schema:
type: object $ref: '#/components/schemas/ProblemDetails'
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
403: 403:
description: 'Forbidden : operation is not allowed given the current status of the resource.' description: 'Forbidden : operation is not allowed given the current status of the resource.'
content: content:
application/json: application/problem+json:
schema: schema:
type: object $ref: '#/components/schemas/ProblemDetails'
required:
- problemDetails
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
404: 404:
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
content: content:
application/json: application/problem+json:
schema: schema:
type: object $ref: '#/components/schemas/ProblemDetails'
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
406: 406:
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
content: content:
application/json: application/problem+json:
schema: schema:
type: object $ref: '#/components/schemas/ProblemDetails'
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
412: 412:
description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when
using ETags to avoid write conflicts when using PUT' using ETags to avoid write conflicts when using PUT'
content: content:
application/json: application/problem+json:
schema: schema:
type: object $ref: '#/components/schemas/ProblemDetails'
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
414: 414:
description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is
longer than the server is willing or able to process.' longer than the server is willing or able to process.'
content: content:
application/json: application/problem+json:
schema: schema:
type: object $ref: '#/components/schemas/ProblemDetails'
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
415: 415:
description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.' description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.'
content: content:
application/json: application/problem+json:
schema: schema:
type: object $ref: '#/components/schemas/ProblemDetails'
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
422: 422:
description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the 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 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 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.' error condition can also occur if the capabilities required by the request are not supported.'
content: content:
application/json: application/problem+json:
schema: schema:
type: object $ref: '#/components/schemas/ProblemDetails'
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
example: example:
application/problem+json: application/problem+json:
ProblemDetails: type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets'
type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets' title: Too many targets
title: Too many targets status: '422'
status: '422' detail: The target area for the request is considered too large
detail: The target area for the request is considered too large instance: /meAppClient.example.com/77777/msgs/abc
instance: /meAppClient.example.com/77777/msgs/abc
429: 429:
description: 'Too Many Requests : used when a rate limiter has triggered.' description: 'Too Many Requests : used when a rate limiter has triggered.'
content: content:
application/json: application/problem+json:
schema: schema:
type: object $ref: '#/components/schemas/ProblemDetails'
properties:
problemDetails:
$ref: '#/components/schemas/ProblemDetails'
parameters: parameters:
Path.AccessPointId: Path.AccessPointId:
name: accessPointId name: accessPointId
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment