@openlint/ruleset-spectral-oas 0.0.0-stage → 0.1.0

package/dist/oas/index.js

@@ -0,0 +1,765 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = void 0;
+const tslib_1 = require("tslib");
+const openlint_formats_1 = require("@openlint/openlint-formats");
+const openlint_functions_1 = require("@openlint/openlint-functions");
+const functions_1 = require("./functions");
+const functions_2 = require("../shared/functions");
+const serverVariables_1 = tslib_1.__importDefault(require("../shared/functions/serverVariables"));
+const ruleset = {
+    documentationUrl: 'https://docs.openlint.org/reference/openapi-rules',
+    formats: [openlint_formats_1.oas2, openlint_formats_1.oas3, openlint_formats_1.oas3_0, openlint_formats_1.oas3_1, openlint_formats_1.oas3_2],
+    aliases: {
+        PathItem: ['$.paths[*]'],
+        OperationObject: ['#PathItem[get,put,post,delete,options,head,patch,trace]'],
+        SecurityRequirementObject: ['$.security[*]', '#OperationObject.security[*]'],
+        ResponseObject: {
+            targets: [
+                {
+                    formats: [openlint_formats_1.oas2],
+                    given: ['#OperationObject.responses[*]', '$.responses[*]'],
+                },
+                {
+                    formats: [openlint_formats_1.oas3],
+                    given: ['#OperationObject.responses[*]', '$.components.responses[*]'],
+                },
+            ],
+        },
+        LinkObject: {
+            targets: [
+                {
+                    formats: [openlint_formats_1.oas3],
+                    given: ['$.components.links[*]', '#ResponseObject.links[*]'],
+                },
+            ],
+        },
+        ArrayProperties: {
+            targets: [
+                {
+                    formats: [openlint_formats_1.oas2, openlint_formats_1.oas3_0],
+                    given: [
+                        // Check for type: 'array'
+                        '$..[?(@ && @.type=="array")]',
+                    ],
+                },
+                {
+                    formats: [openlint_formats_1.oas3_1, openlint_formats_1.oas3_2],
+                    given: [
+                        // Still check for type: 'array'
+                        '$..[?(@ && @.type=="array")]',
+                        // also check for type: ['array', ...]
+                        '$..[?(@ && @.type && @.type.constructor.name === "Array" && @.type.includes("array"))]',
+                    ],
+                },
+            ],
+        },
+    },
+    rules: {
+        'operation-success-response': {
+            description: 'Operation must have at least one "2xx" or "3xx" response.',
+            recommended: true,
+            given: '#OperationObject',
+            then: {
+                field: 'responses',
+                function: functions_1.oasOpSuccessResponse,
+            },
+        },
+        'oas2-operation-formData-consume-check': {
+            description: 'Operations with "in: formData" parameter must include "application/x-www-form-urlencoded" or "multipart/form-data" in their "consumes" property.',
+            recommended: true,
+            formats: [openlint_formats_1.oas2],
+            given: '#OperationObject',
+            then: {
+                function: functions_1.oasOpFormDataConsumeCheck,
+            },
+        },
+        'operation-operationId-unique': {
+            description: 'Every operation must have unique "operationId".',
+            recommended: true,
+            severity: 0,
+            given: '$.paths',
+            then: {
+                function: functions_1.oasOpIdUnique,
+            },
+        },
+        'operation-parameters': {
+            description: 'Operation parameters are unique and non-repeating.',
+            message: '{{error}}',
+            recommended: true,
+            given: '#OperationObject.parameters',
+            then: {
+                function: functions_1.oasOpParams,
+            },
+        },
+        'operation-tag-defined': {
+            description: 'Operation tags must be defined in global tags.',
+            recommended: true,
+            given: '$',
+            then: {
+                function: functions_1.oasTagDefined,
+            },
+        },
+        'path-params': {
+            description: 'Path parameters must be defined and valid.',
+            message: '{{error}}',
+            severity: 0,
+            recommended: true,
+            given: '$.paths',
+            then: {
+                function: functions_1.oasPathParam,
+            },
+        },
+        'contact-properties': {
+            description: 'Contact object must have "name", "url" and "email".',
+            recommended: false,
+            given: '$.info.contact',
+            then: [
+                {
+                    field: 'name',
+                    function: openlint_functions_1.truthy,
+                },
+                {
+                    field: 'url',
+                    function: openlint_functions_1.truthy,
+                },
+                {
+                    field: 'email',
+                    function: openlint_functions_1.truthy,
+                },
+            ],
+        },
+        'duplicated-entry-in-enum': {
+            description: 'Enum values must not have duplicate entry.',
+            severity: 'warn',
+            recommended: true,
+            message: '{{error}}',
+            given: ["$..[?(@property !== 'properties' && @ != null && @.enum && @.enum.constructor.name === 'Array')]"],
+            then: {
+                field: 'enum',
+                function: functions_1.oasSchema,
+                functionOptions: {
+                    schema: {
+                        type: 'array',
+                        uniqueItems: true,
+                    },
+                },
+            },
+        },
+        'info-contact': {
+            description: 'Info object must have "contact" object.',
+            recommended: true,
+            given: '$',
+            then: {
+                field: 'info.contact',
+                function: openlint_functions_1.truthy,
+            },
+        },
+        'info-description': {
+            description: 'Info "description" must be present and non-empty string.',
+            recommended: true,
+            given: '$',
+            then: {
+                field: 'info.description',
+                function: openlint_functions_1.truthy,
+            },
+        },
+        'info-license': {
+            description: 'Info object must have "license" object.',
+            recommended: false,
+            given: '$',
+            then: {
+                field: 'info.license',
+                function: openlint_functions_1.truthy,
+            },
+        },
+        'license-url': {
+            description: 'License object must include "url".',
+            recommended: false,
+            given: '$',
+            then: {
+                field: 'info.license.url',
+                function: openlint_functions_1.truthy,
+            },
+        },
+        'no-eval-in-markdown': {
+            description: 'Markdown descriptions must not have "eval(".',
+            recommended: true,
+            given: '$..[description,title]',
+            then: {
+                function: openlint_functions_1.pattern,
+                functionOptions: {
+                    notMatch: 'eval\\(',
+                },
+            },
+        },
+        'no-script-tags-in-markdown': {
+            description: 'Markdown descriptions must not have "<script>" tags.',
+            recommended: true,
+            given: '$..[description,title]',
+            then: {
+                function: openlint_functions_1.pattern,
+                functionOptions: {
+                    notMatch: '<script',
+                },
+            },
+        },
+        'openapi-tags-alphabetical': {
+            description: 'OpenAPI object must have alphabetical "tags".',
+            recommended: false,
+            given: '$',
+            then: {
+                field: 'tags',
+                function: openlint_functions_1.alphabetical,
+                functionOptions: {
+                    keyedBy: 'name',
+                },
+            },
+        },
+        'openapi-tags-uniqueness': {
+            description: 'Each tag must have a unique name.',
+            message: '{{error}}',
+            severity: 'error',
+            recommended: true,
+            given: '$.tags',
+            then: {
+                function: functions_2.uniquenessTags,
+            },
+        },
+        'openapi-tags': {
+            description: 'OpenAPI object must have non-empty "tags" array.',
+            recommended: false,
+            given: '$',
+            then: {
+                field: 'tags',
+                function: openlint_functions_1.schema,
+                functionOptions: {
+                    dialect: 'draft7',
+                    schema: {
+                        type: 'array',
+                        minItems: 1,
+                    },
+                },
+            },
+        },
+        'operation-description': {
+            description: 'Operation "description" must be present and non-empty string.',
+            recommended: true,
+            given: '#OperationObject',
+            then: {
+                field: 'description',
+                function: openlint_functions_1.truthy,
+            },
+        },
+        'operation-operationId': {
+            description: 'Operation must have "operationId".',
+            recommended: true,
+            given: '#OperationObject',
+            then: {
+                field: 'operationId',
+                function: openlint_functions_1.truthy,
+            },
+        },
+        'operation-operationId-valid-in-url': {
+            message: 'operationId must not contain characters that are invalid when used in URL.',
+            recommended: true,
+            given: '#OperationObject',
+            then: {
+                field: 'operationId',
+                function: openlint_functions_1.pattern,
+                functionOptions: {
+                    match: "^[A-Za-z0-9-._~:/?#\\[\\]@!\\$&'()*+,;=]*$",
+                },
+            },
+        },
+        'operation-singular-tag': {
+            description: 'Operation must not have more than a single tag.',
+            recommended: false,
+            given: '#OperationObject',
+            then: {
+                field: 'tags',
+                function: openlint_functions_1.length,
+                functionOptions: {
+                    max: 1,
+                },
+            },
+        },
+        'operation-tags': {
+            description: 'Operation must have non-empty "tags" array.',
+            recommended: true,
+            given: '#OperationObject',
+            then: {
+                field: 'tags',
+                function: openlint_functions_1.schema,
+                functionOptions: {
+                    dialect: 'draft7',
+                    schema: {
+                        type: 'array',
+                        minItems: 1,
+                    },
+                },
+            },
+        },
+        'path-declarations-must-exist': {
+            message: 'Path parameter declarations must not be empty, ex."/given/{}" is invalid.',
+            recommended: true,
+            given: '$.paths',
+            then: {
+                field: '@key',
+                function: openlint_functions_1.pattern,
+                functionOptions: {
+                    notMatch: '{}',
+                },
+            },
+        },
+        'path-keys-no-trailing-slash': {
+            message: 'Path must not end with slash.',
+            recommended: true,
+            given: '$.paths',
+            then: {
+                field: '@key',
+                function: openlint_functions_1.pattern,
+                functionOptions: {
+                    notMatch: '.+\\/$',
+                },
+            },
+        },
+        'path-not-include-query': {
+            description: 'Path must not include query string.',
+            recommended: true,
+            given: '$.paths',
+            then: {
+                field: '@key',
+                function: openlint_functions_1.pattern,
+                functionOptions: {
+                    notMatch: '\\?',
+                },
+            },
+        },
+        'tag-description': {
+            description: 'Tag object must have "description".',
+            recommended: false,
+            given: '$.tags[*]',
+            then: {
+                field: 'description',
+                function: openlint_functions_1.truthy,
+            },
+        },
+        'no-$ref-siblings': {
+            formats: [openlint_formats_1.oas2, openlint_formats_1.oas3_0],
+            description: 'Property must not be placed among $ref',
+            message: '{{error}}',
+            severity: 0,
+            recommended: true,
+            resolved: false,
+            given: "$..[?(@property === '$ref')]",
+            then: {
+                function: functions_1.refSiblings,
+            },
+        },
+        'array-items': {
+            message: 'Schemas with "type: array", require a sibling "items" field',
+            severity: 0,
+            recommended: true,
+            resolved: false,
+            given: '#ArrayProperties',
+            then: {
+                function: openlint_functions_1.truthy,
+                field: 'items',
+            },
+        },
+        'typed-enum': {
+            description: 'Enum values must respect the specified type.',
+            message: '{{error}}',
+            recommended: true,
+            given: '$..[?(@ && @.enum && @.type)]',
+            then: {
+                function: functions_1.typedEnum,
+            },
+        },
+        'oas2-api-host': {
+            description: 'OpenAPI "host" must be present and non-empty string.',
+            recommended: true,
+            formats: [openlint_formats_1.oas2],
+            given: '$',
+            then: {
+                field: 'host',
+                function: openlint_functions_1.truthy,
+            },
+        },
+        'oas2-api-schemes': {
+            description: 'OpenAPI host "schemes" must be present and non-empty array.',
+            recommended: true,
+            formats: [openlint_formats_1.oas2],
+            given: '$',
+            then: {
+                field: 'schemes',
+                function: openlint_functions_1.schema,
+                functionOptions: {
+                    dialect: 'draft7',
+                    schema: {
+                        items: {
+                            type: 'string',
+                        },
+                        minItems: 1,
+                        type: 'array',
+                    },
+                },
+            },
+        },
+        'oas2-discriminator': {
+            description: 'discriminator property must be defined and required',
+            recommended: true,
+            formats: [openlint_formats_1.oas2],
+            severity: 0,
+            message: '{{error}}',
+            given: '$.definitions[?(@.discriminator)]',
+            then: {
+                function: functions_1.oasDiscriminator,
+            },
+        },
+        'oas2-host-not-example': {
+            description: 'Host URL must not point at example.com.',
+            recommended: false,
+            formats: [openlint_formats_1.oas2],
+            given: '$',
+            then: {
+                field: 'host',
+                function: openlint_functions_1.pattern,
+                functionOptions: {
+                    notMatch: 'example\\.com',
+                },
+            },
+        },
+        'oas2-host-trailing-slash': {
+            description: 'Server URL must not have trailing slash.',
+            recommended: true,
+            formats: [openlint_formats_1.oas2],
+            given: '$',
+            then: {
+                field: 'host',
+                function: openlint_functions_1.pattern,
+                functionOptions: {
+                    notMatch: '/$',
+                },
+            },
+        },
+        'oas2-parameter-description': {
+            description: 'Parameter objects must have "description".',
+            recommended: false,
+            formats: [openlint_formats_1.oas2],
+            given: '$..parameters[?(@ && @.in)]',
+            then: {
+                field: 'description',
+                function: openlint_functions_1.truthy,
+            },
+        },
+        'oas2-operation-security-defined': {
+            description: 'Operation "security" values must match a scheme defined in the "securityDefinitions" object.',
+            message: '{{error}}',
+            recommended: true,
+            formats: [openlint_formats_1.oas2],
+            given: '#SecurityRequirementObject',
+            then: {
+                function: functions_1.oasSecurityDefined,
+                functionOptions: {
+                    oasVersion: 2,
+                },
+            },
+        },
+        'oas2-valid-schema-example': {
+            description: 'Examples must be valid against their defined schema.',
+            message: '{{error}}',
+            recommended: true,
+            formats: [openlint_formats_1.oas2],
+            severity: 0,
+            given: [
+                "$..definitions..[?(@property !== 'properties' && @ && (@.example !== void 0 || @['x-example'] !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
+                "$..parameters..[?(@property !== 'properties' && @ && (@.example !== void 0 || @['x-example'] !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
+                "$..responses..[?(@property !== 'properties' && @ && (@.example !== void 0 || @['x-example'] !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
+            ],
+            then: {
+                function: functions_1.oasExample,
+                functionOptions: {
+                    schemaField: '$',
+                    oasVersion: 2,
+                    type: 'schema',
+                },
+            },
+        },
+        'oas2-valid-media-example': {
+            description: 'Examples must be valid against their defined schema.',
+            message: '{{error}}',
+            recommended: true,
+            formats: [openlint_formats_1.oas2],
+            severity: 0,
+            given: '$..responses..[?(@ && @.schema && @.examples)]',
+            then: {
+                function: functions_1.oasExample,
+                functionOptions: {
+                    schemaField: 'schema',
+                    oasVersion: 2,
+                    type: 'media',
+                },
+            },
+        },
+        'oas2-anyOf': {
+            message: '"anyOf" keyword must not be used in OpenAPI v2 document.',
+            description: 'anyOf is not available in OpenAPI v2, it was added in OpenAPI v3',
+            recommended: true,
+            formats: [openlint_formats_1.oas2],
+            given: '$..anyOf',
+            then: {
+                function: openlint_functions_1.undefined,
+            },
+        },
+        'oas2-oneOf': {
+            message: '"oneOf" keyword must not be used in OpenAPI v2 document.',
+            description: 'oneOf is not available in OpenAPI v2, it was added in OpenAPI v3',
+            recommended: true,
+            formats: [openlint_formats_1.oas2],
+            given: '$..oneOf',
+            then: {
+                function: openlint_functions_1.undefined,
+            },
+        },
+        'oas2-schema': {
+            description: 'Validate structure of OpenAPI v2 specification.',
+            message: '{{error}}.',
+            recommended: true,
+            formats: [openlint_formats_1.oas2],
+            severity: 0,
+            resolved: false,
+            given: '$',
+            then: {
+                function: functions_1.oasDocumentSchema,
+            },
+        },
+        'oas2-unused-definition': {
+            description: 'Potentially unused definition has been detected.',
+            recommended: true,
+            resolved: false,
+            formats: [openlint_formats_1.oas2],
+            given: '$.definitions',
+            then: {
+                function: openlint_functions_1.unreferencedReusableObject,
+                functionOptions: {
+                    reusableObjectsLocation: '#/definitions',
+                },
+            },
+        },
+        'oas3-api-servers': {
+            description: 'OpenAPI "servers" must be present and non-empty array.',
+            recommended: true,
+            formats: [openlint_formats_1.oas3],
+            given: '$',
+            then: {
+                field: 'servers',
+                function: openlint_functions_1.schema,
+                functionOptions: {
+                    dialect: 'draft7',
+                    schema: {
+                        items: {
+                            type: 'object',
+                        },
+                        minItems: 1,
+                        type: 'array',
+                    },
+                },
+            },
+        },
+        'oas3-examples-value-or-externalValue': {
+            description: 'Examples must have either "value" or "externalValue" field.',
+            recommended: true,
+            formats: [openlint_formats_1.oas3],
+            given: [
+                '$.components.examples[*]',
+                '$.paths[*][*]..content[*].examples[*]',
+                '$.paths[*][*]..parameters[*].examples[*]',
+                '$.components.parameters[*].examples[*]',
+                '$.paths[*][*]..headers[*].examples[*]',
+                '$.components.headers[*].examples[*]',
+            ],
+            then: {
+                function: openlint_functions_1.xor,
+                functionOptions: {
+                    properties: ['externalValue', 'value'],
+                },
+            },
+        },
+        'oas3-operation-security-defined': {
+            description: 'Operation "security" values must match a scheme defined in the "components.securitySchemes" object.',
+            message: '{{error}}',
+            recommended: true,
+            formats: [openlint_formats_1.oas3],
+            given: '#SecurityRequirementObject',
+            then: {
+                function: functions_1.oasSecurityDefined,
+                functionOptions: {
+                    oasVersion: 3,
+                },
+            },
+        },
+        'oas3-parameter-description': {
+            description: 'Parameter objects must have "description".',
+            recommended: false,
+            formats: [openlint_formats_1.oas3],
+            given: [
+                '#PathItem.parameters[?(@ && @.in)]',
+                '#OperationObject.parameters[?(@ && @.in)]',
+                '$.components.parameters[?(@ && @.in)]',
+            ],
+            then: {
+                field: 'description',
+                function: openlint_functions_1.truthy,
+            },
+        },
+        'oas3-server-not-example.com': {
+            description: 'Server URL must not point at example.com.',
+            recommended: false,
+            formats: [openlint_formats_1.oas3],
+            given: '$.servers[*].url',
+            then: {
+                function: openlint_functions_1.pattern,
+                functionOptions: {
+                    notMatch: 'example\\.com',
+                },
+            },
+        },
+        'oas3-server-trailing-slash': {
+            description: 'Server URL must not have trailing slash.',
+            recommended: true,
+            formats: [openlint_formats_1.oas3],
+            given: '$.servers[*].url',
+            then: {
+                function: openlint_functions_1.pattern,
+                functionOptions: {
+                    notMatch: './$',
+                },
+            },
+        },
+        'oas3-valid-media-example': {
+            description: 'Examples must be valid against their defined schema.',
+            message: '{{error}}',
+            recommended: true,
+            severity: 0,
+            formats: [openlint_formats_1.oas3],
+            given: [
+                '$..content..[?(@ && @.schema && (@.example !== void 0 || @.examples))]',
+                '$..headers..[?(@ && @.schema && (@.example !== void 0 || @.examples))]',
+                '$..parameters..[?(@ && @.schema && (@.example !== void 0 || @.examples))]',
+            ],
+            then: {
+                function: functions_1.oasExample,
+                functionOptions: {
+                    schemaField: 'schema',
+                    oasVersion: 3,
+                    type: 'media',
+                },
+            },
+        },
+        'oas3-valid-schema-example': {
+            description: 'Examples must be valid against their defined schema.',
+            message: '{{error}}',
+            severity: 0,
+            formats: [openlint_formats_1.oas3],
+            recommended: true,
+            given: [
+                "$.components.schemas..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
+                "$..content..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
+                "$..headers..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
+                "$..parameters..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
+            ],
+            then: {
+                function: functions_1.oasExample,
+                functionOptions: {
+                    schemaField: '$',
+                    oasVersion: 3,
+                    type: 'schema',
+                },
+            },
+        },
+        'oas3-schema': {
+            description: 'Validate structure of OpenAPI v3 specification.',
+            message: '{{error}}.',
+            severity: 0,
+            formats: [openlint_formats_1.oas3],
+            recommended: true,
+            resolved: false,
+            given: '$',
+            then: {
+                function: functions_1.oasDocumentSchema,
+            },
+        },
+        'oas3-unused-component': {
+            message: 'Potentially unused component has been detected.',
+            recommended: true,
+            formats: [openlint_formats_1.oas3],
+            resolved: false,
+            given: '$',
+            then: {
+                function: functions_1.oasUnusedComponent,
+            },
+        },
+        'oas3-server-variables': {
+            description: 'Server variables must be defined and valid and there must be no unused variables.',
+            message: '{{error}}',
+            severity: 0,
+            recommended: true,
+            given: ['$.servers[*]', '#PathItem.servers[*]', '#OperationObject.servers[*]', '#LinkObject.server'],
+            then: {
+                function: serverVariables_1.default,
+                functionOptions: {
+                    checkSubstitutions: true,
+                    requireDefault: true,
+                },
+            },
+        },
+        'oas3-callbacks-in-callbacks': {
+            message: 'Callbacks should not be defined within a callback',
+            formats: [openlint_formats_1.oas3],
+            recommended: true,
+            given: ['#OperationObject.callbacks[*][*][*].callbacks'],
+            then: {
+                function: openlint_functions_1.undefined,
+            },
+        },
+        'oas3_1-servers-in-webhook': {
+            message: 'Servers should not be defined in a webhook.',
+            formats: [openlint_formats_1.oas3_1, openlint_formats_1.oas3_2],
+            recommended: true,
+            given: ['$.webhooks.servers', '$.webhooks[*][*].servers'],
+            then: {
+                function: openlint_functions_1.undefined,
+            },
+        },
+        'oas3_1-callbacks-in-webhook': {
+            message: 'Callbacks should not be defined in a webhook.',
+            formats: [openlint_formats_1.oas3_1, openlint_formats_1.oas3_2],
+            recommended: true,
+            given: ['$.webhooks[*][*].callbacks'],
+            then: {
+                function: openlint_functions_1.undefined,
+            },
+        },
+        'oas3_2-no-deprecated-xml-attribute': {
+            message: '"xml.attribute" is deprecated in OAS 3.2; use "xml.nodeType: attribute" instead.',
+            formats: [openlint_formats_1.oas3_2],
+            recommended: true,
+            given: ['$..[?(@ && @.xml)].xml'],
+            then: {
+                function: openlint_functions_1.schema,
+                functionOptions: {
+                    schema: {
+                        not: {
+                            properties: { attribute: { const: true } },
+                            required: ['attribute'],
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+exports.default = ruleset;
+//# sourceMappingURL=index.js.map