Environment Variables in definition
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
- #238 de @baywet — cerrado sin fusionar
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Tranquilo
- Stack tecnológico
- openapi
- Área
- api
Línea de trabajo
No se nombran archivos de implementación ni pruebas. Empieza por leer la discusión, los issues vinculados de OpenAPI y el pull request de Swagger UI para entender el alcance previsto. Para darlo por terminado, se requiere acordar un modelo implementable de variables de entorno para las definiciones, incluido cómo se declaran y referencian los valores.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Sorry if this came up before, I searched but could not find anything.
Environment variables have become something of the de facto mechanism to set server-specific values, then access them from software. The hosting providers I have worked with (AWS, Heroku, OpenShift) all offer features to easily set/import/export them and most software I've seen meant to run on these systems uses it for things like environment specific URLs, secrets etc.
But afaik there is no way to reference environment variables in an OpenAPI definition.
Would this be a feature to support? I imagine the definition having a section (probably at the top level) that specified a set of environment variables expected to be set, and possibly the default values to use when they are not set. Those variables could then be used in other parts of the definition.
My practical use cases comes from needing to set different authorization urls for different environments. Currently I am rendering swagger.json from JSP to implement this myself, but it seems to me this is a very generic use case that many people will face.
See also e.g.
https://github.com/OAI/OpenAPI-Specification/issues/169
https://github.com/OAI/OpenAPI-Specification/issues/779
https://github.com/swagger-api/swagger-ui/pull/3410
- Lenguaje dominante
- JavaScript
- Estrellas
- 122
- Forks
- 38
- Merge medio
- 1 d 17 h
- PR fusionados (30 d)
- 9
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de OAI/Overlay-Specification
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
OAI/Overlay-Specification#415 ·
Los mantenedores suelen responder en 1 día
-
ci: update the agenda template to lead us down the path of checking the spec repoPosiblemente ocupada @baywet la tomó hace 10 días. Abierto
OAI/Overlay-Specification#411 · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
ci: add automation to sync from main -> dev -> vX.Y-dev branchesPosiblemente ocupada @baywet la tomó hace 10 días. Abierto
OAI/Overlay-Specification#410 · 1 comentario · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
Revisit: should Overlays declare their target document format? (follow-up to #268)Posiblemente ocupada Un pull request vinculado a esta issue está abierto o ya se fusionó. Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
OAI/Overlay-Specification#367 · 3 comentarios · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
OAI/Overlay-Specification#358 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
Todos los issues de OAI/Overlay-Specification
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Los mantenedores suelen responder en 1 día
-
needs triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
pbakaus/impeccable#1055 ·
Los mantenedores suelen responder en 1 día
-
Add: EUROTV NEWSAbiertochannels:add check:passed
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día