Skip to content

Commit

Permalink
feat(ls): provide OpenAPI 3.1 Responses docs rules
Browse files Browse the repository at this point in the history 
Refs #2063
  • Loading branch information
@char0n
char0n committed Oct 28, 2022
1 parent ae4c69b commit 7e6f60f
Showing 1 changed file with 170 additions and 0 deletions.
170 changes: 170 additions & 0 deletions packages/apidom-ls/src/config/openapi/responses/documentation.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,171 +9,341 @@ const httpCode3_0DocsRule = {
],
};

// eslint-disable-next-line @typescript-eslint/naming-convention
const httpCode3_1DocsRule = {
docs: '[Response Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#responseObject) \\| [Reference Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#referenceObject)\n\\\n\\\nThe documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses.',
targetSpecs: [{ namespace: 'openapi', version: '3.1.0' }],
};

const documentation = [
{
target: 'default',
...httpCode3_0DocsRule,
},
{
target: 'default',
...httpCode3_1DocsRule,
},
{
target: '100',
...httpCode3_0DocsRule,
},
{
target: '100',
...httpCode3_1DocsRule,
},
{
target: '101',
...httpCode3_0DocsRule,
},
{
target: '101',
...httpCode3_1DocsRule,
},
{
target: '1XX',
...httpCode3_0DocsRule,
},
{
target: '1XX',
...httpCode3_1DocsRule,
},
{
target: '201',
...httpCode3_0DocsRule,
},
{
target: '201',
...httpCode3_1DocsRule,
},
{
target: '202',
...httpCode3_0DocsRule,
},
{
target: '202',
...httpCode3_1DocsRule,
},
{
target: '203',
...httpCode3_0DocsRule,
},
{
target: '203',
...httpCode3_1DocsRule,
},
{
target: '204',
...httpCode3_0DocsRule,
},
{
target: '204',
...httpCode3_1DocsRule,
},
{
target: '205',
...httpCode3_0DocsRule,
},
{
target: '205',
...httpCode3_1DocsRule,
},
{
target: '2XX',
...httpCode3_0DocsRule,
},
{
target: '2XX',
...httpCode3_1DocsRule,
},
{
target: '300',
...httpCode3_0DocsRule,
},
{
target: '300',
...httpCode3_1DocsRule,
},
{
target: '301',
...httpCode3_0DocsRule,
},
{
target: '301',
...httpCode3_1DocsRule,
},
{
target: '302',
...httpCode3_0DocsRule,
},
{
target: '302',
...httpCode3_1DocsRule,
},
{
target: '303',
...httpCode3_0DocsRule,
},
{
target: '303',
...httpCode3_1DocsRule,
},
{
target: '305',
...httpCode3_0DocsRule,
},
{
target: '305',
...httpCode3_1DocsRule,
},
{
target: '306',
...httpCode3_0DocsRule,
},
{
target: '306',
...httpCode3_1DocsRule,
},
{
target: '307',
...httpCode3_0DocsRule,
},
{
target: '307',
...httpCode3_1DocsRule,
},
{
target: '3XX',
...httpCode3_0DocsRule,
},
{
target: '3XX',
...httpCode3_1DocsRule,
},
{
target: '400',
...httpCode3_0DocsRule,
},
{
target: '400',
...httpCode3_1DocsRule,
},
{
target: '402',
...httpCode3_0DocsRule,
},
{
target: '402',
...httpCode3_1DocsRule,
},
{
target: '403',
...httpCode3_0DocsRule,
},
{
target: '403',
...httpCode3_1DocsRule,
},
{
target: '404',
...httpCode3_0DocsRule,
},
{
target: '404',
...httpCode3_1DocsRule,
},
{
target: '405',
...httpCode3_0DocsRule,
},
{
target: '405',
...httpCode3_1DocsRule,
},
{
target: '406',
...httpCode3_0DocsRule,
},
{
target: '406',
...httpCode3_1DocsRule,
},
{
target: '408',
...httpCode3_0DocsRule,
},
{
target: '408',
...httpCode3_1DocsRule,
},
{
target: '409',
...httpCode3_0DocsRule,
},
{
target: '409',
...httpCode3_1DocsRule,
},
{
target: '410',
...httpCode3_0DocsRule,
},
{
target: '410',
...httpCode3_1DocsRule,
},
{
target: '411',
...httpCode3_0DocsRule,
},
{
target: '411',
...httpCode3_1DocsRule,
},
{
target: '413',
...httpCode3_0DocsRule,
},
{
target: '413',
...httpCode3_1DocsRule,
},
{
target: '414',
...httpCode3_0DocsRule,
},
{
target: '414',
...httpCode3_1DocsRule,
},
{
target: '415',
...httpCode3_0DocsRule,
},
{
target: '415',
...httpCode3_1DocsRule,
},
{
target: '417',
...httpCode3_0DocsRule,
},
{
target: '417',
...httpCode3_1DocsRule,
},
{
target: '426',
...httpCode3_0DocsRule,
},
{
target: '426',
...httpCode3_1DocsRule,
},
{
target: '4XX',
...httpCode3_0DocsRule,
},
{
target: '4XX',
...httpCode3_1DocsRule,
},
{
target: '500',
...httpCode3_0DocsRule,
},
{
target: '500',
...httpCode3_1DocsRule,
},
{
target: '501',
...httpCode3_0DocsRule,
},
{
target: '501',
...httpCode3_1DocsRule,
},
{
target: '502',
...httpCode3_0DocsRule,
},
{
target: '502',
...httpCode3_1DocsRule,
},
{
target: '503',
...httpCode3_0DocsRule,
},
{
target: '503',
...httpCode3_1DocsRule,
},
{
target: '504',
...httpCode3_0DocsRule,
},
{
target: '504',
...httpCode3_1DocsRule,
},
{
target: '505',
...httpCode3_0DocsRule,
},
{
target: '505',
...httpCode3_1DocsRule,
},
{
target: '5XX',
...httpCode3_0DocsRule,
},
{
target: '5XX',
...httpCode3_1DocsRule,
},
{
docs: '#### [Responses Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#responses-object)\n\nA container for the expected responses of an operation.\nThe container maps a HTTP response code to the expected response.\n\nThe documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance.\nHowever, documentation is expected to cover a successful operation response and any known errors.\n\nThe `default` MAY be used as a default response object for all HTTP codes\nthat are not covered individually by the specification.\n\nThe `Responses Object` MUST contain at least one response code, and it\nSHOULD be the response for a successful operation call.\n\n##### Fixed Fields\nField Name | Type | Description\n---|:---:|---\ndefault | [Response Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#responseObject) \\| [Reference Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#referenceObject) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A [Reference Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#referenceObject) can link to a response that the [OpenAPI Object\'s components/responses](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#componentsResponses) section defines.\n\n##### Patterned Fields\nField Pattern | Type | Description\n---|:---:|---\n[HTTP Status Code](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#httpCodes) | [Response Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#responseObject) \\| [Reference Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#referenceObject) | Any [HTTP status code](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#httpCodes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A [Reference Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#referenceObject) can link to a response that is defined in the [OpenAPI Object\'s components/responses](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#componentsResponses) section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `[200-299]`. Only the following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code.\n\n\nThis object MAY be extended with [Specification Extensions](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specificationExtensions).\n\n##### Responses Object Example\n\nA 200 response for a successful operation and a default response for others (implying an error):\n\n\n\\\nJSON\n```json\n{\n "200": {\n "description": "a pet to be returned",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/Pet"\n }\n }\n }\n },\n "default": {\n "description": "Unexpected error",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/ErrorModel"\n }\n }\n }\n }\n}\n```\n\n\n\\\nYAML\n```yaml\n\'200\':\n description: a pet to be returned\n content:\n application/json:\n schema:\n $ref: \'#/components/schemas/Pet\'\ndefault:\n description: Unexpected error\n content:\n application/json:\n schema:\n $ref: \'#/components/schemas/ErrorModel\'\n```',
targetSpecs: [
Expand Down

0 comments on commit 7e6f60f

Please sign in to comment.