Skip to content

fix: replace missing component in override with inline definition #475

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.

Sign up for GitHub

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

Jump to bottom
Merged
oscard0m merged 4 commits into from
Jan 8, 2025
Merged

fix: replace missing component in override with inline definition #475

oscard0m merged 4 commits into from
Jan 8, 2025

Conversation

@wolfy1339
Copy link
Member

@wolfy1339 wolfy1339 commented Jan 8, 2025

Resolves #ISSUE_NUMBER

Before the change?

  • The override re-adding the fine grained permissions endpoint was linking to a non-existant schema component

After the change?

  • Replaces the link to the schema component with an inline decleration

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

@wolfy1339 wolfy1339 added the Type: Bug Something isn't working as documented label Jan 8, 2025
@wolfy1339 wolfy1339 requested a review from oscard0m January 8, 2025 17:13
@github-actions
Copy link
Contributor

github-actions bot commented Jan 8, 2025

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

@wolfy1339
Copy link
Member Author

wolfy1339 commented Jan 8, 2025

This is blocking octokit/types.ts#658.

I simply took the definition from the deref version of the override and used it there instead

@oscard0m
Copy link
Member

oscard0m commented Jan 8, 2025 •
edited
Loading

After checking https://github.com/github/rest-api-description/blob/main/descriptions/api.github.com/api.github.com.json I see the reference and deref are not present anymore.

Does this mean we should remove it completely instead? ...or open an issue in https://github.com/github/rest-api-description?

@wolfy1339
Copy link
Member Author

wolfy1339 commented Jan 8, 2025

I added it back to avoid a breaking change in order to at least get v17 changes published.

@oscard0m oscard0m merged commit c4ba32b into main Jan 8, 2025
5 checks passed
@oscard0m oscard0m deleted the fix-missing-component branch January 8, 2025 18:04
@octokitbot
Copy link
Contributor

octokitbot commented Jan 8, 2025

🎉 This PR is included in version 17.1.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@oscard0m oscard0m oscard0m approved these changes

Assignees

No one assigned

Labels

released Type: Bug Something isn't working as documented

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@wolfy1339 @oscard0m @octokitbot