Skip to content

Lcra/rework data objects organization openapi prod 14189 #850

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

Merged

Conversation

Leopold-Cramer
Copy link
Contributor

No description provided.

… conventions

- Changed collection GET endpoints to use 'list' prefix
- Changed single resource GET endpoints to use 'get' prefix
- Changed POST endpoints to use 'create' prefix
- Changed DELETE endpoints to use 'delete' prefix
- Updated security-related operation names for consistency
- Maintained existing operation IDs that already followed conventions
…quests and responses

- Created separate request/response objects for CRUD operations
- Created separate request/response objects for security operations
- Created comprehensive Organization object that includes all information
- Updated all endpoints to use appropriate request/response schemas
- Maintained backward compatibility while improving API structure
@Leopold-Cramer Leopold-Cramer force-pushed the LCRA/rework_dataObjects_organization_openapi_PROD-14189 branch from 91ad7da to 31854d0 Compare January 22, 2025 09:31
Copy link
Member

@jreynard-code jreynard-code left a comment

Choose a reason for hiding this comment

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

Great!

Some remarks btw ;)

Copy link
Contributor

@sjoubert sjoubert left a comment

Choose a reason for hiding this comment

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

It's ok for me. One thing we'll need to do at some point is clean all the generated markdown files for the doc. The build process automatically generate new one but does not clean the removed files. For example, in the PR we have both UpdateOrganizationRequest.md and OrganizationUpdateRequest.md due to a rename during dev.

You can manually clean these if you want but I'm sure there plenty more left to clean. This should be fixed in the build system directly.

Copy link
Member

@jreynard-code jreynard-code left a comment

Choose a reason for hiding this comment

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

LGTM

@Leopold-Cramer Leopold-Cramer merged commit b4cee22 into main Jan 23, 2025
33 checks passed
@Leopold-Cramer Leopold-Cramer deleted the LCRA/rework_dataObjects_organization_openapi_PROD-14189 branch January 23, 2025 15:20
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.

3 participants