Redocly logo
API DocsDeveloper PortalWorkflowsFREE API TOOLS
RedocRedoc vs. RedoclyRedocly CLI
DocsPricingEnterprise
COMPANY
BlogAbout UsCustomersCareers
TECHNOLOGY
StatusSecurityTech Stack
CONTACT SALES →
LoginSign Up
    Rules
    boolean-parameter-prefixes
    Built-in rules
    Configurable rules
    info-contact
    info-license-url
    info-license
    Minimal ruleset
    no-ambiguous-paths
    no-empty-servers
    no-enum-type-mismatch
    no-example-value-and-externalValue
    no-http-verbs-in-paths
    no-identical-paths
    no-invalid-media-type-examples
    no-invalid-parameter-examples
    no-invalid-schema-examples
    no-path-trailing-slash
    no-server-example.com
    no-server-trailing-slash
    no-server-variables-empty-enum
    no-undefined-server-variable
    no-unresolved-refs
    no-unused-components
    operation-2xx-response
    operation-4xx-problem-details-rfc7807
    operation-4xx-response
    operation-description
    operation-operationId-unique
    operation-operationId-url-safe
    operation-operationId
    operation-parameters-unique
    operation-singular-tag
    operation-summary
    operation-tag-defined
    parameter-description
    path-declaration-must-exist
    path-excludes-patterns
    path-not-include-query
    path-parameters-defined
    path-segment-plural
    paths-kebab-case
    Recommended ruleset
    request-mime-type
    required-string-property-missing-min-length
    response-contains-header
    response-contains-property
    response-mime-type
    scalar-property-missing-example
    security-defined
    spec-components-invalid-map-name
    spec
    tag-description
    tags-alphabetical
Last updated 10 minutes ago

Minimal ruleset

The rules contained in the minimal ruleset:

Errors:

  • no-server-trailing-slash
  • no-server-variables-empty-enum
  • no-unresolved-refs
  • spec

Warnings:

  • configurable rules
  • no-ambiguous-paths
  • no-empty-servers
  • no-enum-type-mismatch
  • no-example-value-and-externalValue
  • no-identical-paths
  • no-invalid-media-type-examples
  • no-path-trailing-slash
  • no-server-example-com
  • no-undefined-server-variable
  • no-unused-components
  • operation-2xx-response
  • operation-operationId-unique
  • operation-operationId-url-safe
  • operation-operationId
  • operation-parameters-unique
  • operation-summary
  • path-declaration-must-exist
  • path-not-include-query
  • path-parameters-defined
  • security-defined
  • spec-components-invalid-map-name
  • tag-description
PRODUCTSAPI docsPortalsWorkflowsRedocRedocly CLIRedoc vs Redocly
EXPLOREPricingEnterpriseCustomersAbout UsCareersContact Sales
RESOURCESDocsBlogWebinarsWhy RedoclyStartup DiscountDocs-like-code
TECH & LEGALSecurityTech StackStatusTermsSLADPA
CONNECTContact Usteam@redocly.com
Superpower your inbox with API wisdom:
Subscribe
Built with 💙 ☕️️ and 🌮. This website runs entirely on our Developer Portal.
© 2023 Redocly Inc. All rights reserved. Terms • Privacy • Cookies