-
Notifications
You must be signed in to change notification settings - Fork 9.1k
Closed
Labels
httpSupporting HTTP features and interactionsSupporting HTTP features and interactionsregistriesRelated to any or all spec.openapis.org-hosted registriesRelated to any or all spec.openapis.org-hosted registries
Milestone
Description
Feature Request
OpenAPI support for all HTTP methods
RFC 2616 (1999) updated by RFC 7231 (2014) (errata list)
- OPTIONS – Describe communication options (RFC 2616:1999 / RFC 7231:2014) → OpenAPI since 3.0 (2017)
- GET – Retrieve a resource (1999 / 2014) → OpenAPI since 3.0 (2017)
- HEAD – Retrieve headers only (1999 / 2014) → OpenAPI since 3.0 (2017)
- POST – Create or process a resource (1999 / 2014) → OpenAPI since 3.0 (2017)
- PUT – Replace a resource (1999 / 2014) → OpenAPI since 3.0 (2017)
- DELETE – Remove a resource (1999 / 2014) → OpenAPI since 3.0 (2017)
- TRACE – Diagnostic loop-back test (1999 / 2014) → OpenAPI since 3.0 (2017)
- CONNECT – Establish a tunnel (1999 / 2014) → OpenAPI explicitly allowed since 3.1 (2021)
✅ Spec 3.1 – Operation Object. CONNECT now explicitly covered.
RFC 5789 (2010)
- PATCH – Apply partial modifications to a resource (2010) → OpenAPI since 3.0 (2017)
RFC 2518 (1999), updated by RFC 4918 (2007) and RFC 5689 (2009, MKCOL)
- PROPFIND – Retrieve properties (1999 / 2007)
- PROPPATCH – Modify properties (1999 / 2007)
- MKCOL – Create a collection (1999 / 2009)
- COPY – Copy a resource (1999 / 2007)
- MOVE – Move a resource (1999 / 2007)
- LOCK – Apply a lock (1999 / 2007)
- UNLOCK – Remove a lock (1999 / 2007)
RFC 3253 (2002) (errata list)
- VERSION-CONTROL – Put a resource under version control (2002)
- REPORT – Run a server-defined query (2002)
- CHECKOUT – Checkout a versioned resource (2002)
- CHECKIN – Checkin a checked-out resource (2002)
- UNCHECKOUT – Cancel a checkout (2002)
- MKWORKSPACE – Create a workspace (2002)
- UPDATE – Update a resource to a specific version (2002)
- LABEL – Apply a label to a version (2002)
- MERGE – Merge changes (2002)
- BASELINE-CONTROL – Manage baselines (2002)
- MKACTIVITY – Create an activity (2002)
RFC 3648 (2003)
- ORDERPATCH – Reorder collections (2003)
RFC 3744 (2004) (errata list)
- ACL – Access control management (2004)
RFC 5323 (2008)
- SEARCH – Execute a search query (2008)
draft-ietf-httpbis-safe-method-w-body-03 (2015)
- QUERY – Safe method with body (2015, Internet-Draft)
draft-snell-link-method-01 (2014)
- LINK – Establish a relationship (2014, Internet-Draft)
- UNLINK – Remove a relationship (2014, Internet-Draft)
Related Issues
- HTTP Method REPORT not supported #658
- Support for SEARCH http method #1306
- Proposal: Support for LINK and UNLINK HTTP methods #480
- swagger-core #1760
References
👉 Notes:
- All RFC 7231 methods (GET, POST, PUT, DELETE, etc.) and PATCH are supported since OpenAPI 3.0 (2017).
- CONNECT explicitly allowed since OpenAPI 3.1 (2021).
- Other methods (WebDAV, ACL, SEARCH, QUERY, LINK/UNLINK…) remain not officially covered by OpenAPI tooling.
akuckartz, nicocesar, cleydsonjr, arun251, qboot and 8 more
Metadata
Metadata
Assignees
Labels
httpSupporting HTTP features and interactionsSupporting HTTP features and interactionsregistriesRelated to any or all spec.openapis.org-hosted registriesRelated to any or all spec.openapis.org-hosted registries