NFV SpecFest Wiki

Contribute a OAS spec at ETSI Forge!

Create the OAS spec for SOL 002 in a collaborative way.

Set up

1. Log in at forge.etsi.org
2. Go to https://forge.etsi.org/index.php/users/login and insert your EOL credentials
3. Navigate to the example specification and download them
4. nfv-specfest repo
5. Open the given spreadsheet and tag one operation with your name
6. The operation will then be assigned to you to be edited

Editing

With offline editor

1. Install a Rich Editor locally (e.g. VS Code)
2. Navigate to https://code.visualstudio.com/ and download it for your platform
3. Install the Swagger Viewer Plugin

With online editor

1. Navigate to SOL002 OAS template. (Google Chrome recommended)
2. After editing, click File and then “Download YAML”

Writing the definition

Edit the OpenApi specification:

1. Look up the resource you have been assigned in NFV SOL 002
2. Create the definition into the nfv002_main_template.yaml and check correctness with VS Code
3. Cut&paste what you created into a proper resource in /paths/index.yaml and create the corresponding file
4. E.g. create the Vnf_instance data type into a Vnf_instance.yaml files
5. Configure the files so that the CI/CD validates the result

Online via Gerrit (Beginners)

• Upload the contribution via Gerrit ‘Create Change’ button
• Edit the ‘patch set’
• Paste the created files

With Git (Advanced)

1. Log in on forge.etsi.org, set up gerrit configuration
2. Install a GIT client, set it up correctly
3. Upload the contribution

Verify

1. Check Jenkins result on Gerrit and on Jenkins Job
2. If there is no feedback from Jenkins contact CTI
3. Wait for CTI to merge your contribution

Iterate!

All accomplished? Then it may be time to select a new part of the specification and create the OpenAPI version again!