Skip to content

Conversation

@github-actions
Copy link
Contributor

This is an automated pull request to release the candidate branch into production, which will trigger a deployment.
It was created by the [Production PR] action.

- Added functionality to write OpenAPI documentation to a JSON file during development.
- Updated response schemas across various controllers to use the new content format for better clarity and structure.
- Improved error handling and response consistency for various endpoints, including organization, member, policy, and risk management.

These changes improve the API's documentation and response handling, ensuring better usability and maintainability.

Co-authored-by: Mariano Fuentes <marfuen98@gmail.com>
@vercel
Copy link

vercel bot commented Sep 16, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
app (staging) Ready Ready Preview Comment Sep 16, 2025 6:18pm
portal (staging) Ready Ready Preview Comment Sep 16, 2025 6:18pm

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

* Enhance API documentation and response schemas

- Added functionality to write OpenAPI documentation to a JSON file during development.
- Updated response schemas across various controllers to use the new content format for better clarity and structure.
- Improved error handling and response consistency for various endpoints, including organization, member, policy, and risk management.

These changes improve the API's documentation and response handling, ensuring better usability and maintainability.

* Refactor PeopleController and enhance OpenAPI documentation

- Updated PeopleController to improve code readability by formatting and organizing imports and method parameters.
- Added UserResponseDto schema to OpenAPI documentation for better clarity on user-related responses.
- Enhanced PeopleResponseDto schema to include additional properties for improved response structure.

These changes enhance the maintainability of the code and improve the API documentation for better usability.

* Enhance Policies and Tasks Controllers with OpenAPI Documentation

- Refactored import statements for better organization in PoliciesController and TasksController.
- Added ApiExtraModels for PolicyResponseDto and TaskResponseDto to improve API documentation.
- Updated OpenAPI JSON schema to include detailed definitions for PolicyResponseDto, TaskResponseDto, and AttachmentResponseDto, enhancing clarity and usability of the API responses.

These changes improve the maintainability of the code and enrich the API documentation for better developer experience.

---------

Co-authored-by: Mariano Fuentes <marfuen98@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants