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

Cert authority, host factory, policies, public keys, roles, and resources spec documents are reviewed #129

Closed
izgeri opened this issue Jan 26, 2021 · 0 comments · Fixed by #153

Comments

@izgeri
Copy link
Contributor

izgeri commented Jan 26, 2021

Please review the following, with the goal of identifying anything that could be defined more clearly or organized better. We already have automation to verify the technical details of the spec; we mainly want to ensure the human-readable parts make sense and that there is nothing surprising / nothing that stands out as odd or missing in the spec definition.

In openapi.yml:

  • Review the tags and how the paths are organized by tag to make sure the groupings are sensible in openapi.yml
  • Review the ref names for the paths in openapi.yml to make sure the referenced component path makes sense for each endpoint
  • Review the schemas in openapi.yml to make sure their definitions are correct and the descriptions are clear
  • Review the responses in openapi.yml - are there any missing that you are surprised are not there?

In each of the files cert-auth.yml, host-factory.yml, policies.yml, public-keys.yml, roles.yml, and resources.yml:

  • Review the summary and description for each path to make sure the descriptions are clear and correct
  • Review the operationId for each path to ensure it makes sense - these will become client methods
  • Review the parameters for each path - is anything surprising?
  • Review the responses for each path - is anything surprising?
  • Do you know of any recent changes to the endpoints in this file that should be reflected in the spec but aren’t yet?

Please open up a PR for any minor tweaks you’d like to propose, but otherwise feel free to list suggested changes as a comment in this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

2 participants