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

Revise Summary and Description for Lists #88

Closed
4 tasks done
Tracked by #82
brian-comply0 opened this issue Mar 24, 2024 · 1 comment
Closed
4 tasks done
Tracked by #82

Revise Summary and Description for Lists #88

brian-comply0 opened this issue Mar 24, 2024 · 1 comment
Assignees

Comments

@brian-comply0
Copy link
Contributor

brian-comply0 commented Mar 24, 2024

Many of the endpoints that return lists, have a description that reads as if all of the files will be returned instead of a list of the files. Please revise the following endpoints as follows:

  • GET /{model-name}
    • The summary and description should say, "Returns a list of every relevant {model-name}." (instead of "Returns every relevant {model-name}")
  • GET /{model-name}/{id}/snapshot (note, this may be addressed in Manage Snapshot Tagging #84 )
    • The summary and description should say, "Returns a list of every relevant snapshot." (instead of "Returns every relevant snapshot")
  • GET /{model-name}/{id}/attachment
    • The summary and description should say, "Returns a list of every relevant attachment." (instead of "Returns every relevant attachment")
  • GET /profile/{id}/resolved-snapshot
    • The summary and description should say, "Returns a list of every relevant resolved profile catalog." (instead of "Returns every relevant resolved profile catalog")
@brian-comply0 brian-comply0 changed the title Revise Description for Lists Revise Summary and Description for Lists Mar 25, 2024
This was referenced Mar 25, 2024
@brian-comply0
Copy link
Contributor Author

This is fully addressed in PR #72

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

No branches or pull requests

2 participants