diff --git a/doc/.gitkeep b/doc/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/doc/gs_mec045v030101p.docx b/doc/gs_mec045v030101p.docx new file mode 100644 index 0000000000000000000000000000000000000000..471a6aadacc212ee10eaba14e145d3725cfd4d20 Binary files /dev/null and b/doc/gs_mec045v030101p.docx differ diff --git a/doc/mec045_config.yaml b/doc/mec045_config.yaml new file mode 100644 index 0000000000000000000000000000000000000000..67c79c06840eb2091a402b0dae98f63eebb1ce72 --- /dev/null +++ b/doc/mec045_config.yaml @@ -0,0 +1,133 @@ +--- +data_model_headings: + headings1: + - '6[ ]*Data model$' + - '7[ ]*API definition$' + +api_def_headings: + headings1: + - '7[ ]*API definition$' + - 'Annex A \(informative\)\:\nComplementary material for API utilization$' + +servers: + - url: https://localhost/qms/v1 + +tags: +- 'subscriptions' +- 'subscriptionsById' + +fake_data_types: False +manual_types: + ProblemDetails: + type: object + properties: + type: + type: string + format: uri + description: A URI reference according to IETF RFC 3986 that identifies the problem type + title: + type: string + description: A short, human-readable summary of the problem type + status: + type: integer + format: uint32 + description: The HTTP status code for this occurrence of the problem + detail: + type: string + description: A human-readable explanation specific to this occurrence of the problem + instance: + type: string + format: uri + description: A URI reference that identifies the specific occurrence of the problem + + SerializerType: + x-etsi-ref: 8.1.6.3 + type: string + enum: + - JSON + - XML + - PROTOBUF3 + x-etsi-mec-extensible: true + x-etsi-mec-enumeration-table: + - value: JSON + description: Javascript object notation [9] + - value: XML + description: eXtensible Mark-up Language version 1.1 [10] + - value: PROTOBUF3 + description: Protocol buffers version 3 [i.3] + +info: + contact: + url: https://forge.etsi.org/rep/mec/gs045-qos-mea-api + title: 'ETSI GS MEC 045 QoS Measurement API' + version: 3.1.1 + description: ETSI GS MEC 045 QoS Measurement API described using OpenAPI. + license: + name: BSD-3-Clause + url: 'https://forge.etsi.org/legal-matters' + +responses: + '200': + description: 'OK' + '204': + description: 'No Content' + '400': + description: 'Bad Request: used to indicate that incorrect parameters were passed to the request.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized: used when the client did not submit credentials.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden: operation is not allowed given the current status of the resource.' + content: + application/problem+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.' + content: + application/problem+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.' + content: + application/problem+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' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '415': + description: 'Unsupported Media Type: used to indicate that the server or the client does not support the content type of the entity body.' + content: + application/problem+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.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests: used when a rate limiter has triggered.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' \ No newline at end of file