AsyncAPI

Asyncapi 3 Channel No Empty Parameter info experience: reliabilityexperience: consistency spec: channels

Channel address must not have empty parameter substitution pattern.

Asyncapi 3 Channel No Query Nor Fragment info experience: consistencyexperience: naming spec: channels

Channel address must not include query ("?") or fragment ("#") delimiter.

Asyncapi 3 Channel No Trailing Slash info experience: consistencyexperience: naming spec: channels

Channel address must not end with slash.

Asyncapi 3 Channel Servers info experience: reliabilityexperience: consistency spec: channels

Channel servers must be defined in the "servers" object.

Asyncapi 3 Document Unresolved info experience: data-modelingexperience: reliability spec: document

Checking if the AsyncAPI v3 document has valid structure before resolving references.

Asyncapi 3 Headers Schema Type Object info experience: data-modelingexperience: reliability spec: channelsspec: messagesspec: components

Headers schema type must be "object".

Asyncapi 3 Operation Description info experience: documentation spec: operations

Operation "description" must be present and non-empty string.

Asyncapi 3 Operation Security info experience: securityexperience: reliability spec: security

Operation have to reference a defined security schemes.

Asyncapi 3 Payload Unsupported SchemaFormat info experience: data-modelingexperience: reliability spec: channelsspec: messagesspec: components

Message schema validation is only supported with default unspecified "schemaFormat".

Asyncapi 3 Server No Empty Variable info experience: reliabilityexperience: consistency spec: servers

Server host and pathname must not have empty variable substitution pattern.

Asyncapi 3 Server No Trailing Slash info experience: consistencyexperience: reliability spec: servers

Server host must not end with slash.

Asyncapi 3 Server Not Example Com info experience: reliabilityexperience: usability spec: servers

Server host must not point at example.com.

Asyncapi 3 Tag Description info experience: documentationexperience: discoverability spec: info

Tag object must have "description".

Asyncapi 3 Tags info experience: discoverabilityexperience: documentation spec: info

AsyncAPI document must have non-empty "tags" array.

Asyncapi 3 Tags Alphabetical info experience: consistencyexperience: discoverability spec: info

AsyncAPI object must have alphabetical "tags".

Asyncapi 3 Tags Uniqueness info experience: consistencyexperience: discoverability spec: infospec: serversspec: channelsspec: messagesspec: components

Each tag must have a unique name.

Asyncapi Channel No Empty Parameter info experience: reliabilityexperience: consistency spec: channels

Channel path must not have empty parameter substitution pattern.

Asyncapi Channel No Query Nor Fragment info experience: consistencyexperience: naming spec: channels

Channel path must not include query ("?") or fragment ("#") delimiter.

Asyncapi Channel No Trailing Slash info experience: consistencyexperience: naming spec: channels

Channel path must not end with slash.

Asyncapi Channel Parameters info experience: reliabilityexperience: consistency spec: channelsspec: components

Channel parameters must be defined and there must be no redundant parameters.

Asyncapi Channel Servers info experience: reliabilityexperience: consistency spec: document

Channel servers must be defined in the "servers" object.

Asyncapi Headers Schema Type Object info experience: data-modelingexperience: reliability spec: channelsspec: messagesspec: components

Headers schema type must be "object".

Asyncapi Info Contact info experience: documentationexperience: discoverability spec: document

Info object must have "contact" object.

Asyncapi Info Contact Properties info experience: documentationexperience: discoverability spec: info

Contact object must have "name", "url" and "email".

Asyncapi Info Description info experience: documentation spec: document

Info "description" must be present and non-empty string.

Asyncapi Info License info experience: documentationexperience: governance spec: document

Info object must have "license" object.

Asyncapi Info License URL info experience: documentationexperience: governance spec: document

License object must include "url".

Asyncapi Latest Version info experience: versioningexperience: consistency spec: document

Checking if the AsyncAPI document is using the latest version.

Asyncapi Message Examples info experience: data-modelingexperience: documentationexperience: reliability spec: channelsspec: messagesspec: components

Examples of message object should follow by "payload" and "headers" schemas.

Asyncapi Message MessageId Uniqueness info experience: consistencyexperience: namingexperience: reliability spec: document

"messageId" must be unique across all the messages.

Asyncapi Operation Description info experience: documentation spec: channels

Operation "description" must be present and non-empty string.

Asyncapi Operation OperationId info experience: consistencyexperience: usability spec: channels

Operation must have "operationId".

Asyncapi Operation OperationId Uniqueness info experience: consistencyexperience: namingexperience: reliability spec: document

"operationId" must be unique across all the operations.

Asyncapi Operation Security info experience: securityexperience: reliability spec: channels

Operation have to reference a defined security schemes.

Asyncapi Parameter Description info experience: documentation spec: channelsspec: components

Parameter objects must have "description".

Asyncapi Payload info experience: data-modelingexperience: reliability spec: channelsspec: messagesspec: componentsspec: schemas

Payloads must be valid against AsyncAPI Schema object.

Asyncapi Payload Default info experience: data-modelingexperience: reliability spec: channelsspec: messagesspec: componentsspec: schemas

Default must be valid against its defined schema.

Asyncapi Payload Examples info experience: data-modelingexperience: documentationexperience: reliability spec: channelsspec: messagesspec: componentsspec: schemas

Examples must be valid against their defined schema.

Asyncapi Payload Unsupported SchemaFormat info experience: data-modelingexperience: reliability spec: channelsspec: messagesspec: components

Message schema validation is only supported with default unspecified "schemaFormat".

Asyncapi Schema info experience: data-modelingexperience: reliability spec: document

Validate structure of AsyncAPI specification.

Asyncapi Schema Default info experience: data-modelingexperience: reliability spec: channelsspec: componentsspec: schemas

Default must be valid against its defined schema.

Asyncapi Schema Examples info experience: data-modelingexperience: documentationexperience: reliability spec: channelsspec: componentsspec: schemas

Examples must be valid against their defined schema.

Asyncapi Server No Empty Variable info experience: reliabilityexperience: consistency spec: servers

Server URL must not have empty variable substitution pattern.

Asyncapi Server No Trailing Slash info experience: consistencyexperience: reliability spec: servers

Server URL must not end with slash.

Asyncapi Server Not Example Com info experience: reliabilityexperience: usability spec: servers

Server URL must not point at example.com.

Asyncapi Server Security info experience: securityexperience: reliability spec: servers

Server have to reference a defined security schemes.

Asyncapi Server Variables info experience: reliabilityexperience: consistency spec: serversspec: components

Server variables must be defined and there must be no redundant variables.

Asyncapi Servers info experience: usabilityexperience: reliabilityexperience: documentation spec: document

AsyncAPI object must have non-empty "servers" object.

Asyncapi Tag Description info experience: documentationexperience: discoverability spec: tags

Tag object must have "description".

Asyncapi Tags info experience: discoverabilityexperience: documentation spec: document

AsyncAPI object must have non-empty "tags" array.

Asyncapi Tags Alphabetical info experience: consistencyexperience: discoverability spec: document

AsyncAPI object must have alphabetical "tags".

Asyncapi Tags Uniqueness info experience: consistencyexperience: discoverability spec: serversspec: channelsspec: messagesspec: components

Each tag must have a unique name.

Asyncapi Unused Components Schema info experience: consistencyexperience: data-modeling spec: componentsspec: schemas

Potentially unused components schema has been detected.

Asyncapi Unused Components Server info experience: consistencyexperience: reliability spec: serversspec: components

Potentially unused components server has been detected.

Channel Asyncapi Require Description info experience: documentation spec: channels

Channels should have a description of the messages they carry.

Component Asyncapi Message Require Contenttype info experience: consistencyexperience: data-modeling spec: components

Messages should declare a contentType (e.g. application/json).

Component Asyncapi Message Require Correlation ID info experience: reliabilityexperience: observability spec: components topic: tracing

Messages should define a correlationId so events can be traced across services.

Component Asyncapi Message Require Name info experience: documentationexperience: consistency spec: components

Messages should declare a name.

Component Asyncapi Message Require Payload info experience: data-modeling spec: components

Messages should define a payload schema.

Component Asyncapi Message Require Title info experience: documentation spec: components

Messages should declare a human-readable title.

Document Require Asyncapi info experience: governanceexperience: discoverability spec: document

asyncapi document should declare a `asyncapi` property.

Document Require Channel info experience: governanceexperience: discoverability spec: document

asyncapi document should declare a `channels` property.

Document Require Component info experience: governanceexperience: discoverability spec: document

asyncapi document should declare a `components` property.

Document Require Defaultcontenttype info experience: governanceexperience: discoverability spec: document

asyncapi document should declare a `defaultContentType` property.

Document Require ID info experience: governanceexperience: discoverability spec: document

asyncapi document should declare a `id` property.

Document Require Info info experience: governanceexperience: discoverability spec: document

asyncapi document should declare a `info` property.

Document Require Operation info experience: governanceexperience: discoverability spec: document

asyncapi document should declare a `operations` property.

Document Require Server info experience: governanceexperience: discoverability spec: document

asyncapi document should declare a `servers` property.

Info Asyncapi Require Title info experience: documentation spec: info

The API should declare an info.title.

Info Asyncapi Version Semver info experience: versioning spec: info

info.version should be semantic (e.g. 1.0.0).

Operation Asyncapi Require Summary info experience: documentation spec: operations

Operations should have a short summary.

Operation Asyncapi Require Tag info experience: documentationexperience: discoverability spec: operations

Operations should declare tags for grouping.

Schema Asyncapi Property Camel Case info experience: namingexperience: consistency spec: components

Schema property names should be camelCase.

Schema Asyncapi Property Require Description info experience: documentation spec: components

Schema properties should be documented with a description.

Server Asyncapi Require Description info experience: documentation spec: servers

Servers should have a description identifying the environment/broker.