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

Improvement: Add the new 409 response documentation reflecting the addition of a cache_lock on PUT /1.0/identity_groups/:id . RD-24154 #258

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

MihailoPavlovic-RC
Copy link
Contributor

Add the new response to make the clients aware that if they try to spam the PUT route, they can receive a 409 because the ressource will be locked while the 1st operation is being processed.

'409':
description: >-
If the Identity Group is already being updated, it will return a 409
error.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why the newline ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

specs/engage-digital_openapi3.yaml:3411 used as a reference, honestly not much more thought than that went into it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can remove it them, lets not copy weird things

@kalilz4485
Copy link
Contributor

Can you add a screenshot of the swagger view of the change ?

@MihailoPavlovic-RC
Copy link
Contributor Author

Can you add a screenshot of the swagger view of the change ?

image

@MihailoPavlovic-RC
Copy link
Contributor Author

MihailoPavlovic-RC commented Sep 17, 2024

Can you add a screenshot of the swagger view of the change ?

The swagger preview didn't change after the last commit (f42a0c7).
It seems that the choice of adding newlines in itself is inconsistent, so going without it seems indeed better as the sentence in itself isn't all that long in this case.

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