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

[Schema Inaccuracy] Description regressions #36

Closed
gr2m opened this issue Sep 17, 2020 · 2 comments
Closed

[Schema Inaccuracy] Description regressions #36

gr2m opened this issue Sep 17, 2020 · 2 comments

Comments

@gr2m
Copy link
Collaborator

gr2m commented Sep 17, 2020

Schema Inaccuracy

the latest update brought back the filler descriptions for parameters, e.g. "secret_name parameter" for the secret_name parameter. github/openapi did remove these filler descriptions.

Also for ref in git/list-matching-refs the description is ref+ parameter, but the {ref+} URL parameter no longer exists, it's just {ref} now. Same with path+ parameter, branch+ parameter

actions/delete-self-hosted-runner-from-repo

  • "scope to use this endpoint." is missing at the end of the operation description

actions/getself-hosted-runner-for-repo

  • "endpoint." is missing at the end of the operation description

repos/create-dispatch-event (event_type parameter)

  • Description says event_type parameter is required, but schema says it's not.

repos/create-pages-site

  • Description removed: "The source branch and directory used to publish your Pages site." Just want to make sure this was not a mistake

Reproduction Steps

n/a

@zeke
Copy link
Contributor

zeke commented Sep 17, 2020

cc @github/docs-content @github/ecosystem-api

@xuorig
Copy link

xuorig commented Sep 23, 2020

Fixed in 1.0.0-rc.1!

@xuorig xuorig closed this as completed Sep 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants