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

Api status codes question #247

Open
carnahanliam opened this issue Dec 3, 2024 · 1 comment
Open

Api status codes question #247

carnahanliam opened this issue Dec 3, 2024 · 1 comment
Assignees
Labels
question Further information is requested

Comments

@carnahanliam
Copy link

Question

My team and I are integrating the Admin UI API into our existing IdentityServer application and I've been working on some integration tests. While writing tests and exploring the Swagger UI, I was getting a bit confused about some of the status codes returned from endpoints since they were different from those described in the Swagger doc.

For example, looking at a PUT request to "/api/Clients" I would expect the possible responses to be 201 and 400 (am I right in thinking the doc/UI response values are based on the response types set in the controllers by the ProducesResponseType attribute?):

image

but I've found a successful PUT returns 200.

Is this a possible area for improvement in the API documentation or am I missing something?

Thanks

@carnahanliam carnahanliam added the question Further information is requested label Dec 3, 2024
@skoruba
Copy link
Owner

skoruba commented Dec 3, 2024

Hi @carnahanliam - sure, if you have found something, please send me a PR and I will fix it. :)

Thank you for contacting me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants