Qodex.ai
This is a workspace of several hundred individual Spectral rules that can be used to lint OpenAPI and Swagger files for your APIs. Each rule lives as it's own collection to make it easier for you to learn about each rule, execute that rule to see how it works, but then also fork and use as part of larger rulesets. If you have any questions or you can't find a rule for something you can comment on any of the collections here or submit an issue on the Github repository managing this work.

OpenAPI 3.0 Linting Rules

These are Spectral rules for linting OpenAPI as part of API governance efforts.
  • **[Info Title] - This is a Spectral governance rule to enforce that OpenAPI has an info title.
  • **[Info Title In Kebab Case] - This is a Spectral governance rule to enforce that OpenAPI info title is in kebab case.
  • **[Info Title Max Length] - This is a Spectral governance rule to enforce that OpenAPI info title is under a maximum length.
  • **[Info Title Word Check] - This is a Spectral governance rule to enforce that OpenAPI info title doesn't contain certain words.
  • **[Info Description Max Length] - This is a Spectral governance rule to enforce that an OpenAPI information object description meet a specific length requirement, making sure that descriptions aren't too long, and provide the precise right amount of information for consumers..
  • **[ Info Description Word Check] - This is a Spectral governance rule to enforce that an OpenAPI information object description does not contain certain words.
  • **[ Info Description] - This is a Spectral governance rule to enforce that an OpenAPI has a description included as part of the information object, making sure there is as much detail about what an API does available for consumers.
  • **[Info Summary Max Length] - This is a Spectral governance rule to enforce that OpenAPI info object summary has a maximum length.
  • **[Info Summary Word Check] - This is a Spectral governance rule to enforce that OpenAPI info object summary does not contain certain words.
  • **[Info Summary] - This is a Spectral governance rule to enforce that OpenAPI has an info object summary.
  • **[Info Contact] - This is a Spectral governance rule to enforce that OpenAPI info object has a contact.
  • **[Info Contact Email] - This is a Spectral governance rule to enforce that OpenAPI info object has a contact email.
  • **[Info Contact Name] - This is a Spectral governance rule to enforce that OpenAPI info object has a contact name.
  • **[Info Contact Url] - This is a Spectral governance rule to enforce that OpenAPI info object has a contact url.
  • **[Info License] - This is a Spectral governance rule to enforce that OpenAPI info object has a license.
  • **[Info License Name] - This is a Spectral governance rule to enforce that OpenAPI info object has a license name.
  • **[Info License Url] - This is a Spectral governance rule to enforce that OpenAPI info object has a license url.
  • **[Info License Url Apache] - This is a Spectral governance rule to enforce that OpenAPI info object has an Apache license.
  • **[Info License Url Mit] - This is a Spectral governance rule to enforce that OpenAPI info object has an MIT license.
  • **[Info Terms Of Service] - This is a Spectral governance rule to enforce that OpenAPI info object has a terms of service.
  • **[Info X API Id] - This is a Spectral governance rule to enforce that the OpenAPI info has an API ID extension.
  • **[Info X Audience] - This is a Spectral governance rule to enforce that the OpenAPI info has an audience extension.
  • **[OpenAPI Version] - This is a Spectral governance rule to make sure that a specific version of OpenAPI is being used.
  • **[Info Version] - This is a Spectral governance rule to enforce that OpenAPI has an info version.
  • **[Version Date Format] - This is a Spectral governance rule to make sure that there is at data version applied within OpenAPI definitions.
  • **[Version Semantic] - An API governance linting rule to enforce that semantic versioning has been applied to an OpenAPI, making sure that all teams are using the same versioning patterns, and all APIs are being versioned.
  • **[Version Second Segment] - This is a Spectral governance rule to make sure that the second segment of the path a version.
  • **[ HTTPS Only] - This is a Spectral governance rule to enforce that OpenAPI is only using HTTPS for the server protocol.
  • **[Do Not Use API for Base Path] - This is a Spectral governance rule to make sure that /api is not used as base path in an OpenAPI.
  • **[No Path Dashes] - This is a Spectral governance rule to make sure that paths should not contain dashes in an OpenAPI.
  • **[No Empty Paths] - This is a Spectral governance rule to make sure that there are no empty paths in an OpenAPI.
  • **[Limit Number of Paths] - This is a Spectral governance rule to make sure that there aren't too many paths in an OpenAPI.
  • **[Limit Number of Sub-resources] - This is a Spectral governance rule to make sure that there aren't too many sub-resources in an OpenAPI.
  • **[No Trailing Slash on Paths] - This is a Spectral governance rule to make sure that there are no trailing slashes on paths in an OpenAPI.
  • **[Trailing Slash on Paths] - This is a Spectral governance rule to make sure that there are trailing slashes on paths in an OpenAPI.
  • **[ Have GET Method] - Needs a summary.
  • **[Operations Description Length] - This is a Spectral governance rule to enforce the length of API operation descriptions within an OpenAPI.
  • **[Operations Description Words Check] - This is a Spectral governance rule to make sure that some words are never used in the description of operations within an OpenAPI.
  • **[Operations Description] - This is a Spectral governance rule to make sure that some words are never used in the description of operations within an OpenAPI.
  • **[Operations Operation IDs Camel Case] - This is a Spectral governance rule to make sure that operation Ids are camel case.
  • **[Operations Operation IDs Kebab Case] - This is a Spectral governance rule to make sure that operation Ids are kebab case.
  • **[Operations Operation IDs Pascal Case] - This is a Spectral governance rule to make sure that operation Ids are pascal case.
  • **[Operations Summary Length] - This is a Spectral governance rule to make sure that operation summaries are not too long.
  • **[Operations Summary Period None] - This is a Spectral governance rule to make sure that operation summaries do not have a ending period.
  • **[Operations Summary Words Check] - This is a Spectral governance rule to make sure that operation summaries do not contain specific words.
  • **[Operations Summary] - This is a Spectral governance rule to make sure that all operations have summaries.
  • **[Operations Tags One] - This is a Spectral governance rule to make sure that all operations have at least one tag.
  • **[Operations Tags] - This is a Spectral governance rule to make sure that all operations have a tags property.
  • **[Parameters Description Length] - This is a Spectral governance rule to make sure that all parameters description are not too long.
  • **[Parameters Description Word Check] - This is a Spectral governance rule to make sure that some words aren't used in parameter description.
  • **[Parameters Description] - This is a Spectral governance rule to make sure that all parameters have a description in an OpenAPI.
  • **[Parameters Example] - This is a Spectral governance rule to make sure that all parameters have an example in an OpenAPI.
  • **[Parameters In] - This is a Spectral governance rule to make sure that all parameters have an in property within an OpenAPI.
  • **[Parameters Name Length] - This is a Spectral governance rule to make sure that all parameter aren't too long within an OpenAPI.
  • **[Parameters Name Camel Case] - This is a Spectral governance rule to make sure that all parameter names are camel case within an OpenAPI.
  • **[Parameters Name Pascal Case] - This is a Spectral governance rule to make sure that all parameter names are pascal case within an OpenAPI.
  • **[Parameters Name Snake Case] - This is a Spectral governance rule to make sure that all parameter names are snake case within an OpenAPI.
  • **[Parameters Name Word Check] - This is a Spectral governance rule to make sure that some words aren't used for parameter names in an OpenAPI.
  • **[Parameters Name] - This is a Spectral governance rule to make sure that all parameters a name in an OpenAPI.
  • **[Parameters Schema] - This is a Spectral governance rule to make sure that all parameters have a schema defined in an OpenAPI.
  • **[Parameters Schema Type] - This is a Spectral governance rule to make sure that all parameters have a schema type in an OpenAPI.
  • **[Parameters Schema Type Array] - This is a Spectral governance rule to make sure that all parameters with schema type of array have items defined in an OpenAPI.
  • **[No Request Body on GET] - This is a Spectral governance rule to make sure that no GET method has a request body in an OpenAPI.
  • **[Request Body on POST] - This is a Spectral governance rule to make sure that POST methods have a request body in an OpenAPI.
  • **[Request Body JSON Media Type on POST] - This is a Spectral governance rule to make sure that POST methods have an application/json media type for the request body in an OpenAPI.
  • **[Request Body on PUT] - This is a Spectral governance rule to make sure that PUT methods have a request body in an OpenAPI.
  • **[Request Body JSON Media Type on PUT] - This is a Spectral governance rule to make sure that PUT methods have an application/json media type for the request body in an OpenAPI.
  • **[Request Body on PATCH] - This is a Spectral governance rule to make sure that PATCH methods have a request body in an OpenAPI.
  • **[Request Body JSON Media Type on PATCH] - This is a Spectral governance rule to make sure that PATCH methods have an application/json media type for the request body in an OpenAPI.
  • **[No Request Body on DELETE] - This is a Spectral governance rule to make sure that no DELETE method has a request body in an OpenAPI.
  • **[ Have Request Body Examples] - This is a Spectral governance rule to enforce that all OpenAPI request bodies have an example present, showing what is expected when a request body is submitted as part of an API request.
  • **[Response GET 200 Status Code] - This is a Spectral governance rule to make sure that GET methods all have a 200 status code response in an OpenAPI.
  • **[Response GET 200 Media Type] - This is a Spectral governance rule to make sure that GET methods all have a 200 status code response with application/json media type in an OpenAPI.
  • **[Response GET 500 Status Code] - This is a Spectral governance rule to make sure that GET methods all have a 500 status code response in an OpenAPI.
  • **[Response GET 500 Problem JSON Media Type] - This is a Spectral governance rule to make sure that GET methods all have a 200 status code response with application/problem+json media type in an OpenAPI.
  • **[Response POST 201 Status Code] - This is a Spectral governance rule to make sure that POST methods all have a 201 status code response in an OpenAPI.
  • **[Response POST 201 Media Type] - This is a Spectral governance rule to make sure that POST methods all have a 201 status code response with application/json media type in an OpenAPI.
  • **[Response POST 500 Status Code] - This is a Spectral governance rule to make sure that POST methods all have a 500 status code response in an OpenAPI.
  • **[Response POST 500 Problem JSON Media Type] - This is a Spectral governance rule to make sure that POST methods all have a 500 status code response with application/json media type in an OpenAPI.
  • **[Response PUT 204 Status Code] - This is a Spectral governance rule to make sure that PUT methods all have a 204 status code response in an OpenAPI.
  • **[Response PUT 204 No Body] - This is a Spectral governance rule to make sure that PUT methods do not have a response body in an OpenAPI.
  • **[Response PUT 500 Status Code] - This is a Spectral governance rule to make sure that PUT methods all have a 500 status code response in an OpenAPI.
  • **[Response PUT 204 Problem JSON Media Type] - This is a Spectral governance rule to make sure that PUT methods all have a 500 status code response with application/json media type in an OpenAPI.
  • **[Response PATCH 204 Status Code] - This is a Spectral governance rule to make sure that PATCH methods all have a 204 status code response in an OpenAPI.
  • **[Response PATCH 204 No Body] - This is a Spectral governance rule to make sure that PATCH methods do not have a response body in an OpenAPI.
  • **[Response PATCH 500 Status Code] - This is a Spectral governance rule to make sure that PATCH methods all have a 500 status code response in an OpenAPI.
  • **[Response PATCH 204 Problem JSON Media Type] - This is a Spectral governance rule to make sure that PATCH methods all have a 500 status code response with application/json media type in an OpenAPI.
  • **[Response DELETE 204 Status Code] - This is a Spectral governance rule to make sure that DELETE methods all have a 204 status code response in an OpenAPI.
  • **[Response DELETE 204 No Body] - This is a Spectral governance rule to make sure that DELETE methods do not have a response body in an OpenAPI.
  • **[Response DELETE 500 Status Code] - This is a Spectral governance rule to make sure that DELETE methods all have a 500 status code response in an OpenAPI.
  • **[Response DELETE 204 Problem JSON Media Type] - This is a Spectral governance rule to make sure that DELETE methods all have a 500 status code response with application/json media type in an OpenAPI.
  • **[Responses Schema Object] - This is a Spectral governance rule to make sure that all responses have schema defined in an OpenAPI.
  • **[Use of Response Schema oneOf] - This is a Spectral governance rule to enforce that check to see if oneOf property is being used as part of the schema for any OpenAPI.
  • **[Use of Response Schema anyOf] - This is a Spectral governance rule to enforce that check to see if anyOf property is being used as part of the schema for any OpenAPI.
  • **[Responses Examples] - This is a Spectral governance rule to make sure that all responses have examples in an OpenAPI.
  • **[Response Rate Limit Headers] - This is a Spectral governance rule to enforce that the OpenAPI possesses rate limit headers.
  • **[Schema Names Length] - This is a Spectral governance rule to make sure that all schema names in an OpenAPI are not too long.
  • **[Schema Names Camel Case] - This is a Spectral governance rule to make sure that all schema names in an OpenAPI are camel case.
  • **[Schema Names Pascal Case] - This is a Spectral governance rule to make sure that all schema names in an OpenAPI are pascal case.
  • **[Schema Names Snake Case] - This is a Spectral governance rule to make sure that all schema names in an OpenAPI are snake case.
  • **[Schema Names Words] - This is a Spectral governance rule to make sure that some words aren't used in schema names within OpenAPI definitions.
  • **[Schema Description] - This is a Spectral governance rule to make sure that all schema in an OpenAPI have a description..
  • **[Schema Description Length] - This is a Spectral governance rule to make sure that all schema in an OpenAPI do not have too long of descriptions.
  • **[Schema Description Words] - This is a Spectral governance rule to make sure that all schema in an OpenAPI do not contain certain words within the description..
  • **[Schema Properties] - This is a Spectral governance rule to make sure that all schema have properties within OpenAPI definitions.
  • **[Schema Properties Descriptions Length] - This is a Spectral governance rule to make sure that schema property descriptions are too long within OpenAPI definitions.
  • **[Schema Properties Descriptions Words] - This is a Spectral governance rule to make sure that some words aren't used in schema property descriptions within OpenAPI definitions.
  • **[Schema Properties Descriptions] - This is a Spectral governance rule to make sure that all schema properties have descriptions within OpenAPI definitions.
  • **[Schema Properties Names Length] - This is a Spectral governance rule to make sure that all schema property names are not too long within OpenAPI definitions.
  • **[Schema Properties Names Camel Case] - This is a Spectral governance rule to make sure that all schema property names are camel case within OpenAPI definitions.
  • **[Schema Properties Names Pascal Case] - This is a Spectral governance rule to make sure that all schema property names are pascal case within OpenAPI definitions.
  • **[Schema Properties Names Snake Case] - This is a Spectral governance rule to make sure that all schema property names are snake case within OpenAPI definitions.
  • **[Schema Properties Names Words] - This is a Spectral governance rule to make sure that some words are not used for schema property names within OpenAPI definitions.
  • **[Schema Properties Type] - This is a Spectral governance rule to make sure that schema properties have a type defined within OpenAPI definitions.
  • **[Schema Properties Allowed Integer Format] - This is a Spectral governance rule to enforce that OpenAPI properties that use integer type have a format of int32 or int64.
  • **[Schema Properties Allowed Number Format] - This is a Spectral governance rule to enforce that OpenAPI properties that use number type have a format of decimal32, decimal64, float, double, or decimal128.
  • **[Schema Properties Define Array Boundaries] - This is a Spectral governance rule to enforce that arrays in an OpenAPI always have minimum and maximum boundaries define, preventing these properties from being overloaded.
  • **[Schema Properties Define Number Boundaries] - This is a Spectral governance rule to enforce that the numeric properties within an OpenAPI all have boundaries defined.
  • **[Schema Required] - This is a Spectral governance rule to make sure that all schema have a required property within OpenAPI definitions.
  • **[Schema Type] - This is a Spectral governance rule to make sure that all schema have a required property within OpenAPI definitions.
  • **[Schema Additional Properties] - This is a Spectral governance rule to enforce that schema objects do not have additional properties enabled for each OpenAPI.
  • **[Tags Name] - This is a Spectral governance rule to make sure that all tags have a name within OpenAPI definitions.
  • **[Tags Object] - This is a Spectral governance rule to make sure that there is a central tag object within OpenAPI definitions.
  • **[Tags One] - This is a Spectral governance rule to make sure that there is at least one tag within OpenAPI definitions.
  • **[Tags Description] - This is a Spectral governance rule to make sure that all tags have a description within OpenAPI definitions.
  • **[ Components Parameters Camel Case] - This is a Spectral governance rule to enforce that the OpenAPI parameters within the components object are all using camel case for the key.
  • **[ Components Examples Camel Case] - This is a Spectral governance rule to enforce that the OpenAPI example within the components object are all using camel case for the key.
  • **[ Components Request Bodies Camel Case] - This is a Spectral governance rule to enforce that the OpenAPI request bodies within the components object are all using camel case for the key.
  • **[ Components Schemas Camel Case] - This is a Spectral governance rule to enforce that the OpenAPI schemas within the components object are all using camel case for the key.
  • **[ Components Responses Camel Case] - This is a Spectral governance rule to enforce that the OpenAPI responses within the components object are all using camel case for the key.
  • **[ Components Links Camel Case] - This is a Spectral governance rule to enforce that the OpenAPI links within the components object are all using camel case for the key.
  • **[ Components Callbacks Camel Case] - This is a Spectral governance rule to enforce that the OpenAPI callbacks within the components object are all using camel case for the key.
  • **[ Components Parameters Pascal Case] - This is a Spectral governance rule to enforce that the OpenAPI parameters within the components object are all using pascal case for the key.
  • **[ Components Examples Pascal Case] - This is a Spectral governance rule to enforce that the OpenAPI example within the components object are all using pascal case for the key.
  • **[ Components Request Bodies Pascal Case] - This is a Spectral governance rule to enforce that the OpenAPI request bodies within the components object are all using pascal case for the key.
  • **[ Components Schemas Pascal Case] - This is a Spectral governance rule to enforce that the OpenAPI schemas within the components object are all using pascal case for the key.
  • **[ Components Responses Pascal Case] - This is a Spectral governance rule to enforce that the OpenAPI responses within the components object are all using pascal case for the key.
  • **[ Components Links Pascal Case] - This is a Spectral governance rule to enforce that the OpenAPI links within the components object are all using pascal case for the key.
  • **[ Components Callbacks Pascal Case] - This is a Spectral governance rule to enforce that the OpenAPI callbacks within the components object are all using pascal case for the key.
  • **[ Components Parameters Kebab Case] - This is a Spectral governance rule to enforce that the OpenAPI parameters within the components object are all using kebab case for the key.
  • **[ Components Examples Kebab Case] - This is a Spectral governance rule to enforce that the OpenAPI example within the components object are all using kebab case for the key.
  • **[ Components Request Bodies Kebab Case] - This is a Spectral governance rule to enforce that the OpenAPI request bodies within the components object are all using kebab case for the key.
  • **[ Components Schemas Kebab Case] - This is a Spectral governance rule to enforce that the OpenAPI schemas within the components object are all using kebab case for the key.
  • **[ Components Responses Kebab Case] - This is a Spectral governance rule to enforce that the OpenAPI responses within the components object are all using kebab case for the key.
  • **[ Components Links Kebab Case] - This is a Spectral governance rule to enforce that the OpenAPI links within the components object are all using kebab case for the key.
  • **[ Components Callbacks Kebab Case] - This is a Spectral governance rule to enforce that the OpenAPI callbacks within the components object are all using kebab case for the key.
  • **[ Components Parameters Snake Case] - This is a Spectral governance rule to enforce that the OpenAPI parameters within the components object are all using snake case for the key.
  • **[ Components Examples Snake Case] - This is a Spectral governance rule to enforce that the OpenAPI example within the components object are all using snake case for the key.
  • **[ Components Request Bodies Snake Case] - This is a Spectral governance rule to enforce that the OpenAPI request bodies within the components object are all using snake case for the key.
  • **[ Components Schemas Snake Case] - This is a Spectral governance rule to enforce that the OpenAPI schemas within the components object are all using snake case for the key.
  • **[ Components Responses Snake Case] - This is a Spectral governance rule to enforce that the OpenAPI responses within the components object are all using snake case for the key.
  • **[ Components Links Snake Case] - This is a Spectral governance rule to enforce that the OpenAPI links within the components object are all using snake case for the key.
  • **[ Components Callbacks Snake Case] - This is a Spectral governance rule to enforce that the OpenAPI callbacks within the components object are all using snake case for the key.
  • **[ Request Body Schema Components] - This is a Spectral governance rule to enforce that the OpenAPI request body schema are all centralized as a component.
  • **[ Request Body Examples Components] - This is a Spectral governance rule to enforce that the OpenAPI request body examples are all centralized as a component.
  • **[ Responses Schema Components] - This is a Spectral governance rule to enforce that the OpenAPI response schema are all centralized as a component.
  • **[ Responses Examples Components] - This is a Spectral governance rule to enforce that the OpenAPI response examples are all centralized as a component.
  • **[ Security Scheme Sigv4] - This is a Spectral governance rule to enforce that Sigv4 security is applied to the OpenAPI.
  • **[ Security Scheme Access Token] - This is a Spectral governance rule to enforce that access token security is applied to the OpenAPI.
  • **[ Security Scheme API Key] - This is a Spectral governance rule to enforce that API key security is applied to the OpenAPI.
  • **[ Security Scheme API Secret] - This is a Spectral governance rule to enforce that API secret security is applied to the OpenAPI.
  • **[ Security Scheme Basic] - This is a Spectral governance rule to enforce that basic security is applied to the OpenAPI.
  • **[ Security Scheme OAuth Implicit] - This is a Spectral governance rule to enforce that OAuth implicit security is applied to the OpenAPI.
  • **[ Security Scheme OAuth2 Password] - This is a Spectral governance rule to enforce that OAuth2 implicit security is applied to the OpenAPI.
  • **[ Security Scheme OAuth] - This is a Spectral governance rule to enforce that OAuth security is applied to the OpenAPI.

