README.md

   1 <!--
   2 Licensed under the Apache License, Version 2.0 (the "License");
   3 you may not use this file except in compliance with the License.
   4 You may obtain a copy of the License at
   5
   6    http://www.apache.org/licenses/LICENSE-2.0
   7
   8 Unless required by applicable law or agreed to in writing, software
   9 distributed under the License is distributed on an "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  11 implied.
  12 See the License for the specific language governing permissions and
  13 limitations under the License
  14 -->
  15 # SOL003
  16
  17 This repository contains the NB specification of OSM for ETSI NFV SOL003-based API calls.
  18
  19 ## Getting Started
  20
  21 Install nodeJS and install the following packages using npm:
  22
  23 ```bash
  24 npm install --save @openapi-contrib/json-schema-to-openapi-schema
  25 npm install -g swagger-cli
  26 npm install -g speccy
  27 ```
  28
  29 They will be used to test if your changes are conformant to OpenAPI
  30
  31 Run the following to test your changes:
  32
  33 ```bash
  34 ./devops-stages/stage-test.sh
  35 ```
  36
  37 The script will go through all your OpenAPI files and run `swagger-cli validate` and `speccy lint` over them.
  38
  39 ## Contributing
  40
  41 Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
  42
  43 ## Versioning
  44
  45 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://osm.etsi.org/gitweb/?p=osm/TEMPLATE.git;a=tags).
  46
  47 ## License
  48
  49 This project is licensed under the Apache2 License - see the [LICENSE.md](LICENSE) file for details
  50
  51 ## Acknowledgments
  52
  53 - **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
  54