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

Jump to bottom

Improve RESP API docs #2064

Merged
merged 6 commits into from
Dec 6, 2024
Merged

Improve RESP API docs #2064

merged 6 commits into from
Dec 6, 2024

Conversation

r4victor
Copy link
Collaborator

@r4victor r4victor commented Dec 6, 2024

Closes #2059

This PR:

  • Describes all user-relevant HTTP endpoints and payload fields.
  • Documents 400 and 403 errors format.
  • Simplifies usage of the HTTP API by making some fields optional.
  • Adds an example of using the HTTP API.
  • Other improvements.

@r4victor r4victor merged commit b217bda into master Dec 6, 2024
23 checks passed
@r4victor r4victor deleted the issue_2059_improved_http_docs branch December 6, 2024 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve REST (HTTP) API docs reference
1 participant
@r4victor