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: publish new GitHub Enterprise Cloud (GHEC) specific @octokit/openapi-types-ghec package, plus lots of API changes #251

Merged
merged 1 commit into from
Sep 27, 2022

Conversation

octokitbot
Copy link
Contributor

@octokitbot octokitbot commented Sep 22, 2022

  • feat: publish new @octokit/openapi-types-ghec package with types for APIs supported by GitHub Enterprise Cloud, including GitHub Enterprise Cloud-exclusive APIs not available to other customers on api.github.com
  • feat: remove types for GitHub Enterprise Cloud (GHEC) specific APIs from the @octokit/openapi-types package

BREAKING CHANGE: Types for API operations only available to GitHub Enterprise Cloud (GHEC) customers will no longer appear in the @octokit/openapi-types package. These will only appear in the GHEC-specific @octokit/openapi-types-ghec package. The @octokit/openapi-types package now only includes APIs available to customers on GitHub.com using the Free, Pro and Teams plans.

  • feat: add support for new "Get a Dependabot alert" API (GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number})
  • feat: add support for new "Update a Dependabot alert" API (PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number})
  • feat: add support for new "List Dependabot alerts for a repository" API (GET /repos/{owner}/{repo}/dependabot/alerts)
  • fix: tweak documentation for repo starring related APIs (GET /repos/{owner}/{repo}/stargazers, GET /users/{username}/starred and GET /user/starred) to clarify what Accept header to send to get information about when stars were created
  • fix: tweak documentation for "Get community profile metrics" API (GET /repos/{owner}/{repo}/community/profile) to clarify that it only works with public repos which are not forks
  • fix: document the size attribute returned on repos across the API
  • fix: document that APIs can return 422 errors when an endpoint has been spammed with many requests
  • fix: document 301 status returned by labels-related APIs if the repo has been renamed or moved
  • fix: document 404 Not Found status returned by labels-related APIs
  • feat: add support for new "List organization secret" (GET /organizations/{org}/codespaces/secrets) Codespaces API
  • feat: add support for new "Get an organization public key" (GET /organizations/{org}/codespaces/secrets/public-key) Codespaces API
  • feat: add support for new "Get an organization secret" (GET /organizations/{org}/codespaces/secrets/{secret_name} ) Codespaces API
  • feat: adds support for new "Create or update an organization secret" (PUT /organizations/{org}/codespaces/secrets/{secret_name} ) Codespaces API
  • feat: add support for new "Delete an organization secret" (DELETE /organizations/{org}/codespaces/secrets/{secret_name}) Codespaces API
  • feat: add support for new "List selected repositories for an organization secret" (GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories) Codespaces API
  • feat: add support for new "Set selected repositories for an organization secret" ( PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories) Codespaces API
  • feat: add support for new "Add selected repository to an organization secret" (PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}) Codespaces API
  • feat: add support for new "Remove selected repository from an organization secret" (DELETE /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}) Codespaces API
  • feat: add support for resolution_comment attribute returned on secret scanning alerts
  • feat: add support for new scope attribute returned by the "Get a diff of the dependencies between commits" (GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}) API

@octokitbot octokitbot added maintenance typescript Relevant to TypeScript users only labels Sep 22, 2022
@timrogers timrogers changed the title 🚧 OpenAPI types changed feat: publish new GitHub Enterprise Cloud (GHEC) specific @octokit/openapi-types-ghec package, plus lots of API changes Sep 22, 2022
@timrogers
Copy link
Contributor

I'm pausing on merging this while I wait for @nickfloyd to weigh in on my planned approach.

I want to limit breaking changes for users and ensure that the default octokit.js setup still gives you support for normal GitHub.com APIs and GitHub Enterprise Cloud ones.

To do that, my plan is to merge this, and then point octokit/types.ts to the @octokit/openapi-types-ghec package. That means that the types will still be present for all APIs.

cc @gr2m

Copy link
Contributor

@nickfloyd nickfloyd left a comment

Choose a reason for hiding this comment

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

LGTM! The approach sounds good as well. Thanks for knocking this out!

@timrogers timrogers merged commit 2805e56 into main Sep 27, 2022
@timrogers timrogers deleted the openapi-update branch September 27, 2022 15:45
@timrogers
Copy link
Contributor

@gr2m I messed up the merge of this PR - it should be a breaking version, but the merge commit doesn't have the BREAKING CHANGE line. What do you suggest that I do?

gr2m added a commit that referenced this pull request Sep 29, 2022
…c `@octokit/openapi-types-ghec` package, plus lots of API changes (#251)"

This reverts commit 2805e56.
gr2m added a commit that referenced this pull request Sep 29, 2022
…c `@octokit/openapi-types-ghec` package, plus lots of API changes (#251)" (#255)

This reverts commit 2805e56.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
typescript Relevant to TypeScript users only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants