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.

Sign up for GitHub

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

docs: add request body format to public API definition #849

Merged
merged 1 commit into from
Nov 20, 2023
Merged

docs: add request body format to public API definition #849

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ This project is versioned using [Semantic Versioning 2.0.0](https://semver.org/s

The public API is defined as:

- The API endpoints, meaning the routes, parameters, HTTP respone codes and response body format (for a function, we'd just say “the function signature“) that the HTTP server built from the code in this repository provides
- The behavior of the API endpoints no matter the signature of the endpoint is
- The API endpoints, meaning the routes, parameters, HTTP response codes, and request and response body format
- The behavior of the API endpoints no matter the signature of the endpoint is.

Not part of the public API is:

Expand Down