]> Vodafone

One Kingdom Street London W2 6BY GB kevin.smith@vodafone.com www.vodafone.com

General Internet Engineering Task Force well-known API This document defines the "api-catalog" well-known URI. It is intended to facilitate discovery of the APIs published by a Web host.

Introduction A Web host may publish Application Programming Interfaces (APIs) to encourage requests for interaction from external parties. Such APIs must be discovered before they may be used - i.e., the external party needs to know what APIs a given Web host exposes, including their purpose, any policies for usage, and the endpoints to interact with the APIs. To faciliate discovery of this information, this document proposes a well-known URI, 'api-catalog', as a location where a Web host's API endpoints are listed and described.

Goals and non-goals The primary goal is to facilitate the discovery of a Web Host's public API endpoints, along with metadata that describes the purpose and usage of each API. The api-catalog is primarily machine-readable to enable automated discovery and usage of APIs. The api-catalog may also include links to human-readable documentation. Non-goals: this document does not mandate paths for API endpoints. i.e., it does not mandate that my_example_api should be available at example.com/.well-known/api-catalog/my_example_api (although it is not forbidden to do so).

Requirements Language The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here.

Using the 'api-catalog' well-known URI The api-catalog well-known URI is intended for HTTP(S) servers that publish APIs and wish to facilitate their discovery and usage. Since the purpose of the api-catalog well-known URI is to facilitate API discovery with minimal prior knowledge, it is recommended that /.well-known/api-catalog be hosted at a predictable hostname, e.g. www.example.com . It may also be hosted at other hostnames, e.g. api.example.com, developer.example.com etc. A Web host (example.com) supporting this URI:

• SHALL resolve an HTTP(S) GET request to /.well-known/api-catalog and return an api-catalog linkset as defined in this document
• SHOULD resolve an HTTP(S) HEAD request to /.well-known/api-catalog with a response including a Link header with the relation(s) defined in (Editor's note: TODO, add a section for this).

Link relations "api-catalog" . Links to an api-catalog as defined in this document. "service-desc" . Defined in , used to link to a description of the API that is primarily intended for machine consumption. "service-doc" . Defined in , used to link to API documentation that is primarily intended for human consumption. "service-meta" . Defined in , used to link to additional metadata about the API, and is primarily intended for machine consumption. "status" . Defined in , used to link to the API status (e.g. API "health" indication etc.) for machine and/or human consumption.

Associated Media type: the api-catalog linkset A GET request to the api-catalog well-known URI SHALL return a linkset containing an array of linkset context objects. Each linkset context object MUST include an anchor with a URI reference for an API endpoint, and a "service-desc" link relation. The link relations for "status", "service-doc", "service-meta" MAY be included. Example request:

api-catalog linkset example

Conformance to RFC8615 The requirements in section 3 of for defining Well-Known Uniform Resource Identifiers are met as follows:

Path prefix The api-catalog URI SHALL be appended to the /.well-known/ path-prefix for "well-known locations".

Supported URI schemes The api-catalog well-known URI may be used with the HTTP and HTTPS URI schemes.

Registration of the api-catalog well-known URI See considerations below.

IANA Considerations

The api-catalog well-known URI This specification registers the "api-catalog" well-known URI in the Well-Known URI Registry as defined by . URI suffix: api-catalog Specification document(s): draft-smith-api-catalog-03 Related information: The "api-catalog" documents obtained from the same host using the HTTP and HTTPS protocols (using default ports) MUST be identical.

The api-catalog link relation This specification registers the "api-catalog" link relation by following the procedures per section 4.2.2 of (Editor's note: IANA registrations are TODO). Relation Name: api-catalog Description: Identifies a catalog of APIs published by the context Web host. Reference: draft-smith-api-catalog-03

Security Considerations TBD

References Normative References Informative References In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.

Acknowledgements TODO