OAI / OAI/OpenAPI-Specification
Adding optional SLA definitions with the Spec
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Markdown
- Estrellas
- 31.2k
- Forks
- 9.2k
- Merge medio
- 6 h 37 min
- PR fusionados (30 d)
- 27
Descripción
Related to #51
We have identified in the market a need for measuring and enforcement SLA in APIs. Specially, API vendors would benefit from an standard import of SLA metrics to measure and track importing them along with the OpenAPI definition in an standard way.
In this line, we have started a R&D project by Icinetic and the University of Seville at Spain to work on: "Extension on OpenAPI for the definition of Service Level Agreements (SLA)".
The project is looking forward to:
- Setup a basic and optional profile extension to describe a set of plan prices over APIs, Quota enforcement policies, constraints, etc.
- This information can (always optionally) decorate the OpenAPI spec inline on in a side file/resource linked from the main spec.
- Third party tools like Hivepod: can generate both: Swagger spec, service implementation, and SLA policy + SLA enforcement code, data repository to store the metrics and tools for analysis
- Third party tools like API Management tools can use this SLA info also to measure and track the level of compliant with respect this SLA specified.
- The ISA Research Group in the University of Seville is looking forward to provide tools for validation, creation and verification of SLAs for free.
- We will provide a reference implementation showing the full scenario: from sample Microservice being measured, using a data store to gather metrics and an analysis tool to visualize the SLA grade of compliance.
- Eventually, we would love to contribute to OAI (next version) with an open source extension for SLA definition.
Looking forward for early feedback and to join forces with OAI wanting to support an extension for this in an standardized way.
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.
Línea de trabajo
Comienza revisando el issue relacionado #51 y el contexto de la especificación OpenAPI descrito aquí. Define el perfil opcional, la representación inline o enlazada y el alcance de la validación o de las herramientas antes de proponer una extensión; se considerará terminado cuando se hayan acordado la especificación y el alcance de la implementación de referencia.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- openapi
- Área
- api, backend-api-design
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 20/100