feature/fesd-615_response_ordering

[PrincessMadMath]

Jira issue link: fesd-615



Description of changes

Add deterministic ordering of response.

Additional checks

• Updated the documentation of the project to reflect the changes
• Added new tests that cover the code changes

[Copilot]

Pull request overview

This PR adds deterministic ordering of responses in OpenAPI document generation to ensure consistent output for better source control diffs and predictable documentation. The implementation sorts responses by HTTP status code, addressing an issue where responses from controller-level and method-level attributes were being added in processing order rather than by status code.

Key Changes:

• Introduced OrderResponseFilter to sort OpenAPI responses by status code
• Added comprehensive test case demonstrating the ordering fix with controller-level ProducesResponseType attributes
• Updated response descriptions for HTTP status codes 202 and 204 to use standard descriptions ("Accepted" and "No Content")

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/Workleap.Extensions.OpenAPI/Ordering/OrderResponseFilter.cs	New document filter that sorts paths, operations, and responses by status code for deterministic output
src/Workleap.Extensions.OpenAPI/Builder/OpenApiBuilder.cs	Registers the new OrderResponseFilter in the Swagger configuration
src/tests/WebApi.OpenAPI.SystemTest/Ordering/OrderingController.cs	New test controller demonstrating the ordering fix for multiple response types
src/tests/WebApi.OpenAPI.SystemTest/ExtractTypeResult/TypedResultProperContentTypeController.cs	Added NoContent test case to verify proper handling of 204 responses
src/tests/expected-openapi-document.yaml	Updated expected output showing properly ordered responses and corrected status code descriptions
src/tests/WebApi.OpenAPI.SystemTest/openapi-v1.yaml	Mirror of expected output for system test verification
README.md	Updated documentation to list the new ordering feature

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.