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

Update Cachito API documentation #630

Merged

Conversation

serg-cymbaluk
Copy link
Contributor

CLOUDBLD-7666

Fix the documentation mismatches with the actual API.

Maintainers will complete the following section

  • Commit messages are descriptive enough
  • Code coverage from testing does not decrease and new code is covered
  • OpenAPI schema is updated (if applicable)
  • DB schema change has corresponding DB migration (if applicable)
  • README updated (if worker configuration changed, or if applicable)

@brunoapimentel
Copy link
Contributor

It's more of a nitpick, but I noticed that the lib that creates the API docs crops the titles at 51 chars, no matter the size of the screen:
image

The last 3 endpoints are all over that limit, which makes them harder to read.

I also noticed that the titles are supposed to be read from a key named summary. Since we're only using description, the info there is copied to both the title and the description of each endpoint.

It seems that the 51 chars limitation is only applied to the title (summary), not to the description, so we could use both keys in case we need more information while describing an endpoint.

@serg-cymbaluk
Copy link
Contributor Author

@brunoapimentel

Added summaries for endpoints.

cachito/web/static/api_v1.yaml Outdated Show resolved Hide resolved
cachito/web/static/api_v1.yaml Outdated Show resolved Hide resolved
cachito/web/static/api_v1.yaml Outdated Show resolved Hide resolved
cachito/web/static/api_v1.yaml Outdated Show resolved Hide resolved
cachito/web/static/api_v1.yaml Outdated Show resolved Hide resolved
cachito/web/static/api_v1.yaml Outdated Show resolved Hide resolved
cachito/web/static/api_v1.yaml Outdated Show resolved Hide resolved
cachito/web/static/api_v1.yaml Outdated Show resolved Hide resolved
CLOUDBLD-7666

Fix the documentation mismatches with the actual API.

Signed-off-by: Serhii Tsymbaliuk <stsymbal@redhat.com>
Copy link
Contributor

@brunoapimentel brunoapimentel left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@akhmanova akhmanova left a comment

Choose a reason for hiding this comment

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

LGTM

@serg-cymbaluk serg-cymbaluk merged commit 5609a86 into containerbuildsystem:master Jan 13, 2022
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.

None yet

3 participants