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

feat: add support for pagination in GET /orgs/{org_id}/codespaces #397

Merged
merged 4 commits into from
Jun 28, 2022

Conversation

octokitbot
Copy link
Collaborator

If there are any new endpoints, then the code changes will likely required an update of @octokit/types. It should have received a pull request as well, merge & release it first. The @octokit/types should be updated automatically shortly after in this pull request.

Make sure to update the commits so that the merge results in helpful release notes, see Merging the Pull Request & releasing a new version.

In general

  • Avoid breaking changes at all costs
  • If there are no typescript or code changes, use a docs prefix
  • If there are typescript changes but no code changes, use fix(typescript) prefix
  • If there are code changes, use fix if a problem was resolved, feat if new endpoints / parameters were added, and feat(deprecation) if a method was deprecated.

@octokitbot octokitbot added the Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR label Jun 25, 2022
timrogers
timrogers previously approved these changes Jun 28, 2022
"url": "/repos/{owner}/{repo}/actions/caches",
"id": "get-actions-cache-list",
"scope": "actions",
"documentationUrl": "https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository",
Copy link
Contributor

Choose a reason for hiding this comment

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

@gr2m It's curious that we don't seem to recognise this new API as paginated. I'll merge anyway - but I guess we will want to come back to this.

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like the issue here is the operation ID. How do you reckon we should fix that at this point? Should we suggest that the owning team fixes it? Or maybe we should update our logic (e.g. look for the per_page param instead as well)?

@timrogers timrogers changed the title 🚧 GitHub OpenAPI specifications changed feat: add support for pagination in GET /orgs/{org_id}/codespaces Jun 28, 2022
@timrogers
Copy link
Contributor

@gr2m Any idea what is going on with the tests here? Is it the weird Typescript issues we've been having?

@gr2m gr2m self-assigned this Jun 28, 2022
@gr2m
Copy link
Contributor

gr2m commented Jun 28, 2022

@gr2m Any idea what is going on with the tests here? Is it the weird Typescript issues we've been having?

problem was caused by a recent change in @octokit/types, it has since been reverted
octokit/types.ts#405

fyi @kachick

@gr2m gr2m merged commit 3e38fbf into master Jun 28, 2022
@gr2m gr2m deleted the openapi-update branch June 28, 2022 19:56
@github-actions
Copy link
Contributor

🎉 This PR is included in version 2.20.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@timrogers
Copy link
Contributor

Thanks @gr2m! I have some code locally to fix the problem I flagged here. I’ll push tomorrow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants