Skip to content

Commit 8cca8da

Browse files
committed
Initial files and skelleton
0 parents  commit 8cca8da

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.bak

LICENSE

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Copyright 2016 ISA Group - University of Seville & Icinetic
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
6+
7+
Unless required by applicable law or agreed to in writing, software
8+
distributed under the License is distributed on an "AS IS" BASIS,
9+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10+
See the License for the specific language governing permissions and
11+
limitations under the License.

SLA4OAI-spec.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# SLA for Open API Initiative Specification
2+
3+
### Version 0.1
4+
5+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL"
6+
in this document are to be interpreted as described in [RFC 2119](http://www.ietf.org/rfc/rfc2119.txt).
7+
8+
The **SLA4OAI** specification is licensed under [The Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
9+
10+
## Introduction
11+
SLA4OAI is an open source standard for describing SLA in APIs.
12+
13+
Based on the standards proposed by the [OAI](https://openapis.org/specification), SLA4OAI builds on top of it to add an optional profile
14+
for the definition of SLA (Service Level Agreements) on the APIs.
15+
16+
This SLA definition in a neutral vendor flavour will allow to foster innovation in the area where APIs expose and documents its SLA,
17+
API Management tools can import and measure such key metrics and composed SLAs for composed services aggregated way in a standard way.
18+
19+
## Revision History
20+
21+
Version | Date | Notes
22+
0.1 | 2015-12-18 | Initial Draft
23+
24+
## Definitions
25+
26+
### def1
27+
1
28+
### def2
29+
2
30+
31+
## Specification
32+
A SLA4API document is build as an extension to a given Swagger 2.0 document. This extension will add a SLA definition to all or part of the services exposed in
33+
the API.
34+
A full SLA is composed of the following parts:
35+
36+
1. Metrics
37+
2. Agreement Terms
38+
- Service Scope
39+
- Service Location
40+
- Terms of Service
41+
- Tracked Properties
42+
- Guarantee Terms
43+
44+
### Metrics
45+
todo...
46+
47+
### Agreement Terms
48+
todo...

0 commit comments

Comments
 (0)