Code Monkey home page Code Monkey logo

sla4oai-researchspecification's Introduction

SLA for Open API Initiative RESEARCH Specification

The goal of the SLA4OAI Specification is to promote an open specification for services level agreement over REST APIs which are defined via OpenAPI Specification. This specification describes the format for defining SLAs over APIs in a Technology-Neutral / Vendor-neutral way.

This GitHub project is the starting point for SLA4OAI. Here you will find the information you need about the SLA4OAI Specification, a simple static sample of what it looks like, and some general information regarding the project. In case you are interested in following or participating in the discussions for future evolutions of the spec, please refer to the SLA4OAI Technical Committee Wiki. The current version of the official SLA4OAI Specification is 1.0.0 (Draft) and you can find it here

In parallel to the main official SLA4OAI spec, a different Research Spec with additional features is being developed. This research track provides a mean to validate experimental features and specifications, such as a Basic SLA Management Services to stadardized services that control, manage, report and track SLAs.

Current Research Version - 0.10.0

The current Research Version of the SLA4OAI Specification is 0.10.0 and you can find it here

The current Research Version of the Basic SLA Management Services is 0.7.1 and you can find it here

Tools and Libraries

  • SLA4OAI-node module for NodeJS to implement APIs regulated by SLA and configured with SLA4OAI Research Version 0.9.3
  • SLA4OAI-analyzer API to validate SLA4OAI Specs

sla4oai-researchspecification's People

Contributors

allonas avatar antgamdia avatar dani8art avatar pafmon avatar pjmolina avatar raffrearaus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

kyyberi

sla4oai-researchspecification's Issues

Images are not being displayed

All the images are linked to Bitbucket not to this repo. Furthermore, Github does not allow embedding svg images in the .md, so they have to be converted to png.

SLA Incubator Project within OAI

Hello Everyone,

I have setup a project page, and setup a draft proposal for submitting the SLA project to the OAI Technical Oversight Board (TOB).

Please help me finish the proposal, and discuss any other considerations as we move to setup the incubator project.

Thanks!!

Kin Lane

Potential items for review

  • Make document instances identifiable and versionable, e.g. with a top-level sla4api property containing a semver value (I note that some of the examples have an sla property with a numeric 1.0 value)
  • move Specification.md to something like versions/1.0.0-pre.md
  • use full text of Apache-2.0 license so GitHub identifies it correctly
  • GitHub: fix No description, website, or topics provided.
  • GitHub: add Code of Conduct and issue templates early in the process
  • use open formats for documentation directory
  • define a media-type for SLA instance documents following the vnd.oai. style with +json variant and version property
  • recommend naming of the instance documents (e.g. sla.yaml or sla.json)
  • consider registering an RFC5785 .well_known location
  • include a (cut-down?) contact object so contact information specific to the SLA info is available
  • allow specification extensions (x- properties) within SLA instance documents for extensibility
  • update Swagger 2.0 examples to OpenAPI 3.x - should include patch version: e.g. 3.0.3
  • is it appropriate to use floating point number types for currency values (especially for things like BTC)? Suggest integer with divisor or multiplier / units modifier
  • use ISO-8601 for durations
  • set up CI to validate/lint markdown using mdv - no issues currently
  • s/quartely/quarterly/g
  • s/matric/metric/g
  • s/managment/management/g

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.