Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Licenses API

View various OSS licenses.

This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

3 operations 3 paths 5 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Licenses API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Licenses 3

View various OSS licenses.

GET
/licenses
APIs.io Engineering Platform Get all commonly used licenses
licenses/get-all-commonly-used 3 params → 200304
GET
/licenses/{license}
APIs.io Engineering Platform Get a license
licenses/get 1 param → 200403404304
GET
/repos/{owner}/{repo}/license
APIs.io Engineering Platform Get the license for a repository
licenses/get-for-repo 2 params → 200404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are license-content (13 properties), license (13 properties), license-simple (6 properties), nullable-license-simple (6 properties). Each schema is shown below with its type and property counts.

basic-error
object
Basic Error
4 properties
nullable-license-simple
object
License Simple
6 properties 5 required
license
object
License
13 properties 13 required
license-simple
object
License Simple
6 properties 5 required
license-content
object
License Content
13 properties 13 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-licenses-api-openapi.yml Raw ↑