@speclynx/apidom-ls 2.12.0 → 2.13.0

package/src/config/openapi/external-documentation/completion.mjs

@@ -1,52 +0,0 @@
-import { CompletionFormat, CompletionType } from "../../../apidom-language-types.mjs";
-import { OpenAPI2, OpenAPI3 } from "../target-specs.mjs";
-const completion = [{
-  label: 'description',
-  insertText: 'description',
-  kind: 14,
-  format: CompletionFormat.QUOTED,
-  type: CompletionType.PROPERTY,
-  insertTextFormat: 2,
-  documentation: {
-    kind: 'markdown',
-    value: 'A short description of the target documentation. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation.'
-  },
-  targetSpecs: OpenAPI2
-}, {
-  label: 'description',
-  insertText: 'description',
-  kind: 14,
-  format: CompletionFormat.QUOTED,
-  type: CompletionType.PROPERTY,
-  insertTextFormat: 2,
-  documentation: {
-    kind: 'markdown',
-    value: 'A description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.'
-  },
-  targetSpecs: OpenAPI3
-}, {
-  label: 'url',
-  insertText: 'url',
-  kind: 14,
-  format: CompletionFormat.QUOTED,
-  type: CompletionType.PROPERTY,
-  insertTextFormat: 2,
-  documentation: {
-    kind: 'markdown',
-    value: '**Required.** The URL for the target documentation. Value MUST be in the format of a URL.'
-  },
-  targetSpecs: OpenAPI2
-}, {
-  label: 'url',
-  insertText: 'url',
-  kind: 14,
-  format: CompletionFormat.QUOTED,
-  type: CompletionType.PROPERTY,
-  insertTextFormat: 2,
-  documentation: {
-    kind: 'markdown',
-    value: '**REQUIRED**. The URI for the target documentation. This MUST be in the form of a URI.'
-  },
-  targetSpecs: OpenAPI3
-}];
-export default completion;

package/src/config/openapi/external-documentation/documentation.cjs

@@ -1,34 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _targetSpecs = require("../target-specs.cjs");
-const documentation = [{
-  target: 'description',
-  docs: 'A short description of the target documentation. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation.',
-  targetSpecs: _targetSpecs.OpenAPI2
-}, {
-  target: 'description',
-  docs: 'A description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.',
-  targetSpecs: _targetSpecs.OpenAPI3
-}, {
-  target: 'url',
-  docs: '**Required.** The URL for the target documentation. Value MUST be in the format of a URL.',
-  targetSpecs: _targetSpecs.OpenAPI2
-}, {
-  target: 'url',
-  docs: '**REQUIRED**. The URI for the target documentation. This MUST be in the form of a URI.',
-  targetSpecs: _targetSpecs.OpenAPI3
-}, {
-  docs: '#### [External Documentation Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#external-documentation-object)\n\nAllows referencing an external resource for extended documentation.\n\n##### Fixed Fields\n\nField Name | Type | Description\n---|:---:|---\ndescription | `string` | A short description of the target documentation. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation.\nurl | `string` | **Required.** The URL for the target documentation. Value MUST be in the format of a URL.\n\n##### Patterned Objects\n\nField Pattern | Type | Description\n---|:---:|---\n^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#vendorExtensions) for further details.\n\n##### External Documentation Object Example\n\n```js\n{\n  "description": "Find more info here",\n  "url": "https://swagger.io"\n}\n```\n\n\n\\\nYAML\n```yaml\ndescription: Find more info here\nurl: https://swagger.io\n```',
-  targetSpecs: _targetSpecs.OpenAPI2
-}, {
-  docs: '#### [External Documentation Object](https://spec.openapis.org/oas/v3.0.4.html#external-documentation-object)\n\nAllows referencing an external resource for extended documentation.\n\n##### Fixed Fields\n\nField Name | Type | Description\n---|:---:|---\ndescription | `string` | A short description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.\nurl | `string` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL.\n\nThis object MAY be extended with [Specification Extensions](https://spec.openapis.org/oas/v3.0.4.html#specification-extensions).\n\n##### External Documentation Object Example\n\n\n\\\nJSON\n```json\n{\n  "description": "Find more info here",\n  "url": "https://example.com"\n}\n```\n\n\n\\\nYAML\n```yaml\ndescription: Find more info here\nurl: https://example.com\n```',
-  targetSpecs: _targetSpecs.OpenAPI30
-}, {
-  docs: '#### [External Documentation Object](https://spec.openapis.org/oas/v3.1.2.html#external-documentation-object)\n\nAllows referencing an external resource for extended documentation.\n\n##### Fixed Fields\n\nField Name | Type | Description\n---|:---:|---\ndescription | `string` | A description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.\nurl | `string` | **REQUIRED**. The URI for the target documentation. This MUST be in the form of a URI.\n\n\\\nThis object MAY be extended with [Specification Extensions](https://spec.openapis.org/oas/v3.1.2.html#specification-extensions).\n\n##### External Documentation Object Example\n\n\n\\\nJSON\n```json\n{\n  "description": "Find more info here",\n  "url": "https://example.com"\n}\n```\n\n\n\\\nYAML\n```yaml\ndescription: Find more info here\nurl: https://example.com\n```',
-  targetSpecs: _targetSpecs.OpenAPI31
-}];
-var _default = exports.default = documentation;

