[Question]T emporary loss of service when updating OpenAPI specification (removing an operation)
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
Línea de trabajo
Comienza reproduciendo el despliegue de APIOps Publisher con specification.yaml y apiInformation.json mientras solicitas un endpoint sin cambios. Revisa el comportamiento de la actualización in-place y de la revisión de la API; después, documenta si la interrupción de GatewayError es esperada y qué indicaciones de despliegue sin tiempo de inactividad son compatibles.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Release version
v6.0.2
Question Details
We are experiencing a temporary loss of service when deploying an update to an existing API using APIOps, even for a minimal OpenAPI change.
When we update specification.yaml (for example, removing a single operation) and deploy using APIOps, the API becomes unavailable for a short period during the deployment, although it recovers once the deployment finishes.
During this window, requests fail at the APIM Gateway with the following error:
GatewayError:
at forward-request
This behavior is consistently reproducible in our environment.
Is this temporary gateway failure during OpenAPI updates an expected behavior when using APIOps?
If so, is there a recommended zero-downtime approach for updating OpenAPI specifications with APIOps (for example, using API revisions)?
Thanks in advance for your help.
Expected behavior
For an API deployed on APIM Enterprise SKU, we would expect that:
Updating an OpenAPI specification (even removing an operation)
Does not cause a temporary service interruption
Actual behavior
During the APIOps deployment:
Requests to the API fail temporarily
APIM Gateway returns:
GatewayError:
at forward-request
Once the deployment completes, the API works correctly again
Reproduction Steps
-
Have an existing API deployed in Azure API Management (Enterprise SKU) using APIOps.
- The API is already serving traffic correctly.
- Backend configuration (serviceUrl) is defined in apiInformation.json.
- No API revisions are used (in-place update).
-
Modify only the OpenAPI specification (specification.yaml):
- Remove a single operation (endpoint).
- Do not change apiInformation.json, policies, products, or backend configuration.
-
Deploy the changes using the APIOps Publisher (same pipeline and configuration as previous deployments).
-
While the deployment is running, send requests to existing (unchanged) endpoints of the API.
-
Observe that during the deployment window, requests temporarily fail at the APIM Gateway with the following error:
GatewayError:
at forward-request -
Once the APIOps deployment finishes, the API starts working correctly again without any further changes.
- Lenguaje dominante
- C#
- Estrellas
- 448
- Forks
- 247
- Métricas de merge de PR
- Sin PR fusionados en 30 d
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 Azure/apiops
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 55/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
Todos los issues de Azure/apiops
Issues similares
-
type/automation type/tech-debt
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
t/bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
ci-failure-cause test-failure
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
area:auth FE mvp P3
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
klasolsson81/jobbliggaren#1788 ·