OAI / OAI/OpenAPI-Specification

Adding optional SLA definitions with the Spec

Aperta
#541 12 commenti 5 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

metadata
Lingua principale
Markdown
Stelle
31.2k
Fork
9.2k
Merge medio
6h 37m
PR unite (30g)
27

Descrizione

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:

  1. Setup a basic and optional profile extension to describe a set of plan prices over APIs, Quota enforcement policies, constraints, etc.
  2. This information can (always optionally) decorate the OpenAPI spec inline on in a side file/resource linked from the main spec.
  3. 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
  4. 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.
  5. The ISA Research Group in the University of Seville is looking forward to provide tools for validation, creation and verification of SLAs for free.
  6. 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.
  7. 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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando l’issue correlata #51 e il contesto della specifica OpenAPI descritto qui. Definisci il profilo opzionale, la rappresentazione inline o collegata e l’ambito della validazione o degli strumenti prima di proporre un’estensione; il lavoro sarà considerato concluso quando saranno concordati la specifica e l’ambito dell’implementazione di riferimento.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
openapi
Ambito
api, backend-api-design
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
20/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.