package/src/config/openapi/external-documentation/documentation.mjs

@@ -1,28 +0,0 @@
-import { OpenAPI2, OpenAPI30, OpenAPI31, OpenAPI3 } from "../target-specs.mjs";
-const documentation = [{
-  target: 'description',
-  docs: 'A short description of the target documentation. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation.',
-  targetSpecs: OpenAPI2
-}, {
-  target: 'description',
-  docs: 'A description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.',
-  targetSpecs: OpenAPI3
-}, {
-  target: 'url',
-  docs: '**Required.** The URL for the target documentation. Value MUST be in the format of a URL.',
-  targetSpecs: OpenAPI2
-}, {
-  target: 'url',
-  docs: '**REQUIRED**. The URI for the target documentation. This MUST be in the form of a URI.',
-  targetSpecs: OpenAPI3
-}, {
-  docs: '#### [External Documentation Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#external-documentation-object)\n\nAllows referencing an external resource for extended documentation.\n\n##### Fixed Fields\n\nField Name | Type | Description\n---|:---:|---\ndescription | `string` | A short description of the target documentation. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation.\nurl | `string` | **Required.** The URL for the target documentation. Value MUST be in the format of a URL.\n\n##### Patterned Objects\n\nField Pattern | Type | Description\n---|:---:|---\n^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#vendorExtensions) for further details.\n\n##### External Documentation Object Example\n\n```js\n{\n  "description": "Find more info here",\n  "url": "https://swagger.io"\n}\n```\n\n\n\\\nYAML\n```yaml\ndescription: Find more info here\nurl: https://swagger.io\n```',
-  targetSpecs: OpenAPI2
-}, {
-  docs: '#### [External Documentation Object](https://spec.openapis.org/oas/v3.0.4.html#external-documentation-object)\n\nAllows referencing an external resource for extended documentation.\n\n##### Fixed Fields\n\nField Name | Type | Description\n---|:---:|---\ndescription | `string` | A short description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.\nurl | `string` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL.\n\nThis object MAY be extended with [Specification Extensions](https://spec.openapis.org/oas/v3.0.4.html#specification-extensions).\n\n##### External Documentation Object Example\n\n\n\\\nJSON\n```json\n{\n  "description": "Find more info here",\n  "url": "https://example.com"\n}\n```\n\n\n\\\nYAML\n```yaml\ndescription: Find more info here\nurl: https://example.com\n```',
-  targetSpecs: OpenAPI30
-}, {
-  docs: '#### [External Documentation Object](https://spec.openapis.org/oas/v3.1.2.html#external-documentation-object)\n\nAllows referencing an external resource for extended documentation.\n\n##### Fixed Fields\n\nField Name | Type | Description\n---|:---:|---\ndescription | `string` | A description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.\nurl | `string` | **REQUIRED**. The URI for the target documentation. This MUST be in the form of a URI.\n\n\\\nThis object MAY be extended with [Specification Extensions](https://spec.openapis.org/oas/v3.1.2.html#specification-extensions).\n\n##### External Documentation Object Example\n\n\n\\\nJSON\n```json\n{\n  "description": "Find more info here",\n  "url": "https://example.com"\n}\n```\n\n\n\\\nYAML\n```yaml\ndescription: Find more info here\nurl: https://example.com\n```',
-  targetSpecs: OpenAPI31
-}];
-export default documentation;

package/src/config/openapi/external-documentation/lint/allowed-fields.cjs

