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

Log warning in case of 404 for unrecognized route #134

Open
gr2m opened this issue Jan 1, 2022 · 0 comments
Open

Log warning in case of 404 for unrecognized route #134

gr2m opened this issue Jan 1, 2022 · 0 comments
Labels
Type: Feature New feature or request

Comments

@gr2m
Copy link
Contributor

gr2m commented Jan 1, 2022

follow up to #80 (comment)

The setup would work similar to how https://github.com/octokit/plugin-paginate-rest.js updates src/generated/paginating-endpoints.ts.

  1. Create an update workflow like octokit/plugin-paginate-rest.js:.github/workflows/update.ym
  2. Create an update-endpoints script that will take the OpenAPI specification from @octokit/openapi, create/update a generated/rest-api-routes.js file, which would be an array of all REST API routes that GitHub supports
  3. When sending a request, compare the given route to the known routes defined in generated/rest-api-routes.js. If the route is unknown, log a warning if the response is a 404.

No worries if that doesn't make sense @praneetloke, there is lots of inside knowledge behind how the automated updates work for the@octokit/* packages based updates to GitHub's OpenAPI specifications

@nickfloyd nickfloyd added the Type: Feature New feature or request label Jun 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants