Skip to content

Commit af0fbbe

Browse files
authored
docs: add request body format to public API definition (#849)
The request body format has always been part of the public API. This adds it to the documentation of the public API.
1 parent dd03d28 commit af0fbbe

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ This project is versioned using [Semantic Versioning 2.0.0](https://semver.org/s
103103

104104
The public API is defined as:
105105

106-
- 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
107-
- The behavior of the API endpoints no matter the signature of the endpoint is
106+
- The API endpoints, meaning the routes, parameters, HTTP response codes, and request and response body format
107+
- The behavior of the API endpoints no matter the signature of the endpoint is.
108108

109109
Not part of the public API is:
110110

0 commit comments

Comments
 (0)