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

[MAINT]: Rename find_app_installations to list_app_installations #1718

Open
1 task done
pbstriker38 opened this issue Oct 15, 2024 · 6 comments · May be fixed by #1721
Open
1 task done

[MAINT]: Rename find_app_installations to list_app_installations #1718

pbstriker38 opened this issue Oct 15, 2024 · 6 comments · May be fixed by #1721
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR

Comments

@pbstriker38
Copy link
Contributor

Describe the need

All the other index endpoints start with list_. I always need to come and search the code to figure out the name of this one.

This is also referred to as listing installations in the API documentation.

https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#list-installations-for-the-authenticated-app

SDK Version

No response

API Version

No response

Relevant log output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@pbstriker38 pbstriker38 added Status: Triage This is being looked at and prioritized Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR labels Oct 15, 2024
Copy link

👋 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! 🚀

@kfcampbell kfcampbell added Status: Up for grabs Issues that are ready to be worked on by anyone and removed Status: Triage This is being looked at and prioritized labels Oct 15, 2024
@kfcampbell
Copy link
Member

Perhaps we could alias that function for now to avoid a breaking change, and remove find_app_installations in a future release.

@pbstriker38
Copy link
Contributor Author

That sounds good to me

@pbstriker38
Copy link
Contributor Author

@kfcampbell Would you like me to open a PR for that?

@kfcampbell
Copy link
Member

If you have the time and inclination, that would be wonderful!

@pbstriker38
Copy link
Contributor Author

@kfcampbell
As I was working on the alias I noticed that the apps endpoint have a few deprecations that have existed since v4.8.0. These should probably be removed by now since it will be odd that a deprecated method points to another method that could also become deprecated soon.

There's actually a few deprecated methods that have existed since integrations was renamed to apps.

https://github.com/octokit/octokit.rb/blob/v9.2.0/lib/octokit/client/apps.rb#L30
https://github.com/octokit/octokit.rb/releases/tag/v4.8.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR
Projects
Status: 🔥 Backlog
Development

Successfully merging a pull request may close this issue.

2 participants