@@ -1,21 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _vscodeLanguageserverTypes = require("vscode-languageserver-types");
-var _codes = _interopRequireDefault(require("../../../codes.cjs"));
-var _targetSpecs = require("../../target-specs.cjs");
-const allowedFieldsLint = {
-  code: _codes.default.NOT_ALLOWED_FIELDS,
-  source: 'apilint',
-  message: 'Object includes not allowed fields',
-  severity: _vscodeLanguageserverTypes.DiagnosticSeverity.Error,
-  linterFunction: 'allowedFields',
-  linterParams: [['description', 'url'], 'x-'],
-  marker: 'key',
-  targetSpecs: [..._targetSpecs.OpenAPI2, ..._targetSpecs.OpenAPI3]
-};
-var _default = exports.default = allowedFieldsLint;

package/src/config/openapi/external-documentation/lint/allowed-fields.mjs

@@ -1,14 +0,0 @@
-import { DiagnosticSeverity } from 'vscode-languageserver-types';
-import ApilintCodes from "../../../codes.mjs";
-import { OpenAPI2, OpenAPI3 } from "../../target-specs.mjs";
-const allowedFieldsLint = {
-  code: ApilintCodes.NOT_ALLOWED_FIELDS,
-  source: 'apilint',
-  message: 'Object includes not allowed fields',
-  severity: DiagnosticSeverity.Error,
-  linterFunction: 'allowedFields',
-  linterParams: [['description', 'url'], 'x-'],
-  marker: 'key',
-  targetSpecs: [...OpenAPI2, ...OpenAPI3]
-};
-export default allowedFieldsLint;

package/src/config/openapi/external-documentation/lint/description--type.cjs

@@ -1,23 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _vscodeLanguageserverTypes = require("vscode-languageserver-types");
-var _codes = _interopRequireDefault(require("../../../codes.cjs"));
-var _targetSpecs = require("../../target-specs.cjs");
-const descriptionTypeLint = {
-  code: _codes.default.OPENAPI2_EXTERNAL_DOCUMENTATION_FIELD_DESCRIPTION_TYPE,
-  source: 'apilint',
-  message: "'description' must be a string",
-  severity: _vscodeLanguageserverTypes.DiagnosticSeverity.Error,
-  linterFunction: 'apilintType',
-  linterParams: ['string'],
-  marker: 'value',
-  target: 'description',
-  data: {},
-  targetSpecs: [..._targetSpecs.OpenAPI2, ..._targetSpecs.OpenAPI3]
-};
-var _default = exports.default = descriptionTypeLint;

package/src/config/openapi/external-documentation/lint/description--type.mjs

@@ -1,16 +0,0 @@
-import { DiagnosticSeverity } from 'vscode-languageserver-types';
-import ApilintCodes from "../../../codes.mjs";
-import { OpenAPI2, OpenAPI3 } from "../../target-specs.mjs";
-const descriptionTypeLint = {
-  code: ApilintCodes.OPENAPI2_EXTERNAL_DOCUMENTATION_FIELD_DESCRIPTION_TYPE,
-  source: 'apilint',
-  message: "'description' must be a string",
-  severity: DiagnosticSeverity.Error,
-  linterFunction: 'apilintType',
-  linterParams: ['string'],
-  marker: 'value',
-  target: 'description',
-  data: {},
-  targetSpecs: [...OpenAPI2, ...OpenAPI3]
-};
-export default descriptionTypeLint;

package/src/config/openapi/external-documentation/lint/index.cjs

@@ -1,13 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _allowedFields = _interopRequireDefault(require("./allowed-fields.cjs"));
-var _descriptionType = _interopRequireDefault(require("./description--type.cjs"));
-var _urlRequired = _interopRequireDefault(require("./url--required.cjs"));
-var _urlFormatUri = _interopRequireDefault(require("./url--format-uri.cjs"));
-const lints = [_descriptionType.default, _urlRequired.default, _urlFormatUri.default, _allowedFields.default];
-var _default = exports.default = lints;

package/src/config/openapi/external-documentation/lint/index.mjs

@@ -1,6 +0,0 @@
-import allowedFieldsLint from "./allowed-fields.mjs";
-import descriptionTypeLint from "./description--type.mjs";
-import urlRequiredLint from "./url--required.mjs";
-import urlFormatURILint from "./url--format-uri.mjs";
-const lints = [descriptionTypeLint, urlRequiredLint, urlFormatURILint, allowedFieldsLint];
-export default lints;

package/src/config/openapi/external-documentation/lint/url--format-uri.cjs

@@ -1,22 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _vscodeLanguageserverTypes = require("vscode-languageserver-types");
-var _codes = _interopRequireDefault(require("../../../codes.cjs"));
-var _targetSpecs = require("../../target-specs.cjs");
-const urlFormatURILint = {
-  code: _codes.default.OPENAPI2_EXTERNAL_DOCUMENTATION_FIELD_URL_FORMAT_URI,
-  source: 'apilint',
-  message: "'url' value must be a valid URL",
-  severity: _vscodeLanguageserverTypes.DiagnosticSeverity.Error,
-  linterFunction: 'apilintValidURI',
-  marker: 'value',
-  target: 'url',
-  data: {},
-  targetSpecs: [..._targetSpecs.OpenAPI2, ..._targetSpecs.OpenAPI3]
-};
-var _default = exports.default = urlFormatURILint;

package/src/config/openapi/external-documentation/lint/url--format-uri.mjs

@@ -1,15 +0,0 @@
-import { DiagnosticSeverity } from 'vscode-languageserver-types';
-import ApilintCodes from "../../../codes.mjs";
-import { OpenAPI2, OpenAPI3 } from "../../target-specs.mjs";
-const urlFormatURILint = {
-  code: ApilintCodes.OPENAPI2_EXTERNAL_DOCUMENTATION_FIELD_URL_FORMAT_URI,
-  source: 'apilint',
-  message: "'url' value must be a valid URL",
-  severity: DiagnosticSeverity.Error,
-  linterFunction: 'apilintValidURI',
-  marker: 'value',
-  target: 'url',
-  data: {},
-  targetSpecs: [...OpenAPI2, ...OpenAPI3]
-};
-export default urlFormatURILint;

package/src/config/openapi/external-documentation/lint/url--required.cjs

@@ -1,29 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _vscodeLanguageserverTypes = require("vscode-languageserver-types");
-var _codes = _interopRequireDefault(require("../../../codes.cjs"));
-var _targetSpecs = require("../../target-specs.cjs");
-const urlRequiredLint = {
-  code: _codes.default.OPENAPI2_EXTERNAL_DOCUMENTATION_FIELD_URL_REQUIRED,
-  source: 'apilint',
-  message: "should always have an 'url'",
-  severity: _vscodeLanguageserverTypes.DiagnosticSeverity.Error,
-  linterFunction: 'hasRequiredField',
-  linterParams: ['url'],
-  marker: 'key',
-  data: {
-    quickFix: [{
-      message: "add 'url' field",
-      action: 'addChild',
-      snippetYaml: 'url: \n  ',
-      snippetJson: '"url": "",\n    '
-    }]
-  },
-  targetSpecs: [..._targetSpecs.OpenAPI2, ..._targetSpecs.OpenAPI3]
-};
-var _default = exports.default = urlRequiredLint;

package/src/config/openapi/external-documentation/lint/url--required.mjs

@@ -1,22 +0,0 @@
-import { DiagnosticSeverity } from 'vscode-languageserver-types';
-import ApilintCodes from "../../../codes.mjs";
-import { OpenAPI2, OpenAPI3 } from "../../target-specs.mjs";
-const urlRequiredLint = {
-  code: ApilintCodes.OPENAPI2_EXTERNAL_DOCUMENTATION_FIELD_URL_REQUIRED,
-  source: 'apilint',
-  message: "should always have an 'url'",
-  severity: DiagnosticSeverity.Error,
-  linterFunction: 'hasRequiredField',
-  linterParams: ['url'],
-  marker: 'key',
-  data: {
-    quickFix: [{
-      message: "add 'url' field",
-      action: 'addChild',
-      snippetYaml: 'url: \n  ',
-      snippetJson: '"url": "",\n    '
-    }]
-  },
-  targetSpecs: [...OpenAPI2, ...OpenAPI3]
-};
-export default urlRequiredLint;

package/src/config/openapi/external-documentation/meta.cjs

@@ -1,16 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _index = _interopRequireDefault(require("./lint/index.cjs"));
-var _completion = _interopRequireDefault(require("./completion.cjs"));
-var _documentation = _interopRequireDefault(require("./documentation.cjs"));
-const meta = {
-  lint: _index.default,
-  completion: _completion.default,
-  documentation: _documentation.default
-};
-var _default = exports.default = meta;

package/src/config/openapi/external-documentation/meta.mjs

@@ -1,9 +0,0 @@
-import lint from "./lint/index.mjs";
-import completion from "./completion.mjs";
-import documentation from "./documentation.mjs";
-const meta = {
-  lint,
-  completion,
-  documentation
-};
-export default meta;