From 9a982b69ab93420ff7fc04810f8cf8327b0758e9 Mon Sep 17 00:00:00 2001 From: Timothy Lai Date: Mon, 12 Sep 2022 15:46:19 -0700 Subject: [PATCH] fix(ls): add targetSpecs for header object --- packages/apidom-ls/src/config/openapi/header/documentation.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/apidom-ls/src/config/openapi/header/documentation.ts b/packages/apidom-ls/src/config/openapi/header/documentation.ts index 8cafa006d5..e19e37bdb8 100644 --- a/packages/apidom-ls/src/config/openapi/header/documentation.ts +++ b/packages/apidom-ls/src/config/openapi/header/documentation.ts @@ -1,6 +1,7 @@ const documentation = [ { docs: '#### Header Object\n\nThe Header Object follows the structure of the [Parameter Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameterObject) with the following changes:\n\n 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map.\n 2. `in` MUST NOT be specified, it is implicitly in `header`.\n 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, [`style`](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameterStyle)).\n\n##### Header Object Example\n\n\\\nA simple header of type `integer`:\n\n\\\nJSON\n```json\n{\n "description": "The number of allowed requests in the current period",\n "schema": {\n "type": "integer"\n }\n}\n```\n\n\\\nYAML\n```yaml\ndescription: The number of allowed requests in the current period\nschema:\n type: integer\n```\n', + targetSpecs: [{ namespace: 'openapi', version: '3.1.0' }], }, ];