Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Presto's endpoints using OpenAPI #22567

Open
tdcmeehan opened this issue Apr 19, 2024 · 0 comments
Open

Document Presto's endpoints using OpenAPI #22567

tdcmeehan opened this issue Apr 19, 2024 · 0 comments

Comments

@tdcmeehan
Copy link
Contributor

OpenAPI is a ubiquitous standard for documenting HTTP based APIs. Most of Presto's endpoints are RESTful, and therefore would be amenable to being documented by a standard such as OpenAPI. There are several benefits to adding this documentation:

  1. By encoding the endpoints using a standard, documentation for these endpoints can be automatically generated, which will help developers extend and interact with Presto.
  2. We can generate client code using OpenAPI standards, which can help users of Presto extend it.
  3. We can easily generate server mocks for external components.

Expected Behavior or Use Case

We have a new folder for documentation of Presto API's based off of OpenAPI.

Presto Component, Service, or Connector

Core

Possible Implementation

N/A

Example Screenshots (if appropriate):

N/A

Context

https://learn.openapis.org/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant