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

[docs][chore] add documentation for the api surface #215

Open
1 of 4 tasks
BeauBouchard opened this issue May 31, 2023 · 0 comments
Open
1 of 4 tasks

[docs][chore] add documentation for the api surface #215

BeauBouchard opened this issue May 31, 2023 · 0 comments
Assignees
Labels
documentation Changes to documentation only (e.g. README.md)

Comments

@BeauBouchard
Copy link
Member

BeauBouchard commented May 31, 2023

The API should be a learning utility and well documented.

Programableweb no longer exists as of Feb 2023, We previously had a lot of exposure from their listing as a learning resource, and would like to document the free api on other platforms. rapidapi is a robust platform which has a lot of good free resources for small teams, it also gets people started using the api with code snippets and allows for people to query the api in a postman like web panel.

Tasks

  • Create a swagger/oapi3.0 document for the API
  • Create organization on rapidapi
  • Create shrewd documentation as apart of the org
  • update README.md with new link to the rapidapi page
@BeauBouchard BeauBouchard added the documentation Changes to documentation only (e.g. README.md) label May 31, 2023
@BeauBouchard BeauBouchard self-assigned this May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes to documentation only (e.g. README.md)
Projects
None yet
Development

No branches or pull requests

1 participant