Skip to content

Commit

Permalink
docs: add request body format to public API definition
Browse files Browse the repository at this point in the history
The request body format has always been part of the public API.

This adds it to the documentation of the public API.
  • Loading branch information
morremeyer authored Nov 20, 2023
1 parent dd03d28 commit d0889b9
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
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

0 comments on commit d0889b9

Please sign in to comment.