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.

Sign up for GitHub

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

Jump to bottom

Remove references to using cURL in the API documentation #3208

Closed
AetherUnbound opened this issue Oct 16, 2023 · 1 comment · Fixed by #3209
Closed

Remove references to using cURL in the API documentation #3208

AetherUnbound opened this issue Oct 16, 2023 · 1 comment · Fixed by #3209
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature good first issue New-contributor friendly help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation

Comments

@AetherUnbound
Copy link
Collaborator

Description

We note "You can refer to the cURL request samples for examples on how to consume this endpoint." in every endpoint's description. This is redundant and unnecessary, we can likely remove this string entirely:

openverse/api/api/docs/base_docs.py

Lines 8 to 11 in 098925a

refer_curl = (
"You can refer to the cURL request samples "
"for examples on how to consume this endpoint."
)

@AetherUnbound AetherUnbound added good first issue New-contributor friendly help wanted Open to participation from the community ✨ goal: improvement Improvement to an existing user-facing feature 📄 aspect: text Concerns the textual material in the repository 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation labels Oct 16, 2023
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Openverse Backlog Oct 16, 2023
@bermr bermr mentioned this issue Oct 17, 2023
Merged
8 tasks
@bermr
Copy link
Contributor

bermr commented Oct 17, 2023

Hi, just made a PR: #3209 :)

@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Openverse Backlog Oct 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature good first issue New-contributor friendly help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation
Projects
Openverse Backlog
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Remove unnecessary information from API docs bermr/openverse
2 participants
@AetherUnbound @bermr