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

Catalogi API: API documentation incorrect #1976

Closed
sergei-maertens opened this issue Apr 12, 2022 · 3 comments
Closed

Catalogi API: API documentation incorrect #1976

sergei-maertens opened this issue Apr 12, 2022 · 3 comments
Assignees
@michielverhoef
Labels
bug Iets werkt niet zoals bedoeld
Milestone
Catalogi API 1.2.0

Comments

@sergei-maertens
Copy link
Collaborator

sergei-maertens commented Apr 12, 2022 •
edited
Loading

Bug

In the Catalogi API, the "publish" actions are not correctly documented, e.g. https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/catalogi-api/1.1.0/src/openapi.yaml#operation/besluittype_publish

The response status code is HTTP 200 instead of the documented HTTP 201, and the titles/summaries of the operations in the API spec also do not correctly reflect the behaviour.

This has been fixed in Open Zaak, so we can probably contribute that back relatively easily.

Additionally, the error response status codes are missing for these actions (HTTP 4xx, HTTP 5xx)
@sergei-maertens sergei-maertens added the bug Iets werkt niet zoals bedoeld label Apr 12, 2022
@michielverhoef michielverhoef added this to the Catalogi API 1.2.0 milestone Apr 12, 2022
@michielverhoef
Copy link
Collaborator

This has been fixed in Open Zaak, so we can probably contribute that back relatively easily.

PR's are welcome anytime :-)

sergei-maertens added a commit to maykinmedia/catalogi-api that referenced this issue Apr 13, 2022
@sergei-maertens
🐛 [VNG-Realisatie/gemma-zaken#1976] -- fix the API schema documentati…
877e607 
…on for publish actions

The publish actions were missing the correct summary, description and
possible response status codes documentation.
sergei-maertens added a commit to maykinmedia/catalogi-api that referenced this issue Apr 13, 2022
@sergei-maertens
🍱 [VNG-Realisatie/gemma-zaken#1976] -- fix the API schema documentati…
e252b47 
…on for publish actions

The publish actions were missing the correct summary, description and
possible response status codes documentation.
@sergei-maertens
Copy link
Collaborator Author

@michielverhoef I've created a PR: VNG-Realisatie/catalogi-api#130

I'd like to argue to get this in Catalogi API 1.1.1 rather than 1.2.0, since there is effectively a bug in the documentation - the publish endpoint documents a response status code HTTP 201, but in reality this is a HTTP 200

sergei-maertens added a commit to maykinmedia/catalogi-api that referenced this issue Jun 21, 2022
@sergei-maertens
🐛 [VNG-Realisatie/gemma-zaken#1976] -- fix the API schema documentati…
c8ecbee 
…on for publish actions

The publish actions were missing the correct summary, description and
possible response status codes documentation.
sergei-maertens added a commit to maykinmedia/catalogi-api that referenced this issue Jun 21, 2022
@sergei-maertens
🍱 [VNG-Realisatie/gemma-zaken#1976] -- fix the API schema documentati…
4b0565e 
…on for publish actions

The publish actions were missing the correct summary, description and
possible response status codes documentation.
sergei-maertens added a commit to VNG-Realisatie/catalogi-api that referenced this issue Jun 21, 2022
@sergei-maertens
🐛 [VNG-Realisatie/gemma-zaken#1976] -- fix the API schema documentati…
c2aefbf 
…on for publish actions

The publish actions were missing the correct summary, description and
possible response status codes documentation.
sergei-maertens added a commit to VNG-Realisatie/catalogi-api that referenced this issue Jun 21, 2022
@sergei-maertens
🐛 [VNG-Realisatie/gemma-zaken#1976] -- fix the API schema documentati…
903a8cf 
…on for publish actions

The publish actions were missing the correct summary, description and
possible response status codes documentation.
@michielverhoef
Copy link
Collaborator

As this has been fixed the issue will be closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@michielverhoef michielverhoef

Labels
bug Iets werkt niet zoals bedoeld
Projects
None yet
Milestone
Catalogi API 1.2.0
Development

No branches or pull requests
2 participants
@sergei-maertens @michielverhoef