Updated README to remove the template information and add simple instructions

Change-Id: Ie56176144d1a9ff4810a38776a860a82a8fcfe4d
Signed-off-by: garciadeblas <gerardo.garciadeblas@telefonica.com>
1 file changed
tree: 64d2856d8296240f347a017dda781529408f5e11
  1. .gitignore
  2. CONTRIBUTING.md
  3. Dockerfile
  4. Jenkinsfile
  5. LICENSE
  6. README.md
  7. devops-stages/
README.md

SOL003

This repository contains the NB specification of OSM for ETSI NFV SOL003-based API calls.

Getting Started

Install nodeJS and install the following packages using npm:

npm install --save @openapi-contrib/json-schema-to-openapi-schema
npm install -g swagger-cli
npm install -g speccy

They will be used to test if your changes are conformant to OpenAPI

Run the following to test your changes:

./devops-stages/stage-test.sh

The script will go through all your OpenAPI files and run swagger-cli validate and speccy lint over them.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the Apache2 License - see the LICENSE.md file for details

Acknowledgments