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

Generate types for all endpoints of github.com, ghes-3.1, and ghes-3.0 #15

Closed
12 tasks done
Tracked by #2127
gr2m opened this issue Aug 12, 2021 · 1 comment · Fixed by #27
Closed
12 tasks done
Tracked by #2127

Generate types for all endpoints of github.com, ghes-3.1, and ghes-3.0 #15

gr2m opened this issue Aug 12, 2021 · 1 comment · Fixed by #27

Comments

@gr2m
Copy link
Contributor

gr2m commented Aug 12, 2021

  • generate @octokit-next/types-openapi

  • rename @octokit-next/types-rest-api-github.com to @octokit-next/types-rest-api

  • generate @octokit-next/types-rest-api

  • generate diffs using xuorig/anicca: _diff files are now generated in octokit/openapi

  • generate @octokit-next/types-openapi-ghes-3.1 and @octokit-next/types-openapi-ghes-3.0

  • generate @octokit-next/types-rest-api-ghes-3.1 using @octokit-next/types-openapi-ghes-3.1

  • generate @octokit-next/types-rest-api-ghes-3.0 using @octokit-next/types-openapi-ghes-3.0

  • rename ghes-3.1.diff-to-api.github.com.deref.json files to ghes-3.1.anicca-diff-to-api.github.com.deref.json, etc #29

  • update all the generated ghes-3.0.json (etc) OpenAPI files to include a "diff" key in "x-octokit": {}. The "diff" object is only present if there are any changes. All ghes-* versions other than the latest one should include a diff to the next GHES version, the rest should have a diff to github.com. Example:

    {
      "diff": {
        "github.com": {
          "type": "added" // "added" | "removed" | "changed"
        }
      }
    }
  • generate ghes-3.1.diff-to-api.github.com.json files (etc) based on ghes-3.1.anicca-diff-to-api.github.com.deref.json and ghes-3.1.json

    Remove all unchanged operations. Remove all orphaned components. Add operations that have been removed but with "responses": {} and "parameters": [], independent of the original specification. Set "description" to an explanation and set x-octokit.versions.removed to the current version. If "responses": {} is invalid, add a single 501 response (501 Not Implemented) with a useful "description": "..." property

  • use ghes-3.1.diff-to-api.github.com.json in @octokit-next/types-rest-api-ghes-3.1

  • use ghes-3.0.diff-to-api.github.com.json in @octokit-next/types-rest-api-ghes-3.0

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 a pull request may close this issue.

1 participant