Skip to content
Technical Committee Wiki for the SLA4OAI Specification
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
FirstMinimalSpecification.md
Manifest.md
PotentialFeatures.md
README.md
UseCases.md

README.md

SLA4OAI Technical Committee Wiki

This wiki is the central page for the Technical Committee behind the SLA4OAI Specification: an extension for OpenAPI Specification in order to describe Service Level Agreements (SLA) in RESTFul APIs including elements such as quota, rates or usage plans.

This committee is open to all the different members in OAI and the API developer community in general. If you are interested in participate please subscribe to the following list: sla@openapi.groups.io

In the next sections, you can find the meetings, minutes, material, and the roadmap for future actions.

History

  • 2016 - A first draft (v0.9.1) f the specification has evolved from an academic initiative started by ISA Research Group at University of Seville.
  • 2017 - Extension is presented to OpenAPI Technical Specification Committee that expressed their positive feedback about it.
  • 2018 - OpenAPI Governance Board aproved the creation of a Specific Interest Group to coordinate this extension. This group is originally formed by different members from the OAI consortium.
  • 2018 - The specific interest group starts its activities.

Roadmap

Proposed milestones for the specification:

  • 2019Q1 - Proposal of v1 of SLA4OAI
  • 2019Q2 - Open call for tooling/community feedback
  • 2019Q2 - Discuss new v2 features
  • 2019Q3/4 - Work on v2 of SLA4OAI

Working Material

SLA4OAI Manifest. This document contains the key foundational decisions to guide SLA4OAI.

Minimal specification for SLA4OAI v1. This document exposes the core elements that will be included in version 1 of the spec.

Use Cases List of User Stories to consider for the specification.

Potential features to include in following versions. Set of features grouped in areas that will be discussed in future versions of SLA4OAI.

Perspectives of SLA from the different participants:

Calls

This section contains the key content and minutes from the different calls.

2019-02-19

Participants: Nikhil Kolekar (Paypal), Isaac Hepworth (Google), Mike Ralphson, Pablo Fernandez (ISA Group), and Pedro J. Molina (Metadev & ISA Group)

In this meeting Nikhil presented his PoV about SLAs and APIs given his experience in operating and creating APIs at scale inside Paypal. Summary of the aspect covered follows:

  • API Performance and SLOs
  • Drivers for Customer Experience
  • SLO for APIs
  • Metrics
  • Measurement
  • Monitoring

Video recording (42 minutes)

2018-12-03

Participants: Madhurranjan Mohaan (Google), Pablo Fernandez (ISA Group), and Pedro J. Molina (Metadev & ISA Group)

In this meeting Madhurranjan presented his global point of view about SLAs in APIs:

Introduction of the concepts:

Technical concepts:

  • SLO: Service Level Objective (promise to users, expected limit values)
  • SLI: Service Level Indication (real measure in the system at a given point in time for a set of users)

Business concepts:

  • SLA: Service Level Agreement (business contract associated with an API as an aggregation of services with specific SLOs and prices)

Material

2018-11-07

Participants: Nikhil Kolekar (Paypal), Madhurranjan Mohaan (Google), Isaac Hepworth (Google), Scott Ganyo (Google), Kin Lane (API Evangelist), Mike Ralphson, Jeffrey ErnstFriedman (Linux Fundation), Pablo Fernandez (ISA Group), and Pedro J. Molina (Metadev & ISA Group)

Pablo Fernandez:

  • Presented the global perspective of the SLA4OAI specification including a foundational manifest, the current initial draft and the potential roadmap to follow.

Presentation of different members and feeback:

Kin Lane:

  • Keep it modular and separate aspects: SL Objectives, Plans, Metrics, etc. (decoupled)
  • Aspects than can be referenced externaly for different concerns
  • Relation to API Licenses

Nikhil Kolekar:

  • Paypal working in SLA for 3 years
  • Focus on SLO (Objectives): response times, latencty as warranties.
  • Proposes studing different cases on Service subscription (depending on roles) and classes of services

Madhurranjan Mohaan:

  • Experience on Apigee + Google
  • Identify roles involved: api developers, api managers, operations, consumers
  • Service Level: Indications, Objectives and Agreement
  • Grouping levels and use cases:
    • Simple services: SLI and SLO
    • Group of services: SLA as an combined contract
  • Declarative SLI and SLO
  • Runtime measuring + integrating with alerting tools
  • Identify roles and use cases for each role

Mike Ralphson:

  • Keep separate concerns and modular

Pedro J. Molina:

  • Call to action:
    • Goal define a neutral extension for SLA usable by the industry
    • Enroll anyone interested
    • Define scope, be pragmatic, keep it as siple as possible

Material

You can’t perform that action at this time.