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

Move commonly used response schemas out of _common.yaml into _common.responses.yaml #499

Open
nhtruong opened this issue Aug 12, 2024 · 0 comments
Labels
good first issue Good for newcomers

Comments

@nhtruong
Copy link
Collaborator

nhtruong commented Aug 12, 2024

Coming from #489

A lot of OpenSearch responses are generic responses and have common schemas. For example, the ml.delete_model_group and ml.delete_model both use WriteResponseBase for their 200 response schema. However, contributors are most likely not aware of these popular schemas and will redefine these response schemas for the namespace they are working on.

I propose that we move these schemas into their own _common.responses.yaml file and highlight it in the DEV GUIDE.

@nhtruong nhtruong added the good first issue Good for newcomers label Aug 12, 2024
@nhtruong nhtruong changed the title [PROPOSAL] Move commonly used response schemas out of _common.yaml into _common.responses.yaml Move commonly used response schemas out of _common.yaml into _common.responses.yaml Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant