mattpolzin / mattpolzin/JSONAPI-OpenAPI

sort out test properties "skipExample" such that request & response and multiple examples are accounted for.

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

Personne n'a encore pris cette issue.

Langage dominant
Swift
Étoiles
12
Forks
1
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

test properties currently just allow you to skip using the response example to validate response data or not.

  • there needs to be a way to use a request example as request body or not (and validate that it matches the schema for the request).
  • there needs to be a way to support multiple labeled examples instead of only supporting a single example.

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 localiser la gestion de la propriété de test skipExample et examinez comment les exemples de réponse sont actuellement utilisés. Implémentez la prise en charge de l’utilisation et de la validation indépendantes des exemples de requête, ainsi que de plusieurs exemples de requête et de réponse étiquetés ; le travail est terminé lorsque les deux directions d’exemples et plusieurs étiquettes sont représentées correctement.

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

Évaluation

Stack technique
openapi, swift
Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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