OpenAPI (formerly known as Swagger) is a specification for building, documenting, and consuming RESTful APIs. It defines a standard, language-agnostic format for describing APIs, enabling both humans and machines to understand the capabilities of a service without accessing its source code, using the following properties. * **Endpoints and Methods** - Defines HTTP methods like GET, POST, PUT, and DELETE. * **Parameters and Responses** - Specifies query parameters, headers, and response formats. * **Schemas** - Provides reusable data models for request and response payloads. * **Security Schemes** - Describes authentication methods such as OAuth 2.0 and API Keys. * **Tags and Metadata** - Groups related endpoints and adds descriptions for clarity. While OpenAPI is used in many different aspects of operations it is best known for a handful of common experiences for both API producers and consumers. * **API Design** - Define and validate APIs before implementation. * **API Documentation** - Generate user-friendly documentation that simplifies adoption. * **API Testing and Mocking** - Simulate API behavior during development. * **API Client SDK Generation** - Automatically create SDKs for different languages. * **API Automation** - Enable DevOps practices like CI/CD with automated tests and deployments. OpenAPI simplifies API design, documentation, testing, and integration through a standardized and machine-readable format. It improves developer collaboration, speeds up development, and ensures consistent and reliable APIs, making it a cornerstone of the enterprise HTTP API toolbox. The technical details of any HTTP API should be defined as OpenAPI, then extended and enriched using OpenAPI overlays throughout the API lifecycle. OpenAPI describes the technical details of individual APIs, but when done at scale across the enterprise, it provides an effective blueprint regarding what the enterprise is capable of.
OpenAPI
Resources
Related Rules
OpenAPI Components Examples Error
Utilizing an example object in the centralized OpenAPI components library helps make examples reusable across API requests and responses
OpenAPI Components Examples Info
Utilizing an example object in the centralized OpenAPI components library helps make examples reusable across API requests and responses
OpenAPI Components Headers Error
Utilizing the headers object in the centralized OpenAPI components library helps make headers reusable across API requests and responses
OpenAPI Components Headers Info
Utilizing the headers object in the centralized OpenAPI components library helps make headers reusable across API requests and responses
OpenAPI Components Headers Rate Limit Error
Utilizing centralized headers rate limits allows you to reuse headers across all API requests and responses, enabling a more organized approach to handling the transport and rate limits applied con...
OpenAPI Components Headers Rate Limit Info
Utilizing centralized headers rate limits allows you to reuse headers across all API requests and responses, enabling a more organized approach to handling the transport and rate limits applied con...
OpenAPI Components Headers Retry After Error
Utilizing centralized retry after headers allows you to reuse headers across all API requests and responses, enabling a more organized approach to handling the transport and rate limiting applied c...
OpenAPI Components Headers Retry After Info
Utilizing centralized retry after headers allows you to reuse headers across all API requests and responses, enabling a more organized approach to handling the transport and rate limiting applied c...
OpenAPI Components Parameters Casing Camel Error
Giving parameters with consistent naming helps make it easier for API consumers to understand how they are able to configure their API requests
OpenAPI Components Parameters Casing Camel Info
Giving parameters with consistent naming helps make it easier for API consumers to understand how they are able to configure their API requests
OpenAPI Components Parameters Description Error
You need a parameters description provides more depth to what a parameter does and will be displayed via documentation, and other tooling used across the API lifecycle
OpenAPI Components Parameters Description Info
You need a parameters description provides more depth to what a parameter does and will be displayed via documentation, and other tooling used across the API lifecycle
OpenAPI Components Parameters Description Length Error
Limiting the length of parameters description forces us to be more concise in how we describe each parameter, while keeping our documentation and other ways descriptions show up in discovery and po...
OpenAPI Components Parameters Enum Casing Error
Keeping parameters enumerator casing consistent across APIs helps reduce confusion by consumers, and can keep aligned with services and applications putting an API to work
OpenAPI Components Parameters Enum Casing Info
Keeping parameters enumerator casing consistent across APIs helps reduce confusion by consumers, and can keep aligned with services and applications putting an API to work
OpenAPI Components Parameters Enum Info
Giving enums for your parameters helps reduce errors and keeps the inputs for your API requests more consistent for consumers
OpenAPI Components Parameters Error
You need a components parameters object allows all parameters used across an API to be centralized, allowing for reuse and easier governance of the parameters used to configure API requests
OpenAPI Components Parameters Example Error
Parameters must always possess a example to help define the format and shape of the parameter, setting expections with consumers about what needs to be passed in
OpenAPI Components Parameters Example Info
Parameters must always possess a example to help define the format and shape of the parameter, setting expections with consumers about what needs to be passed in
OpenAPI Components Parameters In Error
Giving an in property for parameters gets explicit about whether a parameter is in the path, query, or a header, making it clear to consumers where they can configure their request
OpenAPI Components Parameters In Info
Giving an in property for parameters gets explicit about whether a parameter is in the path, query, or a header, making it clear to consumers where they can configure their request
OpenAPI Components Parameters Info
You need a components parameters object allows all parameters used across an API to be centralized, allowing for reuse and easier governance of the parameters used to configure API requests
OpenAPI Components Parameters Name Error
Giving a simple, intuitive, and consistent names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests
OpenAPI Components Parameters Name Info
Giving a simple, intuitive, and consistent names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests
OpenAPI Components Parameters Name Length Error
Giving short and concise names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests
OpenAPI Components Parameters Required Error
Providrequiredg an required property for parameters gets explicit about whether a parameter is required the path, query, or a header, making it clear to consumers where they can configure their req...
OpenAPI Components Parameters Required Info
Providrequiredg an required property for parameters gets explicit about whether a parameter is required the path, query, or a header, makrequiredg it clear to consumers where they can configure the...
OpenAPI Components Parameters Schema Error
Parameters must always possess a schema to help define the format and shape of the parameter, setting expections with consumers about what needs to be passed in
OpenAPI Components Parameters Schema Info
Parameters must always possess a schema to help define the format and shape of the parameter, setting expections with consumers about what needs to be passed in
OpenAPI Components Parameters Schema Items Array Error
Parameters that are of an array type should always have the items defined, being explicit about what is continued as part of the array
OpenAPI Components Parameters Schema Items Array Info
Parameters that are of an array type should always have the items defined, being explicit about what is continued as part of the array
OpenAPI Components Parameters Schema Ref Error
Parameters must always use a schema reference that utilizes reusable schema that are defined as part of a centralized schema components library
OpenAPI Components Parameters Schema Ref Info
Parameters must always use a schema reference that utilizes reusable schema that are defined as part of a centralized schema components library
OpenAPI Components Parameters Schema Type Error
Parameters must always have their schema type defined, being precise about what type of data can be inputted and used to configure an API request
OpenAPI Components Parameters Schema Type Info
Parameters must always have their schema type defined, being precise about what type of data can be inputted and used to configure an API request
OpenAPI Components Parameters Schema Type Integer Maximum Info
Parameters that are of the integer schema type must have their maximum value set, defining the shape of parameter data passed in with a request
OpenAPI Components Parameters Schema Type Integer Maximum Warn
Parameters that are of the integer schema type must have their maximum value set, defining the shape of parameter data passed in with a request
OpenAPI Components Parameters Schema Type Integer Minimum Info
Parameters that are of the integer schema type must have their minimum value set, defining the shape of parameter data passed in with a request
OpenAPI Components Parameters Schema Type Integer Minimum Warn
Parameters that are of the integer schema type must have their minimum value set, defining the shape of parameter data passed in with a request
OpenAPI Components Parameters Schema Type String Maxlength Info
Parameters that are of the type string schema type must have their maximum value set, defining the shape of parameter data passed in with a request
OpenAPI Components Parameters Schema Type String Maxlength Warn
Parameters that are of the string schema type must have their maximum value set, defining the shape of parameter data passed in with a request
OpenAPI Components Parameters Schema Type String Minlength Info
Parameters that are of the string schema type must have their minimum value set, defining the shape of parameter data passed in with a request
OpenAPI Components Parameters Schema Type String Minlength Warn
Parameters that are of the string schema type must have their minimum value set, defining the shape of parameter data passed in with a request
OpenAPI Components Parameters Schema Type String Pattern Info
Parameters that are of the string schema type must have a pattern set, using a regex to define the shape of parameter data passed in with a request
OpenAPI Components Parameters Schema Type String Pattern Warn
Parameters that are of the string schema type must have a pattern set, using a regex to define the shape of parameter data passed in with a request
OpenAPI Components Responses Bad Request Error
You need a bad request responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Bad Request Info
You need a bad request responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Conflict Error
You need a conflict responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Conflict Info
You need a conflict responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Error
Utilizing the responses object in the centralized OpenAPI components library helps make responses reusable across API requests
OpenAPI Components Responses Forbidden Error
You need a forbidden responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Forbidden Info
You need a forbidden responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Info
Utilizing the responses object in the centralized OpenAPI components library helps make responses reusable across API requests
OpenAPI Components Responses Internal Server Error Error
You need a internal server error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Internal Server Error Info
You need a internal server error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Not Found Error
You need a not found error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Not Found Info
You need a not found error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Too Many Requests Error
You need a too many requests error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Too Many Requests Info
You need a too many requests error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Unauthorized Error
You need a unauthorized error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Unauthorized Info
You need a unauthorized error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Schemas Error
Utilizing the schema object in the centralized OpenAPI components library helps make schema reusable across API requests and responses
OpenAPI Components Schemas Info
Utilizing the schema object in the centralized OpenAPI components library helps make schema reusable across API requests and responses
OpenAPI External Docs Error
You need an external documentation link present in the OpenAPI for an API, makes it easy for API producers or consumers to find their way to the rest of the operations and resources available aroun...
OpenAPI External Docs Info
You need an external documentation link present in the OpenAPI for an API, makes it easy for API producers or consumers to find their way to the rest of the operations and resources available aroun...
OpenAPI Info Contact Email Error
You need a contact email address associated with the technical contract so that anyone who comes across the API has someone to email and get more information
OpenAPI Info Contact Email Info
You need a contact email address associated with the technical contract so that anyone who comes across the API has someone to email and get more information
OpenAPI Info Contact Error
You need a contact object associated with the technical contract so that anyone who comes across the API has someone to contact and get more information
OpenAPI Info Contact Info
You need a contact object associated with the technical contract so that anyone who comes across the API has someone to contact and get more information
OpenAPI Info Contact Name Error
You need a contact name associated with the technical contract so that anyone who comes across the API knows who to contact
OpenAPI Info Contact Name Info
You need a contact name associated with the technical contract so that anyone who comes across the API knows who to contact
OpenAPI Info Contact Url Error
You need a contact url associated with the technical contract so that anyone who comes across the API knows where to go to contact someone
OpenAPI Info Contact Url Info
You need a contact url associated with the technical contract so that anyone who comes across the API knows where to go to contact someone
OpenAPI Info Description Error
You need a detailed description as part of the OpenAPI info object helps describe what a collection of paths and operations does for consumers, giving a short, concise, and relevant couple of parag...
OpenAPI Info Description Eval Tag Error
Eval functions MUST not be included in the description of an API, keeping descriptions to just the text that is needed, and relying on the rest of the OpenAPI to describe what is possible.
OpenAPI Info Description Eval Tag Info
Eval functions MUST not be included in the description of an API, keeping descriptions to just the text that is needed, and relying on the rest of the OpenAPI to describe what is possible.
OpenAPI Info Description Info
You need a detailed description as part of the OpenAPI info object helps describe what a collection of paths and operations does for consumers, giving a short, concise, and relevant couple of parag...
OpenAPI Info Description Length Error
You need a restriction on the length of the API description expressed as the OpenAPI info description helps provide constraints for consumers when adding a description, and keeps portals, landing p...
OpenAPI Info Description Script Tag Error
Script tags MUST not be included in the description of an API, keeping descriptions to just the text that is needed, and relying on the rest of the OpenAPI to describe what is possible.
OpenAPI Info Description Script Tag Info
Script tags MUST not be included in the description of an API, keeping descriptions to just the text that is needed, and relying on the rest of the OpenAPI to describe what is possible.
OpenAPI Info Error
You need an info object provides much of the metadata needed for the collection of APIs described in an OpenAPI
OpenAPI Info Info
You need an info object provides much of the metadata needed for the collection of APIs described in an OpenAPI
OpenAPI Info License Error
You need a license associated with an OpenAPI using the info licensing property so that the legal aspects of licensing the API always travel with the technical contract for an API
OpenAPI Info License Identifier Cc By Nc Sa Error
You need a Create Commons CC BY NC SA license associated with an OpenAPI using the info licensing property so that the legal aspects of licensing the API always travel with the technical contract f...
OpenAPI Info License Identifier Cc By Nc Sa Info
You need a Create Commons CC BY NC SA license associated with an OpenAPI using the info licensing property so that the legal aspects of licensing the API always travel with the technical contract f...
OpenAPI Info License Identifier Error
You need a license identifier associated with an OpenAPI using the info licensing property so that the legal aspects of licensing the API always travel with the technical contract for an API
OpenAPI Info License Identifier Info
You need a license identifier associated with an OpenAPI using the info licensing property so that the legal aspects of licensing the API always travel with the technical contract for an API
OpenAPI Info License Info
You need a license associated with an OpenAPI using the info licensing property so that the legal aspects of licensing the API always travel with the technical contract for an API
OpenAPI Info License Name Error
You need a license name associated with an OpenAPI using the info licensing property so that the legal aspects of licensing the API always travel with the technical contract for an API
OpenAPI Info License Name Info
You need a license name associated with an OpenAPI using the info licensing property so that the legal aspects of licensing the API always travel with the technical contract for an API
OpenAPI Info License Url Error
You need a license url associated with an OpenAPI using the info licensing property so that the legal aspects of licensing the API always travel with the technical contract for an API
OpenAPI Info License Url Info
You need a license url associated with an OpenAPI using the info licensing property so that the legal aspects of licensing the API always travel with the technical contract for an API
OpenAPI Info Terms Of Service Error
You need a terms of service associated with an OpenAPI using the info terms of service property so that the legal aspects of legal side of the API always travel with the technical contract for an API
OpenAPI Info Terms Of Service Info
You need a terms of service associated with an OpenAPI using the info terms of service property so that the legal aspects of legal side of the API always travel with the technical contract for an API
OpenAPI Info Title Error
You need a intuitive and helpful title for your API using the OpenAPI info title is the first impression you will make on the consumers of your API
OpenAPI Info Title Info
You need a intuitive and helpful title for your API using the OpenAPI info title is the first impression you will make on the consumers of your API
OpenAPI Info Title Length Error
You need a limitation on the length of the title for your API helps provide constraints for teams naming it, but also keep consistent with other APIs from across teams
OpenAPI Info Title Upper Case Error
You need a consistent casing for the title for your API helps provide constraints for teams naming the API, but also keep consistent with other APIs from across teams
OpenAPI Info Title Upper Case Info
You need a consistent casing for the title for your API helps provide constraints for teams naming the API, but also keep consistent with other APIs from across teams
OpenAPI Info Version Error
Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using Semantic or date-based versioning published to the info version property
OpenAPI Info Version Info
Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using Semantic or date-based versioning published to the info version property
OpenAPI Method DELETE Error
DELETE HTTP methods needs to be available.
OpenAPI Method DELETE Info
DELETE HTTP methods needs to be available.
OpenAPI Method GET Error
GET HTTP methods needs to be available.
OpenAPI Method GET Info
GET HTTP methods needs to be available.
OpenAPI Method POST Error
POST HTTP methods needs to be available.
OpenAPI Method POST Info
POST HTTP methods needs to be available.
OpenAPI Method PUT Error
PUT HTTP methods needs to be available.
OpenAPI Method PUT Info
PUT HTTP methods needs to be available.
OpenAPI Operation Security Definitions Error
Each API operation needs a security definition referencing the central security scheme express for an OpenAPI
OpenAPI Operation Security Definitions Info
Each API operation needs a security definition referencing the central security scheme express for an OpenAPI
OpenAPI Operation Security Definitions API Keys Error
Each API operation needs a security definition referencing the central security scheme express for an OpenAPI referencing apiKeys property.
OpenAPI Operation Security Definitions API Keys Info
Each API operation needs a security definition referencing the central security scheme express for an OpenAPI referencing apiKeys property.
OpenAPI Operations Description Error
You need a paragraph or two description of each API operation helps API consumers understand what is possible with each API request
OpenAPI Operations Description Info
You need a paragraph or two description of each API operation helps API consumers understand what is possible with each API request
OpenAPI Operations Description Length Error
You need a length limitation for each description of each API operation helps apply constraints to how you describe your APIs, while helping drive consistency across APIs when it comes to search, d...
OpenAPI Operations Operation Ids Camel Case Error
Operation identifiers provide a unique way to identify each individual API, and requiring them to have consistent casing reduces friction when generating SDKs and automating around APIs
OpenAPI Operations Operation Ids Camel Case Info
Operation identifiers provide a unique way to identify each individual API, and requiring them to have consistent casing reduces friction when generating SDKs and automating around APIs
OpenAPI Operations Operation Ids Special Characters Error
Operation identifiers provide a unique way to identify each individual API, and requiring them to have consistent casing reduces friction when generating SDKs and automating around APIs
OpenAPI Operations Operation Ids Special Characters Info
Operation identifiers provide a unique way to identify each individual API, and requiring them to have consistent casing reduces friction when generating SDKs and automating around APIs.
OpenAPI Operations Operation Ids Error
Operation identifiers provide a unique way to identify each individual API, which then used for SDK generation and other automation
OpenAPI Operations Operation Ids Info
Operation identifiers provide a unique way to identify each individual API, which then used for SDK generation and other automation
OpenAPI Operations Summary Error
You need short and intuitive summary for each API operation helps API consumers understand what is possible with each API request
OpenAPI Operations Summary Info
You need short and intuitive summary for each API operation helps API consumers understand what is possible with each API request
OpenAPI Operations Summary Length Error
Apply length constraints to the operation summary helps keep them consistent for publishing in documentation
OpenAPI Operations Summary Period Error
Operation summaries should not have a period, keeping the primary summary for each API as consistent as possible for publishing in documentation
OpenAPI Operations Summary Period Info
Operation summaries should not have a period, keeping the primary summary foreach API as consistent as possible for publishing in documentation.
OpenAPI Operations Tags Error
You need tags applied to each API operations helps organize and group APIs in portals, documentation, search, and other ways in which APIs are made available
OpenAPI Operations Tags Info
You need tags applied to each API operations helps organize and group APIs in portals, documentation, search, and other ways in which APIs are made available
OpenAPI Operations Tags One Error
You need tags applied to each API operations helps organize and group APIs in portals, documentation, search, and other ways in which APIs are made available
OpenAPI Operations Tags Upper Case Error
You need the first letter of each word applied as a tag to API operations helps keep a consistent layout when published via search, documentation, and other ways APIs are made available
OpenAPI Operations Tags Upper Case Info
You need the first letter of each word applied as a tag to API operations helps keep a consistent layout when published via search, documentation, and other ways APIs are made available
OpenAPI Parameters Componentized Error
You need all parameters using the central OpenAPI components parameters object helps increase the reusability of parameters across API operations, but it also help standardize parameter across all ...
OpenAPI Parameters Componentized Info
You need all parameters using the central OpenAPI components parameters object helps increase the reusability of parameters across API operations, but it also help standardize parameter across all ...
OpenAPI Paths API
There are very few situations where you actually want the acronym API in the path of your API, only when it is a resource.
OpenAPI No Api In Path Info
There are very few situations where you actually want the acronym API in the path of your API, only when it is a resource.
OpenAPI Path Declarations Error
There needs to be a paths property and have paths declared, giving the minimum viable definition for an API.
OpenAPI Path Declarations Info
There needs to be a paths property and have paths declared, giving the minimum viable definition for an API.
OpenAPI Path Kebab Case
Path segments needs to be kebab case and not have different casing that could cause other problems.
OpenAPI Path Kebab Case
The query delimiter should not be included as part of any API path.
OpenAPI Path Query
The query delimiter should not be included as part of any API path.
OpenAPI No Api In Path Info
The query delimiter should not be included as part of any API path.
OpenAPI No Path Trailing Slash Error
It is common to be explicit and consistent about whether or not to have a trailing slack on each API path
OpenAPI No Path Trailing Slash Info
It is common to be explicit and consistent about whether or not to have a trailing slack on each API path
OpenAPI Request Body Have Application Json Info
Request bodies use the application/json media type to encode the request payload is a common data format
OpenAPI Request Body Have Application X Www Form Url Encoded Info
Request bodies use the application/x-www-form-urlencoded media type to encode the request payload is a common data format
OpenAPI Request Body Content On Post Error
POST requests with a request body needs content defined, giving more detail on what is contained within the API request body
OpenAPI Request Body Content On Post Info
POST requests with a request body needs content defined, giving more detail on what is contained within the API request body
OpenAPI Request Body Content On Put Error
PUT requests with a request body needs content defined, giving more detail on what is contained within the API request body
OpenAPI Request Body Content On Put Info
PUT requests with a request body needs content defined, giving more detail on what is contained within the API request body
OpenAPI No Request Body On Delete Error
DELETE HTTP methods should not have a request body, keeping API requests compliant with the HTTP standard
OpenAPI No Request Body On Delete Info
DELETE HTTP methods should not have a request body, keeping API requests compliant with the HTTP standard
OpenAPI Request Bodies Description Error
It is helpful to provide a description for request bodies, giving a simple explanation of what can be configured as part of the request payload
OpenAPI Request Bodies Description Info
It is helpful to provide a description for request bodies, giving a simple explanation of what can be configured as part of the request payload
OpenAPI Request Body Have Examples Error
POST, PUT, and PATCH request bodies needs examples, giving one or more examples of what needs to be submitted for different types of requests
OpenAPI Request Body Have Examples Info
POST, PUT, and PATCH request bodies needs examples, giving one or more examples of what needs to be submitted for different types of requests
OpenAPI Request Body Have Examples Ref Error
POST, PUT, and PATCH request bodies needs examples using references to centralized component examples, giving one or more examples of what needs to be submitted for different types of requests
OpenAPI Request Body Have Examples Ref Info
POST, PUT, and PATCH request bodies needs examples using references to centralized component examples, giving one or more examples of what needs to be submitted for different types of requests
OpenAPI No Request Body On Get Error
GET HTTP methods should not have a request body, keeping API requests compliant with the HTTP standard
OpenAPI No Request Body On Get Info
GET HTTP methods should not have a request body, keeping API requests compliant with the HTTP standard
OpenAPI Request Body On Post Error
POST HTTP methods can have a request body, giving a structured payload for configuring each API request
OpenAPI Request Body On Post Info
POST HTTP methods can have a request body, giving a structured payload for configuring each API request
OpenAPI Request Body On Put Error Info
PUT HTTP methods can have a request body, giving a structured payload for configuring each API request
OpenAPI Request Body On Put Info
PUT HTTP methods can have a request body, giving a structured payload for configuring each API request
OpenAPI Request Bodies Required Property Error
It is important to be explicit about whether or not the request body for an API operation is required or not
OpenAPI Request Bodies Required Property Info
It is important to be explicit about whether or not the request body for an API operation is required or not
OpenAPI Request Body Have Schema Error
POST, PUT, and PATCH request bodies needs schema defined, giving more detail on what the structure of the API request body needs to be
OpenAPI Request Body Have Schema Info
POST, PUT, and PATCH request bodies needs schema defined, giving more detail on what the structure of the API request body needs to be
OpenAPI Request Body Have Schema Ref Error
POST, PUT, and PATCH request bodies needs schema reference defined, giving more detail on what the structure of the API request body needs to be
OpenAPI Request Body Have Schema Ref Info
POST, PUT, and PATCH request bodies needs schema reference defined, giving more detail on what the structure of the API request body needs to be
OpenAPI Response Delete 204 Status Code Error
DELETE responses needs a 204 success HTTP status codes, communicating a success created response to consumers
OpenAPI Response Delete 204 Status Code Info
DELETE responses needs a 204 success HTTP status codes, communicating a success created response to consumers
OpenAPI Response Delete 400 Schema Ref Error
DELETE 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 400 Schema Ref Info
DELETE 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 400 Status Code Error
DELETE responses needs a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Delete 400 Status Code Info
DELETE responses needs a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Delete 401 Schema Ref Error
DELETE 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 401 Schema Ref Info
DELETE 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 401 Status Code Error
DELETE responses needs a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Delete 401 Status Code Info
DELETE responses needs a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Delete 403 Schema Ref Error
DELETE 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 403 Schema Ref Info
DELETE 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 403 Status Code Error
DELETE responses needs a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Delete 403 Status Code Info
DELETE responses needs a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Delete 404 Schema Ref Error
DELETE 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 404 Schema Ref Info
DELETE 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 404 Status Code Error
DELETE responses needs a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Delete 404 Status Code Info
DELETE responses needs a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Delete 429 Schema Ref Error
DELETE 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 429 Schema Ref Info
DELETE 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 429 Status Code Error
DELETE responses needs a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Delete 429 Status Code Info
DELETE responses needs a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Delete 500 Schema Ref Error
DELETE 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 500 Schema Ref Info
DELETE 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 500 Status Code Error
DELETE responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Delete 500 Status Code Info
DELETE responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Get 200 Content Error
GET 200 success HTTP status codes needs content property that provides the ability to describe the response content
OpenAPI Response Get 200 Content Info
GET 200 success HTTP status codes needs content property that provides the ability to describe the response content
OpenAPI Response Get 200 Description Error
GET 200 success HTTP status codes needs a description, describing what an API consumer can expect as a result
OpenAPI Response Get 200 Description Info
GET 200 success HTTP status codes needs a description, describing what an API consumer can expect as a result
OpenAPI Response Get 200 Media Type Error
GET 200 success HTTP status codes have a application/json media type, standardizing the response payload returned for a successful response
OpenAPI Response Get 200 Media Type Examples Error
GET 200 success HTTP status codes have examples to show one or many examples of responses for different types of API requests
OpenAPI Response Get 200 Media Type Examples Info
GET 200 success HTTP status codes have examples to show one or many examples of responses for different types of API requests
OpenAPI Response Get 200 Media Type Examples Ref Error
GET 200 success HTTP status codes have example references to show one or many examples of responses for different types of API requests
OpenAPI Response Get 200 Media Type Examples Ref Info
GET 200 success HTTP status codes have example references to show one or many examples of responses for different types of API requests
OpenAPI Response Get 200 Media Type Info
GET 200 success HTTP status codes have a application/json media type, standardizing the response payload returned for a successful response
OpenAPI Response Get 200 Media Type Schema Error
GET 200 success HTTP status codes have a schema to standardize the response payload returned for a successful response
OpenAPI Response Get 200 Media Type Schema Info
GET 200 success HTTP status codes have a schema to standardize the response payload returned for a successful response
OpenAPI Response Get 200 Media Type Schema Ref Error
GET 200 success HTTP status codes have a schema references to standardize the response payload returned for a successful response
OpenAPI Response Get 200 Media Type Schema Ref Info
GET 200 success HTTP status codes have a schema references to standardize the response payload returned for a successful response
OpenAPI Response Get 200 Status Code Error
GET responses needs a 200 success HTTP status codes, communicating a successful response to consumers
OpenAPI Response Get 200 Status Code Info
GET responses needs a 200 success HTTP status codes, communicating a successful response to consumers
OpenAPI Response Get 400 Schema Ref Error
GET 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 400 Schema Ref Info
GET 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 400 Status Code Error
GET responses needs a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Get 400 Status Code Info
GET responses needs a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Get 401 Schema Ref Error
GET 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 401 Schema Ref Info
GET 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 401 Status Code Error
GET responses needs a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Get 401 Status Code Info
GET responses needs a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Get 403 Schema Ref Error
GET 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 403 Schema Ref Info
GET 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 403 Status Code Error
GET responses needs a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Get 403 Status Code Info
GET responses needs a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Get 404 Schema Ref Error
GET 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 404 Schema Ref Info
GET 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 404 Status Code Error
GET responses needs a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Get 404 Status Code Info
GET responses needs a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Get 429 Schema Ref Error
GET 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 429 Schema Ref Info
GET 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 429 Status Code Error
GET responses needs a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Get 429 Status Code Info
GET responses needs a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Get 500 Schema Ref Error
GET 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 500 Schema Ref Info
GET 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 500 Status Code Error
GET responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Get 500 Status Code Info
GET responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Post 201 Content Error
POST 201 success HTTP status codes needs content property that provides the ability to describe the response content
OpenAPI Response Post 201 Content Info
POST 201 success HTTP status codes needs content property that provides the ability to describe the response content
OpenAPI Response Post 201 Description Error
POST 201 success HTTP status codes needs a description, describing what an API consumer can expect as a result
OpenAPI Response Post 201 Description Info
POST 201 success HTTP status codes needs a description, describing what an API consumer can expect as a result
OpenAPI Response Post 201 Examples Ref Error
POST 201 success HTTP status codes have example references to show one or many examples of responses for different types of API requests
OpenAPI Response Post 201 Examples Ref Info
POST 201 success HTTP status codes have example references to show one or many examples of responses for different types of API requests
OpenAPI Response Post 201 Media Type Error
POST 201 success HTTP status codes have a application/json media type, standardizing the response payload returned for a successful response
OpenAPI Response Post 201 Media Type Examples Error
POST 201 success HTTP status codes have examples to show one or many examples of responses for different types of API requests
OpenAPI Response Post 201 Media Type Examples Info
POST 201 success HTTP status codes have examples to show one or many examples of responses for different types of API requests
OpenAPI Response Post 201 Media Type Info
POST 201 success HTTP status codes have a application/json media type, standardizing the response payload returned for a successful response
OpenAPI Response Post 201 Media Type Schema Error
POST 201 success HTTP status codes have a schema to standardize the response payload returned for a successful response
OpenAPI Response Post 201 Media Type Schema Info
POST 201 success HTTP status codes have a schema to standardize the response payload returned for a successful response
OpenAPI Response Post 201 Schema Ref Error
POST 201 success HTTP status codes have a schema references to standardize the response payload returned for a successful response
OpenAPI Response Post 201 Schema Ref Info
POST 201 success HTTP status codes have a schema references to standardize the response payload returned for a successful response
OpenAPI Response Post 201 Status Code Error
POST responses needs a 201 success HTTP status codes, communicating a success created response to consumers
OpenAPI Response Post 201 Status Code Info
POST responses needs a 201 success HTTP status codes, communicating a success created response to consumers
OpenAPI Response Post 400 Schema Ref Error
POST 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 400 Schema Ref Info
POST 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 400 Status Code Error
POST responses needs a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Post 400 Status Code Info
POST responses needs a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Post 401 Schema Ref Error
POST 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 401 Schema Ref Info
POST 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 401 Status Code Error
POST responses needs a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Post 401 Status Code Info
POST responses needs a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Post 403 Schema Ref Error
POST 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 403 Schema Ref Info
POST 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 403 Status Code Error
POST responses needs a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Post 403 Status Code Info
POST responses needs a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Post 404 Schema Ref Error
POST 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 404 Schema Ref Info
POST 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 404 Status Code Error
POST responses needs a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Post 404 Status Code Info
POST responses needs a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Post 429 Schema Ref Error
POST 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 429 Schema Ref Info
POST 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 429 Status Code Error
POST responses needs a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Post 429 Status Code Info
POST responses needs a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Post 500 Schema Ref Error
POST 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 500 Schema Ref Info
POST 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 500 Status Code Error
POST responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Post 500 Status Code Info
POST responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Put 204 Status Code Error
PUT responses needs a 204 success HTTP status codes, communicating a success created response to consumers
OpenAPI Response Put 204 Status Code Info
PUT responses needs a 204 success HTTP status codes, communicating a success created response to consumers
OpenAPI Response Put 400 Schema Ref Error
PUT 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 400 Schema Ref Info
PUT 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 400 Status Code Error
PUT responses needs a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Put 400 Status Code Info
PUT responses needs a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Put 401 Schema Ref Error
PUT 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 401 Schema Ref Info
PUT 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 401 Status Code Error
PUT responses needs a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Put 401 Status Code Info
PUT responses needs a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Put 403 Schema Ref Error
PUT 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 403 Schema Ref Info
PUT 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 403 Status Code Error
PUT responses needs a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Put 403 Status Code Info
PUT responses needs a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Put 404 Schema Ref Error
PUT 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 404 Schema Ref Info
PUT 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 404 Status Code Error
PUT responses needs a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Put 404 Status Code Info
PUT responses needs a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Put 429 Schema Ref Error
PUT 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 429 Schema Ref Info
PUT 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 429 Status Code Error
PUT responses needs a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Put 429 Status Code Info
PUT responses needs a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Put 500 Schema Ref Error
PUT 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 500 Schema Ref Info
PUT 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 500 Status Code Error
PUT responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Put 500 Status Code Info
PUT responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Schema Description Error
Schema needs descriptions that provide a narrative of what a schema object is for, and how it can be used, leaving examples to demonstrate what can actually be expected
OpenAPI Schema Description Info
Schema needs descriptions that provide a narrative of what a schema object is for, and how it can be used, leaving examples to demonstrate what can actually be expected
OpenAPI Schema Description Length Error
Schema needs a length limit applied, restricting how long schema descriptions can be, helping keep them concise and consistent
OpenAPI Schema Names Pascal Case Error
Schema names, keeping the naming of them consistent across APIs, standardizing how consumers can use in their applications.
OpenAPI Schema Names Info
Schema names, keeping the naming of them consistent across APIs, standardizing how consumers can use in their applications.
OpenAPI Schema Names Length Error
Schema needs a length limit applied keeping the names of schema consistent across APIs
OpenAPI Schema Names Pascal Case Error
Schema names are pascal case, keeping the naming of them consistent across APIs, standardizing how consumers can use in their applications
OpenAPI Schema Names Pascal Case Info
Schema names are pascal case, keeping the naming of them consistent across APIs, standardizing how consumers can use in their applications
OpenAPI Schema Properties Allowed Integer Format Error
Schema integer properties needs a format property with int32 or int64 applied
OpenAPI Schema Properties Allowed Number Format Error
Schema integer properties needs a format property with int32 or int64 applied
OpenAPI Schema Properties Array Items Error
Schema properties that are of the type array must have an items property defined
OpenAPI Schema Properties Array Items Info
Schema properties that are of the type array must have an items property defined
OpenAPI Schema Properties Array Maxitems Error
Schema properties that are of the type array needs a max items property defined
OpenAPI Schema Properties Array Maxitems Info
Schema properties that are of the type array needs a max items property defined
OpenAPI Schema Properties Array Minitems Error
Schema properties that are of the type array needs a min items property defined
OpenAPI Schema Properties Array Minitems Info
Schema properties that are of the type array needs a min items property defined
OpenAPI Schema Properties Define Number Maximum Error
Schema properties that are of the type number needs a maximum property defined
OpenAPI Schema Properties Define Number Minimum Error
Schema properties that are of the type number needs a minimum property defined
OpenAPI Schema Properties Descriptions Error
Schema properties needs descriptions that provide a narrative of the property contains, and how it can be used
OpenAPI Schema Properties Descriptions Info
Schema properties needs descriptions that provide a narrative of the property contains, and how it can be used
OpenAPI Schema Properties Descriptions Length Error
Schema property descriptions needs a length limit applied, applying constraints to writing descriptions, and keeping consistent across APIs
OpenAPI Schema Properties Enum Casing Error
Schema property enumerators are consistent casing, keeping all entries upper snake case, and consistent across all APIs
OpenAPI Schema Properties Enum Casing Info
Schema property enumerators are consistent casing, keeping all entries upper snake case, and consistent across all APIs
OpenAPI Schema Properties Enum Info
Schema property has enumerators, giving consistent values chosen by consumers when making requests
OpenAPI Schema Properties Error
Schema has properties, giving more detail regarding the structure of each schema being applied as part of a request or a response
OpenAPI Schema Properties Info
Schema has properties, giving more detail regarding the structure of each schema being applied as part of a request or a response
OpenAPI Schema Properties Names Camel Case Error
Schema property names are camel case, giving consistent casing across all the schema properties used by APIs
OpenAPI Schema Properties Names Camel Case Info
Schema property names are camel case, giving consistent casing across all the schema properties used by APIs
OpenAPI Schema Properties Names Length Error
Schema property names have a length restriction applied, keeping names consistent, and avoiding being too long
OpenAPI Schema Properties String Maxlength Error
Schema properties that are of the string type have the max length applied defining the shape of the property
OpenAPI Schema Properties String Maxlength Info
Schema properties that are of the string type have the max length applied defining the shape of the property
OpenAPI Schema Properties String Minlength Error
Schema properties that are of the string type have the min length applied defining the shape of the property
OpenAPI Schema Properties String Minlength Info
Schema properties that are of the string type have the min length applied defining the shape of the property
OpenAPI Schema Required Error
Schema needs a required property defined, being explicit about which properties have to be included with the schema when it is used as part of a request or response
OpenAPI Schema Required Info
Schema needs a required property defined, being explicit about which properties have to be included with the schema when it is used as part of a request or response
OpenAPI Schema Type Error
Schema needs a type defined, being explicit about type of data a schema describes and can be used to validate, helping standardize the type of data being made available
OpenAPI Schema Type Info
Schema needs a type defined, being explicit about type of data a schema describes and can be used to validate, helping standardize the type of data being made available
OpenAPI Security Schemes API Keys Error
You need components security schemes which possesses an api-key property that allows to configure how API keys are applied to operations.
OpenAPI Security Schemes API Keys In Header Error
You need components security schemes which possesses an api-key property that allows to configure how API keys are applied to operations have a in of header set.
OpenAPI Security Schemes API Keys In Header Info
You need components security schemes which possesses an api-key property that allows to configure how API keys are applied to operations have a in of header set.
OpenAPI Security Schemes API Keys Info
You need components security schemes which possesses an api-key property that allows to configure how API keys are applied to operations.
OpenAPI Security Schemes API Keys Name Error
You need components security schemes which possesses an api-key property that allows to configure how API keys are applied to operations have a name of api_key set.
OpenAPI Security Schemes API Keys Name Info
You need components security schemes which possesses an api-key property that allows to configure how API keys are applied to operations have a name of api_key set.
OpenAPI Security Schemes API Keys Type Error
You need components security schemes which possesses an api-key property that allows to configure how API keys are applied to operations have a type of apiKey set.
OpenAPI Security Schemes API Keys Type Info
You need components security schemes which possesses an api-key property that allows to configure how API keys are applied to operations have a type of apiKey set.
OpenAPI Security Schemes Error
You need components security schemes so that the security definition for an API have been standardized and are able to be applied across APIs
OpenAPI Security Schemes Info
You need components security schemes so that the security definition for an API have been standardized and are able to be applied across APIs
OpenAPI Tags Alphabetical Error
The tags used to organize operations needs to be available in an alphabetical format keeping easy to navigate for consumers.
OpenAPI Tags Description Error
Tags used as part of an OpenAPI needs descriptions, giving more of a narrative behind what a tag means when it is applied to an API
OpenAPI Tags Description Info
Tags used as part of an OpenAPI needs descriptions, giving more of a narrative behind what a tag means when it is applied to an API
OpenAPI Tags Name Error
Tags used as part of an OpenAPI needs names, giving a simple key word or phrase that represents the tag being applied to APIs
OpenAPI Tags Name Info
Tags used as part of an OpenAPI needs names, giving a simple key word or phrase that represents the tag being applied to APIs
OpenAPI Tags Object Error
There needs to be a central tags object applied to the OpenAPI, giving central tags that can be applied across all operations within an OpenAPI
OpenAPI Tags Object Info
There needs to be a central tags object applied to the OpenAPI, giving central tags that can be applied across all operations within an OpenAPI
OpenAPI Tags One Error
There needs to be at least one tag applied to an OpenAPI, giving a key word or phrase that can be applied to API operations
OpenAPI Tags Upper Case Error
The first letter of each word in a tag being applied to APIs needs to be capitalized, keeping the tags being applied across APIs the same look and feel for organizing and publishing to documentation
OpenAPI Version Date Info
Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using date-based versioning published to the info version property
OpenAPI Version In Path Error
The majority of public APIs available on the Web today put the major version of the API as part of the path for each API
OpenAPI Version In Path Info
The majority of public APIs available on the Web today put the major version of the API as part of the path for each API
OpenAPI Version Semantic Info
Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using Semantic versioning published to the info version property
Cache-Control Header Required
GET responses needs to include a Cache-Control header to define caching behavior for clients and intermediaries.
Cache-Control Header Info
GET responses needs to include a Cache-Control header to define caching behavior for clients and intermediaries.
ETag Header Required
GET responses needs to include an ETag header for cache validation and conditional requests.
ETag Header Info
GET responses needs to include an ETag header for cache validation and conditional requests.
Deprecated Operations Must Have Sunset Header
Operations marked as deprecated must include a Sunset header indicating when the operation will be removed.
Deprecated Operations Sunset Header Info
Operations marked as deprecated needs to include a Sunset header indicating when the operation will be removed.
Deprecated Operations Must Have Migration Info
Operations marked as deprecated must include migration information in their description.
Deprecated Operations Migration Info
Operations marked as deprecated needs to include migration information in their description.
Error Responses Must Use RFC 7807
4xx and 5xx error responses must use RFC 7807 Problem Details format with type, title, status, and detail fields.
Error Responses RFC 7807 Info
4xx and 5xx error responses should use RFC 7807 Problem Details format with type, title, status, and detail fields.
Collection Filtering Parameters
Collection endpoints should support filtering through query parameters using consistent naming conventions.
Collection Sorting Parameters
Collection endpoints should support sorting through a consistent sort query parameter.
Response Links Info
API responses needs to include links for discoverability, enabling clients to navigate related resources using HATEOAS patterns.
Response Links Required
API responses must include links for discoverability, enabling clients to navigate related resources using HATEOAS patterns.
Pagination Limit Parameter
Collection endpoints needs to include a limit or page_size query parameter for controlling response size.
Pagination Offset Parameter
Collection endpoints needs to include an offset or cursor query parameter for navigating through results.
Pagination Response Metadata
Paginated responses needs to include metadata about total count, page size, and navigation links.
Webhooks Object
APIs that support event-driven patterns should define webhooks using the OpenAPI webhooks object.
Servers Must Be Defined
OpenAPI definitions must include at least one server object so consumers know where to send requests.
Servers Defined
OpenAPI definitions needs to include server objects for consumer reference.
Servers Must Use HTTPS
All production server URLs must use HTTPS to ensure encrypted communication between clients and APIs.
Servers Use HTTPS
Server URLs should use HTTPS to ensure encrypted communication between clients and APIs.
Server Description Required
Each server object must include a description identifying the environment it represents.
Server Description Info
Each server object needs to include a description identifying the environment it represents.
No Localhost in Production Servers
Production server URLs must not contain localhost or 127.0.0.1 references.
Additional Properties for Forward Compatibility
Schema objects should allow additional properties to support forward compatibility and Postel's Law.
Long Running Operations Use 202 Accepted
Operations that cannot complete synchronously should return 202 Accepted with a Location header for status polling.
Long Running Operations Retry-After Header
202 Accepted responses needs to include a Retry-After header indicating when the client should poll for status.
Date-Time Properties Must Use ISO 8601
Date and time properties must use the date-time format specifier which corresponds to ISO 8601 / RFC 3339 formatting.
Date-Time Properties Format Info
Date and time properties should use the date-time format specifier which corresponds to ISO 8601 / RFC 3339 formatting.
No Verbs in URL Paths
API paths must use nouns to represent resources, not verbs. Actions needs to be expressed through HTTP methods, not path segments.
No Verbs in URL Paths Info
API paths should use nouns to represent resources, not verbs. Actions needs to be expressed through HTTP methods, not path segments.
Resource Names Should Be Plural
Resource names in paths should use plural nouns to represent collections consistently.
Path Depth Limit
API paths should not exceed a reasonable nesting depth to maintain simplicity and readability.