SEED-platform / seed

Standard Energy Efficiency Data (SEED) Platform™ is a web-based application that helps organizations easily manage data on the energy performance of large groups of buildings.
Other
107 stars 55 forks source link

Swagger Response Codes are Largely Incorrect #3906

Open axelstudios opened 1 year ago

axelstudios commented 1 year ago

Describe the bug The vast majority of our POST API endpoints show 201 (Created) as the http response code, when in reality it's almost always 200

Expected Behavior The API documentation should accurately reflect the endpoints

Actual Behavior The API documentation is incorrect

Steps to Reproduce Compare the response codes shown in Swagger to the actual response codes, particularly with POST requests

Additional Context If @swagger_auto_schema is not given responses, it automatically assumes DELETE returns 204, POST returns 201, and everything else returns 200.

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity within 60 days. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity within 60 days. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] commented 12 months ago

This issue has been automatically marked as stale because it has not had recent activity within 60 days. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] commented 10 months ago

This issue has been automatically marked as stale because it has not had recent activity within 60 days. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] commented 7 months ago

This issue has been automatically marked as stale because it has not had recent activity within 60 days. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] commented 5 months ago

This issue has been automatically marked as stale because it has not had recent activity within 60 days. It will be closed if no further activity occurs. Thank you for your contributions.