AsyncAPI Best Practices

general > asyncapi-info-license

Guidance

The info object should have a license key.

It can be hard to pick a license, so if you don't have a lawyer around you can use TLDRLegal and Choose a License

to help give you an idea.

How useful this is in court is not entirely known, but having a license is better than not having a license.

Message

The '{{core.name}}' license URL should be provided.

Examples

valid

asyncapi: 2.0.0
info:
  title: example API
  version: "1.0.0"
  description: Example
  license:
    name: Apache 2.0
channels: {}

invalid

asyncapi: 2.0.0
info:
  title: example API
  version: "1.0.0"
  description: Example
channels: {}

Applies to AsyncAPI

Constraint

Type: Declarative Validation