Use more Redoc render features (REST API)
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- openapi
- Área
- api, documentation
Línea de trabajo
Start with the linked Redoc demo/openapi.yaml and run the provided podman redoc container command to inspect the referenced render features. Investigate whether the required changes belong in pulp-docs, DRF, or spectacular. Done would require an agreed scope and API documentation demonstrating selected section groups, text sections, or deprecated fields and endpoints.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Problem
The Redoc API render engine has some under-used features (attached below).
Approach
Actually, the changes that can make it better may not belong to pulp-docs itself, but I'll put here to expose the big picture.
We should investigate how we can change DRF/spectacular/??? to make use of those.
To test the API website that originated the snapshots, run the code below.
Notice the relevant schema reference is this.
podman pull redocly/redoc # from docker registry
podman run --rm \
-p 8080:80 \
-e SPEC_URL=https://raw.githubusercontent.com/Redocly/redoc/refs/heads/main/demo/openapi.yaml \
redocly/redoc
Snapshots
Section groups
We can use sections like "Content Management", "Auth", "Admin", etc.
An opportunity to logically group pulp entities from the user perspective.
Text Sections
We can write text section that appear in the navigation.
This can be used for presenting useful links and info.
Some ideas:
Listing links to supported API pages (and provide the Redoc for those, of course):
## Supported versions
- [3.39](site:pulpcore/restapi/3.39/)
- [3.22](site:pulpcore/restapi/3.22/)
- [3.21](site:pulpcore/restapi/3.21/)
Shortcut links to other plugin API docs:
## Other plugins
[pulp_file](...) - [pulp_python](...) - [pulp_rpm](...) - etc
Deprecated field and endpoint
Just looks better and more obvious that you shouldn't use it.
- Lenguaje dominante
- HTML
- Estrellas
- 2
- Forks
- 17
- Merge medio
- 1 h 8 min
- PR fusionados (30 d)
- 1
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de pulp/pulp-docs
-
epic
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
-
bug
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
-
documentation
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
-
Add issue templatesAbiertoenhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 55/100
-
enhancement
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
Todos los issues de pulp/pulp-docs
Issues similares
-
[Bug]: Streamed /v1/chat/completions sends unredacted agent error text (keys) in the final chunkPosiblemente ocupada @rodricksz4h5 la tomó hoy. Abiertoarea/streaming comp/gateway P2 type/security
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
NousResearch/hermes-agent#138245 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 82/100
Luligu/matterbridge#655 ·
-
enhancement
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
graygarbage/HermesKey#23 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
we-promise/sure#4199 ·
Los mantenedores suelen responder en 1 día