Add Body & Response Examples
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 30/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- openapi, typescript
- Ambito
- api, documentation
Direzione di ricerca
Inizia esaminando le definizioni OpenAPI attuali per Items e per gli altri endpoint principali, quindi confrontale con la documentazione precedente dell’API. Definisci quali esempi semplici e relazionali di body e response e quali casi d’uso rientrano nell’ambito; il lavoro è completato quando gli endpoint selezionati espongono esempi utili.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Missing body and/or response examples on many of the key endpoints.
E.g. Items:
- missing body payload examples for simple and relational payloads
- missing response examples for simple and relational responses
Understanding that the dynamic and agnostic nature of Directus makes this difficult, it is still extremely helpful to see the structure of the body and responses via an example.
Perhaps 1 or more example use cases could be used to demonstrate the usage of the endpoints:
- simple CMS webpage
- simple Product Management
- could align with templates available on cloud?
- if more than one use case option, include a way to choose the example
Just some ideas. Mostly need examples similar to the older API docs.
- Lingua principale
- TypeScript
- Stelle
- 9
- Fork
- 8
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
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 directus/openapi
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
-
Duplicate "dashboards" entryForse di nuovo libera Una pull request per questa issue è stata chiusa senza essere unita. Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100
-
Id is not requiredAperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
-
Collection endpoints need more examplesForse di nuovo libera @hola-soy-milk l’ha presa 557 giorni fa e non c’è nessuna pull request aperta. Aperta
-
Collection endpoints have incorrect schemaForse di nuovo libera @hola-soy-milk l’ha presa 557 giorni fa e non c’è nessuna pull request aperta. Aperta
Tutte le issue di directus/openapi
Issue simili
-
bug go
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
genkit-ai/genkit#6761 · 1 commento ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
NousResearch/hermes-agent#136483 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
facioquo/stock-indicators-dotnet#2316 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
vercel-labs/skills#2460 ·
I maintainer di solito rispondono entro 1 giorno