danielgtaylor / danielgtaylor/openapi-cli-generator

Links Support

Ouverte
#4 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

feature help-wanted
Langage dominant
Go
Étoiles
218
Forks
54
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Add the ability to follow [OpenAPI 3 links](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#linkObject) to fetch additional data and add it to the response for a given operation. For example, you might get an item overview with a link to get item details. A new CLI option like `--link=details` could then be used to trigger the additional request and put a `details` field into the response with the response data from the details call. All of this would happen before response filtering/projection so you can select just the fields you care about.

Bonus: support an extension like `x-collection` so this works for calls that return a list of items, so that you can get the link for each item in the list by treating index 0 as a wildcard in the body pointer.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par lire la spécification OpenAPI 3 Link Object liée dans l’issue, puis suivez les points d’entrée de la gestion des options CLI, du flux de requête supplémentaire et du filtrage ou de la projection des réponses. Le travail est terminé lorsqu’un lien nommé tel que `details` peut déclencher une requête de suivi et ajouter sa réponse avant la projection ; le comportement facultatif de `x-collection` devrait gérer les éléments de liste au moyen du wildcard index-0 proposé.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
go, openapi
Domaine
api, cli
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.