Compose all component types, not just schemas
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 30/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- openapi
- Domaine
- api
Piste de recherche
Commencez par examiner les règles relatives aux composants de response, la syntaxe de $ref, la composition allOf et les restrictions concernant les propriétés sœurs décrites dans la spécification. Définissez le comportement attendu pour composer une response réutilisable avec des modèles ou des exemples spécifiques à l’endpoint, puis documentez et validez un exemple montrant que le document résultant est valide.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
The current state of affairs is that responses can be defined as components and referenced with the "$ref":"{uri}" syntax, but these cannot be composed using the allOf directive. Trying to do so results in an error. Adding sibling properties also results in an error. So there is currently no way to define a response with a general schema and then add endpoint-specific models or examples. This seems like a gross oversight and major limitation.
For example, let's say that there are multiple endpoints that return lists of models following a standard response format, but each endpoint returns different models. It would be ideal to keep the reusable format of the response in a response component and compose it with the specific model under the path definition.
Without this functionality, the only options are to have invalid documents or abandon the use of response components.
- Langage dominant
- Markdown
- Étoiles
- 31.2k
- Forks
- 9.2k
- Merge moyen
- 2 j 9 h
- PR mergées (30 j)
- 17
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de OAI/OpenAPI-Specification
-
Housekeeping
Difficulté 1/5 Moins d'une heure Accessibilité débutants 45/100
OAI/OpenAPI-Specification#5566 ·
Les mainteneurs répondent en général sous 1 jour
-
Housekeeping
Difficulté 1/5 Moins d'une heure Accessibilité débutants 35/100
OAI/OpenAPI-Specification#5562 · 4 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Housekeeping
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 10/100
OAI/OpenAPI-Specification#5556 · 3 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
v3.2.1 releasePeut-être à nouveau libre @lornajane l’a pris il y a 33 jours, et aucune pull request n’est ouverte. Ouverte
OAI/OpenAPI-Specification#5460 · 11 commentaires · 1 réaction · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
-
param serialization
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
OAI/OpenAPI-Specification#5366 · 12 commentaires ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de OAI/OpenAPI-Specification
Issues similaires
-
[Bug]: Streamed /v1/chat/completions sends unredacted agent error text (keys) in the final chunkPeut-être pris @rodricksz4h5 l’a pris aujourd’hui. Ouvertearea/streaming comp/gateway P2 type/security
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
NousResearch/hermes-agent#138245 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 82/100
Luligu/matterbridge#655 ·
-
enhancement
Difficulté 1/5 1-3 heures Accessibilité débutants 88/100
graygarbage/HermesKey#23 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
we-promise/sure#4199 ·
Les mainteneurs répondent en général sous 1 jour