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

Switch on the display of the API additional search views documentation #4055

Closed
obulat opened this issue Apr 8, 2024 · 0 comments · Fixed by #4056
Closed

Switch on the display of the API additional search views documentation #4055

obulat opened this issue Apr 8, 2024 · 0 comments · Fixed by #4056
Assignees
@obulat
Labels
📄 aspect: text Concerns the textual material in the repository 🌟 goal: addition Addition of new feature 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: api Related to the Django API
Milestone
Creator, Tag, and...

Comments

@obulat
Copy link
Contributor

obulat commented Apr 8, 2024

Problem

The API additional search views parameters documentation is currently not shown because it's switched off using an env variable.

Description

The SHOW_COLLECTION_DOCS should be set to True

openverse/api/env.template

Line 59 in cd74e8a

SHOW_COLLECTION_DOCS=False

Additional context

The changes should be accompanied with the change in the private infrastructure repository to work in production.
@obulat obulat added 🟧 priority: high Stalls work on the project or its dependents 🌟 goal: addition Addition of new feature 📄 aspect: text Concerns the textual material in the repository 🧱 stack: api Related to the Django API labels Apr 8, 2024
@openverse-bot openverse-bot moved this to 📋 Backlog in Openverse Backlog Apr 8, 2024
@obulat obulat moved this from 📋 Backlog to 📅 To Do in Openverse Backlog Apr 8, 2024
@obulat obulat mentioned this issue Apr 8, 2024
Merged
8 tasks
@openverse-bot openverse-bot moved this from 📅 To Do to 🏗 In Progress in Openverse Backlog Apr 8, 2024
@obulat obulat mentioned this issue Apr 8, 2024
Closed
6 tasks
@openverse-bot openverse-bot moved this from 🏗 In Progress to ✅ Done in Openverse Backlog Apr 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@obulat obulat

Labels
📄 aspect: text Concerns the textual material in the repository 🌟 goal: addition Addition of new feature 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: api Related to the Django API
Projects
Openverse Backlog
Archived in project
Milestone
Creator, Tag, and Source frontend views
Development

Successfully merging a pull request may close this issue.

Show the additional search views documentation on the API docs site WordPress/openverse
1 participant
@obulat