OAI / OAI/OpenAPI-Specification

More example `same hierarchy` in path templating

Abierto
#2,015 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

clarification examples request matching
Lenguaje dominante
Markdown
Estrellas
31.2k
Forks
9.2k
Merge medio
6 h 37 min
PR fusionados (30 d)
27

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Encuentra la sección de la especificación que contiene la regla citada de «same hierarchy» y lee las indicaciones circundantes sobre las plantillas de rutas. Añade un ejemplo que aclare por qué /pets/{petId} y /pets/{name} entran en conflicto, mientras que la ruta más profunda /pets/{name}/hello es diferente, y comprueba que la redacción coincide con la regla.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
openapi
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
55/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.