info-license-strict

Requires either the license URL or identifier in your API descriptions.

API design principles

The principle of providing your users with accurate and relevant information does not apply to API design only, but to any product-related communication in general.

Before they can work with your API, your users must understand the terms and conditions of your API usage.

By being upfront with the API license, you can reduce friction and encourage API adoption.

Configuration

An example configuration:

rules:
  info-license-strict: error

Examples

Given the following configuration:

rules:
  info-license-strict: error

Example of an incorrect license:

info:
  license:
    name: MIT

Example of a correct license with URL:

info:
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html

Example of a correct license with identifier:

info:
  license:
    name: Apache 2.0
    identifier: Apache-2.0

Related rules

• info-contact
• info-license

Resources

• Rule source
• License object docs