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

Expand OAS endpoint descriptions, add more keywords to better refine definition #704

Open
cd-rite opened this issue Jul 11, 2022 · 0 comments
Assignees
Labels
enhancement New feature or request OAS

Comments

@cd-rite
Copy link
Collaborator

cd-rite commented Jul 11, 2022

Describe API behaviors with more expansive inline documentation.
Include endpoint purpose, description of data returned/expected from requests, any automatic behaviors or data changes that can occur, due to settings or inherent in the API.

Explain "projections" options and approach.

Review Post rejection criteria:
Add note that rule must be part of a Benchmark assigned to Asset, or will be rejected. (right now only mentions grant/status criteria)

@cd-rite cd-rite added enhancement New feature or request OAS labels Jul 11, 2022
@cd-rite cd-rite self-assigned this Jul 11, 2022
@cd-rite cd-rite changed the title Expand OAS endpoint descriptions Expand OAS endpoint descriptions, add more keywords to better refine definition Aug 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request OAS
Projects
Development

No branches or pull requests

1 participant