Readme.md 2.58 KB
Newer Older
1 2 3
# NFV SOL002 and SOL003 APIs

This repository hosts the [OpenAPI](https://www.openapis.org/) specificatons and other documentation
bernini's avatar
bernini committed
4
for the APIs defined in ETSI NFV GSs SOL002 and SOL003 v3.3.1.
5 6

The APIs described in this repository are defined for the following reference points:
7

8 9 10
* `Or-Vnfm`
* `Ve-vnfm`

bernini's avatar
bernini committed
11
**IMPORTANT: In case of discrepancies the published ETSI Group Specification takes precedence.**
12

13 14
More information at [NFV Solutions wiki](https://nfvwiki.etsi.org/index.php?title=NFV_Solutions).

15 16 17 18
## Content structure

All the main OpenAPI files should be put in the `src` directory and organized with the following schema:

19
    src/deliverable-number/api-name/api-name.yaml
20 21 22
   
e.g.

23
    src/SOL003/LifeCycleManagement/lifeCycleManagement.yaml
24 25 26 27 28 29 30 31
   
   
## Building

The build file `.jenkins.sh` will validate the files, evaluate JSON references and store the generated files in the build directory. In case the build is executed by Jenkins, the merged file will be store in a specific directory to be web-served.

To build locally, once Docker is installed, simple run

32
    $ sudo bash .jenkins.sh
33 34 35
   
and the results will be stored in a `build/` directory in the project folder.

36 37
## How to raise issues

38
Change requests can be filed at [ETSI Forge Bugzilla](forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=62&product=NFV). Please report errors, bugs or other issues [here](https://forge.etsi.org/bugzilla/enter_bug.cgi?product=NFV).
39 40 41

## How to contribute

ETSI CTI's avatar
ETSI CTI committed
42 43
ETSI Forge uses Gitlab to manage submissions to the repository. 
More information is available [here](https://nfvwiki.etsi.org/index.php?title=SOL_OpenAPI_Main_Page#How_to_Contribute).
44 45

### Latest builds
46

47
See the recent builds from:
48

bernini's avatar
bernini committed
49 50
* [Master branch](https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003-master/)
* [Other branches](https://forge.etsi.org/jenkins/job/NFV%20-%20Network%20Functions%20Virtualisation/job/sol002-sol003/).
51 52 53

## License

ETSI CTI's avatar
ETSI CTI committed
54
Copyright (c) ETSI 2020.
55 56 57 58 59 60 61 62 63 64 65 66
 
This software is subject to copyrights owned by ETSI. Non-exclusive permission 
is hereby granted, free of charge, to copy, reproduce and amend this file 
under the following conditions: It is provided "as is", without warranty of any 
kind, expressed or implied. 

ETSI shall never be liable for any claim, damages, or other liability arising 
from its use or inability of use.This permission does not apply to any documentation 
associated with this file for which ETSI keeps all rights reserved. The present 
copyright notice shall be included in all copies of whole or part of this 
file and shall not imply any sub-license right.