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

Split out and retire the MiscellaneousClient #2572

Closed
SeanKilleen opened this issue Sep 15, 2022 · 3 comments
Closed

Split out and retire the MiscellaneousClient #2572

SeanKilleen opened this issue Sep 15, 2022 · 3 comments
Assignees
Labels
hacktoberfest Issues for participation in Hacktoberfest Status: Stale Used by stalebot to clean house Status: Up for grabs Issues that are ready to be worked on by anyone Type: Feature New feature or request Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR

Comments

@SeanKilleen
Copy link
Contributor

SeanKilleen commented Sep 15, 2022

While working on #2571 to support #2474, I noticed the MiscellaneousClient had a link to misc rest endpoint that had since been separated into their own named endpoints and docs. The Octokit .NET client updated the URLs but didn't update the C# code to reflect them.

My suggestion, which I think can be done in steps:

  • Method by method:
  • Create named clients & methods to support the functionality within MiscellaneousClient
  • Use those clients from within MiscellaneousClient to ensure no issues.
  • Deprecate methods to ensure users know it's just a redirect.
  • Deprecate MiscellaneousClient itself.
  • Remove MiscellaneousClient in a future release.

Creating this issue per discussion with @nickfloyd at #2571 (comment)

@JonruAlveus
Copy link
Collaborator

❤️ I'd be happy to pick this one up.

@JonruAlveus
Copy link
Collaborator

Clients:

  • EmojisClient
    • /emojis
  • MarkdownClient
    • /markdown/raw
    • /markdown
  • GitIgnoreClient
    • /gitignore/templates
    • /gitignore/templates/{name}
  • LicensesClient
    • /licenses
    • /licenses/{key}
  • RateLimitClient
    • /rate_limit
  • MetaClient
    • /meta

@nickfloyd nickfloyd added Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR Type: Feature New feature or request Status: Up for grabs Issues that are ready to be worked on by anyone and removed category: housekeeping labels Oct 27, 2022
@nickfloyd nickfloyd moved this to 🔥 Backlog in 🧰 Octokit Active Dec 5, 2022
@nickfloyd nickfloyd added the hacktoberfest Issues for participation in Hacktoberfest label Sep 20, 2023
Copy link

👋 Hey Friends, this issue has been automatically marked as stale because it has no recent activity. It will be closed if no further activity occurs. Please add the Status: Pinned label if you feel that this issue needs to remain open/active. Thank you for your contributions and help in keeping things tidy!

@github-actions github-actions bot added the Status: Stale Used by stalebot to clean house label Jun 17, 2024
@github-project-automation github-project-automation bot moved this from 🔥 Backlog to ✅ Done in 🧰 Octokit Active Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest Issues for participation in Hacktoberfest Status: Stale Used by stalebot to clean house Status: Up for grabs Issues that are ready to be worked on by anyone Type: Feature New feature or request Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR
Projects
Archived in project
Development

When branches are created from issues, their pull requests are automatically linked.

3 participants