Use more Redoc render features (REST API)
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- openapi
- Ambito
- api, documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- HTML
- Stelle
- 2
- Fork
- 17
- Merge medio
- 7g 18h
- PR unite (30g)
- 3
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di pulp/pulp-docs
-
epic
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
-
bug
Difficoltà 3/5 1-2 giorni Idoneità per principianti 48/100
-
documentation
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
-
Add issue templates Apertaenhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 55/100
-
enhancement
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
Tutte le issue di pulp/pulp-docs
Issue simili
-
Replayed reasoning items send "content": null, which the Responses API schema does not permit Apertabug CLI custom-model
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
bug confirmed issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
open-webui/open-webui#30750 · 1 commento ·
-
VerificationGate: ATTRIBUTION quote guard never matches a normal quotation (\b around the quote) Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
danielmiessler/LifeOS#2234 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100