OAI / OAI/OpenAPI-Specification

More example `same hierarchy` in path templating

Ouverte
#2,015 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

clarification examples request matching
Langage dominant
Markdown
Étoiles
31.2k
Forks
9.2k
Merge moyen
6 h 37 min
PR mergées (30 j)
27

Description

We can't describe different templated name with same hierarchy.

Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical.

But I can't understand what the same hierarchy means.

We can't describe these path templates

  /pets/{petId}
  /pets/{name}

But we can describe these?

  /pets/{petId}
  /pets/{name}/hello

These depth of the hierarchy is different but these is different templated name in same depth of hierarchy.
When we get /pets/1/hello we can match bottom paths and name=1.
These is partially the same, but the whole is different.

So I want to add more example to this section.

Guide de contribution

Ouvrir le guide de contribution

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

Trouvez la section de la spécification contenant la règle citée « same hierarchy » et lisez les indications environnantes sur la mise en modèle des chemins. Ajoutez un exemple clarifiant pourquoi /pets/{petId} et /pets/{name} sont en conflit, tandis que le chemin plus profond /pets/{name}/hello est différent, puis vérifiez que la formulation correspond à la règle.

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

Évaluation

Stack technique
openapi
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
55/100

Recevez les nouvelles issues par e-mail

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