Building Blocks for HTTP APIs (httpapi) Internet Drafts

      
 RateLimit header fields for HTTP
 
 draft-ietf-httpapi-ratelimit-headers-08.txt
 Date: 07/10/2024
 Authors: Roberto Polli, Alex Ruiz, Darrel Miller
 Working Group: Building Blocks for HTTP APIs (httpapi)
 This document defines the RateLimit-Policy and RateLimit HTTP header fields for servers to advertise their quota policies and the current service limits, thereby allowing clients to avoid being throttled.
 The Deprecation HTTP Header Field
 
 draft-ietf-httpapi-deprecation-header-09.txt
 Date: 27/09/2024
 Authors: Sanjay Dalal, Erik Wilde
 Working Group: Building Blocks for HTTP APIs (httpapi)
 The Deprecation HTTP response header field is used to signal to consumers of a resource (in the sense of URI) that the resource will be or has been deprecated. Additionally, the deprecation link relation can be used to link to a resource that provides additional information about planned or existing deprecation, and possibly ways in which client application developers can best manage deprecation.
 REST API Media Types
 
 draft-ietf-httpapi-rest-api-mediatypes-06.txt
 Date: 13/10/2024
 Authors: Roberto Polli
 Working Group: Building Blocks for HTTP APIs (httpapi)
 This document registers the following media types used in APIs on the IANA Media Types registry: application/openapi+json, and application/ openapi+yaml.
 Byte Range PATCH
 
 draft-ietf-httpapi-patch-byterange-02.txt
 Date: 08/07/2024
 Authors: Austin Wright
 Working Group: Building Blocks for HTTP APIs (httpapi)
 This document specifies a media type for PATCH payloads that overwrites a specific byte range, facilitating random access writes and segmented uploads of resources.
 api-catalog: a well-known URI and link relation to help discovery of APIs
 
 draft-ietf-httpapi-api-catalog-08.txt
 Date: 20/12/2024
 Authors: Kevin Smith
 Working Group: Building Blocks for HTTP APIs (httpapi)
 This document defines the "api-catalog" well-known URI and link relation. It is intended to facilitate automated discovery and usage of published APIs. A request to the api-catalog resource will return a document providing information about, and links to, the publisher's APIs.
 HTTP Problem Types for Digest Fields
 
 draft-ietf-httpapi-digest-fields-problem-types-00.txt
 Date: 04/11/2024
 Authors: Marius Kleidl, Lucas Pardue, Roberto Polli
 Working Group: Building Blocks for HTTP APIs (httpapi)
 This document specifies problem types that servers can use in responses to problems encountered while dealing with a request carrying integrity fields and integrity preference fields.
 API Keys and Privacy
 
 draft-ietf-httpapi-privacy-00.txt
 Date: 06/11/2024
 Authors: Rich Salz, Mike Bishop, Marius Kleidl
 Working Group: Building Blocks for HTTP APIs (httpapi)
 Redirecting HTTP requests to HTTPS, a common pattern for human-facing web resources, can be an anti-pattern for authenticated API traffic. This document discusses the pitfalls and makes deployment recommendations for authenticated HTTP APIs. It does not specify a protocol.

data-group-menu-data-url="/group/groupmenu.json">

Building Blocks for HTTP APIs (httpapi)

WG Name Building Blocks for HTTP APIs
Acronym httpapi
Area Web and Internet Transport (wit)
State Active
Charter charter-ietf-httpapi-01 Approved
Document dependencies
Additional resources GitHub Repository
GitHub Organization
Zulip stream
Personnel Chairs Darrel Miller, Rich Salz
Area Director Francesca Palombini
Secretary Mark Nottingham
Mailing list Address httpapi@ietf.org
To subscribe https://www.ietf.org/mailman/listinfo/httpapi
Archive https://mailarchive.ietf.org/arch/browse/httpapi/
Chat Room address https://zulip.ietf.org/#narrow/stream/httpapi

Charter for Working Group

In addition to its use for web browsing, HTTP is often used for machine-to-machine communication, facilitated by HTTP APIs. This Working Group will standardise HTTP protocol extensions for use in such cases, with a focus on building blocks for separate or combined use.

Its output can include the following:

• Specifications for HTTP extensions that relate to HTTP APIs (typically, new HTTP header and/or trailer fields)

• Specifications for new message body formats, or conventions for their use in HTTP APIs (e.g., patterns of JSON objects)

• Best practices and other documentation for HTTP API designers, consumers, implementers, operators, etc.

Other items are out of scope. In particular, this WG will not take on work items for HTTP APIs for specific applications or services, and it will not define new HTTP extension points. APIs for HTTP itself (e.g., in clients and servers) are also out of scope.

To be successful, this Working Group will need to have active and broad representation from across the industry -- e.g., API gateway vendors (and other intermediaries), API consultants, API tool vendors, in-house API teams. Therefore, adopted proposals should have public support from multiple implementers and/or deployments before being sent to the IESG.

To assess whether the group is functioning well, this charter will be reviewed by the IESG nine months after chartering.

This Working Group will also need to coordinate closely with the HTTP Working Group, in particular when new methods and status codes are proposed. Work items that are more broadly applicable (e.g., for implementation in Web browsers) are likely to be more appropriate in the HTTP Working Group, but it is expected that coordination and discussion between the groups' Chairs and Area Director(s) will guide work items to the appropriate venue.

Milestones

Date Milestone Associated documents
Nov 2025 Enter WGLC draft-ietf-httpapi-authentication-link
Mar 2025 Enter WGLC draft-ietf-httpapi-patch-byterange
Jun 2024 Send to IESG draft-ietf-httpapi-deprecation-header
Jun 2024 Send to IESG draft-ietf-httpapi-api-catalog