Swagger 2.0 Linting Rules

These are Spectral rules for linting Swagger files as part of API governance efforts.
  • **[Info Title] - This is a Spectral governance rule to enforce that Swagger has an info title.
  • **[Info Title In Kebab Case] - This is a Spectral governance rule to enforce that Swagger info title is in kebab case.
  • **[Info Title Max Length] - This is a Spectral governance rule to enforce that Swagger info title is under a maximum length.
  • **[Info Title Word Check] - This is a Spectral governance rule to enforce that Swagger info title doesn't contain certain words.
  • **[Info Description Max Length] - This is a Spectral governance rule to enforce that an Swagger information object description meet a specific length requirement, making sure that descriptions aren't too long, and provide the precise right amount of information for consumers..
  • **[ Info Description Word Check] - This is a Spectral governance rule to enforce that an Swagger information object description does not contain certain words.
  • **[ Info Description] - This is a Spectral governance rule to enforce that an Swagger has a description included as part of the information object, making sure there is as much detail about what an API does available for consumers.
  • **[Info Contact] - This is a Spectral governance rule to enforce that Swagger info object has a contact.
  • **[Info Contact Email] - This is a Spectral governance rule to enforce that Swagger info object has a contact email.
  • **[Info Contact Name] - This is a Spectral governance rule to enforce that Swagger info object has a contact name.
  • **[Info Contact Url] - This is a Spectral governance rule to enforce that Swagger info object has a contact url.
  • **[Info License] - This is a Spectral governance rule to enforce that Swagger info object has a license.
  • **[Info License Name] - This is a Spectral governance rule to enforce that Swagger info object has a license name.
  • **[Info License Url] - This is a Spectral governance rule to enforce that Swagger info object has a license url.
  • **[Info License Url Apache] - This is a Spectral governance rule to enforce that Swagger info object has an Apache license.
  • **[Info License Url Mit] - This is a Spectral governance rule to enforce that Swagger info object has an MIT license.
  • **[Info Terms Of Service] - This is a Spectral governance rule to enforce that Swagger info object has a terms of service.
  • **[Info X API Id] - This is a Spectral governance rule to enforce that the Swagger info has an API ID extension.
  • **[Info X Audience] - This is a Spectral governance rule to enforce that the Swagger info has an audience extension.
  • **[Swagger Version] - This is a Spectral governance rule to make sure that a specific version of Swagger is being used.
  • **[Info Version] - This is a Spectral governance rule to enforce that Swagger has an info version.
  • **[Version Date Format] - This is a Spectral governance rule to make sure that there is at data version applied within Swagger definitions.
  • **[Version Semantic] - An API governance linting rule to enforce that semantic versioning has been applied to an Swagger, making sure that all teams are using the same versioning patterns, and all APIs are being versioned.
  • **[Version Second Segment] - This is a Spectral governance rule to make sure that the second segment of the path a version.
  • **[ HTTPS Only] - This is a Spectral governance rule to enforce that Swagger definition is only using HTTPS for the server protocol.
  • **[ Produce JSON Media Type] - This is a Spectral governance rule to make sure that a Swagger definition produces a application/json media type.
  • **[ Produce XML Media Type] - This is a Spectral governance rule to make sure that a Swagger definition produces a application/xml media type.
  • **[ Consume JSON Media Type] - This is a Spectral governance rule to enforce that a Swagger consumes application/json media types.
  • **[ Consume XML Media Type] - This is a Spectral governance rule to enforce that a Swagger consumes application/xml media types.
  • **[ Produce JSON Media Type] - This is a Spectral governance rule to enforce that a Swagger produces application/json media types.
  • **[ Produce XML Media Type] - This is a Spectral governance rule to enforce that a Swagger produces application/xml media types.
  • **[Do Not Use API for Base Path] - This is a Spectral governance rule to make sure that /api is not used as base path in an Swagger.
  • **[No Path Dashes] - This is a Spectral governance rule to make sure that paths should not contain dashes in an Swagger.
  • **[No Empty Paths] - This is a Spectral governance rule to make sure that there are no empty paths in an Swagger.
  • **[Limit Number of Paths] - This is a Spectral governance rule to make sure that there aren't too many paths in an Swagger.
  • **[Limit Number of Sub-resources] - This is a Spectral governance rule to make sure that there aren't too many sub-resources in an Swagger.
  • **[No Trailing Slash on Paths] - This is a Spectral governance rule to make sure that there are no trailing slashes on paths in an Swagger.
  • **[Trailing Slash on Paths] - This is a Spectral governance rule to make sure that there are trailing slashes on paths in an Swagger.
  • **[ Have GET Method] - Needs a summary.
  • **[Operations Description Length] - This is a Spectral governance rule to enforce the length of API operation descriptions within an Swagger.
  • **[Operations Description Words Check] - This is a Spectral governance rule to make sure that some words are never used in the description of operations within an Swagger.
  • **[Operations Description] - This is a Spectral governance rule to make sure that some words are never used in the description of operations within an Swagger.
  • **[Operations Operation IDs Camel Case] - This is a Spectral governance rule to make sure that operation Ids are camel case.
  • **[Operations Operation IDs Kebab Case] - This is a Spectral governance rule to make sure that operation Ids are kebab case.
  • **[Operations Operationids Pascal Case] - This is a Spectral governance rule to make sure that operation Ids are pascal case.
  • **[Operations Summary Length] - This is a Spectral governance rule to make sure that operation summaries are not too long.
  • **[Operations Summary Period None] - This is a Spectral governance rule to make sure that operation summaries do not have a ending period.
  • **[Operations Summary Words Check] - This is a Spectral governance rule to make sure that operation summaries do not contain specific words.
  • **[Operations Summary] - This is a Spectral governance rule to make sure that all operations have summaries.
  • **[Operations Tags One] - This is a Spectral governance rule to make sure that all operations have at least one tag.
  • **[Operations Tags] - This is a Spectral governance rule to make sure that all operations have a tags property.
  • **[Parameters Description Length] - This is a Spectral governance rule to make sure that all parameters description are not too long.
  • **[Parameters Description Word Check] - This is a Spectral governance rule to make sure that some words aren't used in parameter description.
  • **[Parameters Description] - This is a Spectral governance rule to make sure that all parameters have a description in an Swagger.
  • **[Parameters Example] - This is a Spectral governance rule to make sure that all parameters have an example in an Swagger.
  • **[Parameters In] - This is a Spectral governance rule to make sure that all parameters have an in property within an Swagger.
  • **[Parameters Name Length] - This is a Spectral governance rule to make sure that all parameter aren't too long within an Swagger.
  • **[Parameters Name Camel Case] - This is a Spectral governance rule to make sure that all parameter names are camel case within an Swagger.
  • **[Parameters Name Pascal Case] - This is a Spectral governance rule to make sure that all parameter names are pascal case within an Swagger.
  • **[Parameters Name Snake Case] - This is a Spectral governance rule to make sure that all parameter names are snake case within an Swagger.
  • **[Parameters Name Word Check] - This is a Spectral governance rule to make sure that some words aren't used for parameter names in an Swagger.
  • **[Parameters Name] - This is a Spectral governance rule to make sure that all parameters a name in an Swagger.
  • **[Parameters Schema] - This is a Spectral governance rule to make sure that all parameters have a schema defined in an Swagger.
  • **[Parameters Schema Type] - This is a Spectral governance rule to make sure that all parameters have a schema type in an Swagger.
  • **[Parameters Schema Type Array] - This is a Spectral governance rule to make sure that all parameters with schema type of array have items defined in an Swagger.
  • **[No Request Body on GET] - This is a Spectral governance rule to make sure that no GET method has a request body in an Swagger.
  • **[Request Body on POST] - This is a Spectral governance rule to make sure that POST methods have a request body in an Swagger.
  • **[Request Body on PUT] - This is a Spectral governance rule to make sure that PUT methods have a request body in an Swagger.
  • **[Request Body on PATCH] - This is a Spectral governance rule to make sure that PATCH methods have a request body in an Swagger.
  • **[No Request Body on DELETE] - This is a Spectral governance rule to make sure that no DELETE method has a request body in an Swagger.
  • **[Response GET 200 Status Code] - This is a Spectral governance rule to make sure that GET methods all have a 200 status code response in an Swagger.
  • **[Response GET 500 Status Code] - This is a Spectral governance rule to make sure that GET methods all have a 500 status code response in an Swagger.
  • **[Response POST 201 Status Code] - This is a Spectral governance rule to make sure that POST methods all have a 201 status code response in an Swagger.
  • **[Response POST 500 Status Code] - This is a Spectral governance rule to make sure that POST methods all have a 500 status code response in an Swagger.
  • **[Response PUT 204 Status Code] - This is a Spectral governance rule to make sure that PUT methods all have a 204 status code response in an Swagger.
  • **[Response PUT 204 No Body] - This is a Spectral governance rule to make sure that PUT methods do not have a response body in an Swagger.
  • **[Response PUT 500 Status Code] - This is a Spectral governance rule to make sure that PUT methods all have a 500 status code response in an Swagger.
  • **[Response PATCH 204 Status Code] - This is a Spectral governance rule to make sure that PATCH methods all have a 204 status code response in an Swagger.
  • **[Response PATCH 204 No Body] - This is a Spectral governance rule to make sure that PATCH methods do not have a response body in an Swagger.
  • **[Response PATCH 500 Status Code] - This is a Spectral governance rule to make sure that PATCH methods all have a 500 status code response in an Swagger.
  • **[Response DELETE 204 Status Code] - This is a Spectral governance rule to make sure that DELETE methods all have a 204 status code response in an Swagger.
  • **[Response DELETE 204 No Body] - This is a Spectral governance rule to make sure that DELETE methods do not have a response body in an Swagger.
  • **[Response DELETE 500 Status Code] - This is a Spectral governance rule to make sure that DELETE methods all have a 500 status code response in an Swagger.
  • **[Schema Names Length] - This is a Spectral governance rule to make sure that all schema names in an Swagger are not too long.
  • **[Schema Names Camel Case] - This is a Spectral governance rule to make sure that all schema names in an Swagger are camel case.
  • **[Schema Names Pascal Case] - This is a Spectral governance rule to make sure that all schema names in an Swagger are pascal case.
  • **[Schema Names Snake Case] - This is a Spectral governance rule to make sure that all schema names in an Swagger are snake case.
  • **[Schema Names Words] - This is a Spectral governance rule to make sure that some words aren't used in schema names within Swagger definitions.
  • **[Schema Description] - This is a Spectral governance rule to make sure that all schema in an Swagger have a description..
  • **[Schema Description Length] - This is a Spectral governance rule to make sure that all schema in an Swagger do not have too long of descriptions.
  • **[Schema Description Words] - This is a Spectral governance rule to make sure that all schema in an Swagger do not contain certain words within the description..
  • **[Schema Properties] - This is a Spectral governance rule to make sure that all schema have properties within Swagger definitions.
  • **[Schema Properties Descriptions Length] - This is a Spectral governance rule to make sure that schema property descriptions are too long within Swagger definitions.
  • **[Schema Properties Descriptions Words] - This is a Spectral governance rule to make sure that some words aren't used in schema property descriptions within Swagger definitions.
  • **[Schema Properties Descriptions] - This is a Spectral governance rule to make sure that all schema properties have descriptions within Swagger definitions.
  • **[Schema Properties Names Length] - This is a Spectral governance rule to make sure that all schema property names are not too long within Swagger definitions.
  • **[Schema Properties Names Camel Case] - This is a Spectral governance rule to make sure that all schema property names are camel case within Swagger definitions.
  • **[Schema Properties Names Pascal Case] - This is a Spectral governance rule to make sure that all schema property names are pascal case within Swagger definitions.
  • **[Schema Properties Names Snake Case] - This is a Spectral governance rule to make sure that all schema property names are snake case within Swagger definitions.
  • **[Schema Properties Names Words] - This is a Spectral governance rule to make sure that some words are not used for schema property names within Swagger definitions.
  • **[Schema Properties Type] - This is a Spectral governance rule to make sure that schema properties have a type defined within Swagger definitions.
  • **[Schema Properties Allowed Integer Format] - This is a Spectral governance rule to enforce that Swagger properties that use integer type have a format of int32 or int64.
  • **[Schema Properties Allowed Number Format] - This is a Spectral governance rule to enforce that Swagger properties that use number type have a format of decimal32, decimal64, float, double, or decimal128.
  • **[Schema Properties Define Array Boundaries] - This is a Spectral governance rule to enforce that arrays in an Swagger always have minimum and maximum boundaries define, preventing these properties from being overloaded.
  • **[Schema Properties Define Number Boundaries] - This is a Spectral governance rule to enforce that the numeric properties within an Swagger all have boundaries defined.
  • **[Schema Required] - This is a Spectral governance rule to make sure that all schema have a required property within Swagger definitions.
  • **[Schema Type] - This is a Spectral governance rule to make sure that all schema have a required property within Swagger definitions.
  • **[Schema Additional Properties] - This is a Spectral governance rule to enforce that schema objects do not have additional properties enabled for each Swagger.
  • **[Tags Name] - This is a Spectral governance rule to make sure that all tags have a name within Swagger definitions.
  • **[Tags Object] - This is a Spectral governance rule to make sure that there is a central tag object within Swagger definitions.
  • **[Tags One] - This is a Spectral governance rule to make sure that there is at least one tag within Swagger definitions.
  • **[Tags Description] - This is a Spectral governance rule to make sure that all tags have a description within Swagger definitions.
  • **[Security API Key] - This is a Spectral governance rule to enforce that API key security is applied to the Swagger.
  • **[Security Basic] - This is a Spectral governance rule to enforce that basic security is applied to the Swagger.
  • **[Security Oauth2] - This is a Spectral governance rule to enforce that OAuth 2.0 security is applied to the Swagger.
  • **[Security in Query] - This is a Spectral governance rule to enforce that basic security is applied to the Swagger using query parameter.
  • **[Security in Header] - This is a Spectral governance rule to enforce that basic security is applied to the Swagger using header.
  • **[Security Applied to Operations] - This is a Spectral governance rule to enforce that security is applied to all operations.