KEMBAR78
[DOCS]: README and yardocs refer to deleted method `#create_authorization` · Issue #1639 · octokit/octokit.rb · GitHub
Skip to content

[DOCS]: README and yardocs refer to deleted method #create_authorization #1639

@danbernier

Description

@danbernier

Describe the need

I've been trying to generate an auth token via Octokit 7.2.0 using Octokit::Client#create_authorization, following the README and the yardocs hosted at octokit.github.io, which is linked to from the "About" section of the octokit repo.

I keep getting NoMethodErrors:

undefined method `create_authorization' for #<Octokit::Client:0x000000010da37718 ...> (NoMethodError)

According to git log -S create_authorization, that method was deleted in 017b0e3 as part of #1494, to fix #1429, because per @timrogers, "the APIs it exposes were deprecated back in 2020."

The yardocs' colophon indicates they're 5 years old:

Generated on Thu Aug 30 11:17:17 2018 by yard 0.9.16 (ruby-2.5.1).

I'll update the README to drop those references, but it would be great to also regenerate the yardocs (it looks like they're on the gh-pages branch? I don't know the process for pushing to it.)

Most broadly: what replaces create_authorization? Is there a way to generate an access token for a user on-the-fly? And what else in the README is stale?

SDK Version

Octokit.rb 7.2.0

API Version

No response

Relevant log output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    Status: Up for grabsIssues that are ready to be worked on by anyoneType: DocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    ✅ Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions