# harvested from https://github.com/Netcracker/qubership-api-linter-service/blob/08730a6744a3efab7521aae436dbf0c9ff1a54d5/qubership-api-linter-service/resources/vacuum/rules/rules.yaml on 2026-10-09 — a Spectral ruleset published in the provider's own GitHub repository (Netcracker/qubership-api-linter-service); found by GitHub code search, fetched verbatim
x-method: harvested
x-stamped: 2026-10-09
x-source-url: https://github.com/Netcracker/qubership-api-linter-service/blob/08730a6744a3efab7521aae436dbf0c9ff1a54d5/qubership-api-linter-service/resources/vacuum/rules/rules.yaml
# Copyright 2024-2025 NetCracker Technology Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

extends: [[spectral:oas, recommended]]
description: Qubership's rules for a high quality specification.
rules:
  license-url:
    message: "License must have an URL defined"
    description: License URL check
    formats:
        - oas3
        - oas3_1
    given: $.info.license
    howToFix: Please supply license object with "url"
    recommended: true
    resolved: true
    severity: warn
    then:
        field: url
        function: truthy
  no-example-com-in-url:
    message: "Url must not use example.com anyhow"
    description: Url must not use example.com based domain inside
    formats:
        - oas3
        - oas3_1
    given: $..*
    howToFix: Please exclude example.com from "url"
    recommended: true
    resolved: true
    severity: warn
    then:
      field: url
      function: pattern
      functionOptions:
        notMatch: example\.com
  server-variables-descriptions:
    description: Server variables need to be described
    given: $.servers.variables[*]
    howToFix: Please add 'description' field to the server variable
    recommended: true
    severity: warn
    then:
      field: description
      function: truthy
    type: style
  paths-description:
    description: All the paths need to be described
    given: $.paths[*][*]
    howToFix: Please add 'description' field to the path
    recommended: true
    severity: warn
    then:
      field: description
      function: truthy
    type: style
  request-body-description:
    description: All the request bodies need to be described
    given: $.paths[*][*].requestBody
    howToFix: Please add 'description' field to the request body
    severity: warn
    then:
      field: description
      function: truthy
    type: style
  responses-description:
    description: All the responses need to be described

    given: $.paths[*][*].responses[*]
    howToFix: Please add 'description' field to the response children
    severity: warn
    then:
      field: description
      function: truthy
    type: style
  components-security-schemas-description:
    description: All the component security schemas need to be described
    given: $.components.securitySchemes[*]
    howToFix: Please add 'description' field to all the component security schemas
    severity: warn
    then:
      field: description
      function: truthy
    type: style
  schema-description:
    description: All the schemas need to be described
    given: $.schema[*]
    howToFix: Please add 'description' field to all the schemas
    severity: warn
    then:
      field: description
      function: truthy
    type: style
  schema-properties-description:
    description: All the schema properties need to be described
    given: $.schema.properties[*]
    howToFix: Please add 'description' field to all the schema propertiess
    severity: warn
    then:
      field: description
      function: truthy
    type: style
  schema-properties-children-description:
    description: All the schema children properties need to be described
    given: $.schema.properties[*][*].properties
    howToFix: Please add 'description' field to all the schema children propertiess
    severity: warn
    then:
      field: description
      function: truthy
    type: style