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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃殌 Add information about API authentication requirements #267

Open
bsantosh909 opened this issue Oct 24, 2022 · 2 comments
Open

馃殌 Add information about API authentication requirements #267

bsantosh909 opened this issue Oct 24, 2022 · 2 comments
Labels
On HOLD Issue/PR is on hold for the time being

Comments

@bsantosh909
Copy link
Owner

bsantosh909 commented Oct 24, 2022

Is your feature request related to a problem? Please describe.

Need to add a feature to mention if the API can be used without authentication or if it has any authentication system.

Describe the solution you'd like

The first solution is to add the key authentication key with the following values:

  • none (e.g. JokeAPI)
  • key (e.g. IMDB API)
  • oauth (e.g. Discord)

I guess we might need to add another key to indicate if the API requires signup or not. (* This is completely optional)

Describe alternatives you've considered

N/A. Feedbacks are welcome though

Additional context

Anyone working on this issue will have to proof-read all the existing API files and add the key-value to those files.
And also update the frontend to display the data properly on the cards.

Refer to #275 which does similar thing

@bsantosh909 bsantosh909 added Enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers Priority: Medium Issue or PR with medium priority hacktoberfest labels Oct 24, 2022
@bsantosh909 bsantosh909 changed the title 馃殌 [Feature] Add information about API authentication requirements 馃殌 Add information about API authentication requirements Oct 24, 2022
@thenishantsapkota
Copy link
Contributor

Can I work on this?

@bsantosh909
Copy link
Owner Author

Sorry @thenishantsapkota but this is on hold for the time being 馃檹

@bsantosh909 bsantosh909 added On HOLD Issue/PR is on hold for the time being and removed help wanted Extra attention is needed good first issue Good for newcomers Priority: Medium Issue or PR with medium priority Enhancement New feature or request labels Oct 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
On HOLD Issue/PR is on hold for the time being
Projects
None yet
Development

No branches or pull requests

2 participants