info-license-url

Requires the license URL in your API definitions.

OAS Compatibility
2.0
3.0
3.1
root
Info
License
url

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.

"Can I use your API? Will I get in trouble? Will I lose my job?" Sometimes questions like these go through consumers' minds. By being upfront with the API license, you can reduce friction towards usage.

Configuration

Option Type Description
severity string Possible values: off, warn, error. Default warn (in recommended configuration).

An example configuration:

Copy
Copied
styleguide:
  rules:
    info-license-url: error

Examples

Given the following configuration:

Copy
Copied
styleguide:
  rules:
    info-license-url: error

Example of an incorrect license URL:

Copy
Copied
info:
  license:
    name: MIT

Example of a correct license URL:

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

Related rules

Resources