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

Fix response json example for http 200 on entity deletion #1761

Closed

Conversation

spwoodcock
Copy link
Contributor

What is included in this PR?

  • For the Deleting an Entity section in the Central API docs, the response example for a HTTP 200 is incorrect.
  • The docs state that it is a JSON response, with a string value {'message': 'success'}:

image

  • In fact, on testing, the actual response is a JSON with bool value {'success': True}.
  • I updated the docs to reflect this.

Context

  • I wasn't sure if the OpenAPI docs are auto-generated somehow, but I made a PR anyway to update the yaml manually.
  • Feel free to close this PR and update the upstream if that is the case.

@lognaturel
Copy link
Member

Thanks! Indeed the API docs are managed in the Central backend repo. I've made that clearer in this readme and made the fix at getodk/central-backend#1121

@lognaturel lognaturel closed this Apr 3, 2024
@spwoodcock spwoodcock deleted the docs/entity-deletion-success branch April 3, 2024 07:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants