Commit 7a3abb12 authored by Michele Carignani's avatar Michele Carignani
Browse files

Merge branch '3.3.1-dev' into 'master' 

SOL005 OpenAPI representations for v3.3.1

Closes #2

See merge request nfv/SOL005!15
parents 738b8c84 9fdc14f2

.gitignore

+1 −0
Original line number Diff line number Diff line 
build/

*.pyc

.idea/

Readme.md

+1 −1
Original line number Diff line number Diff line 
# NFV SOL005 APIs



This repository hosts the [OpenAPI](https://www.openapis.org/) specificatons and other documentation

for the APIs defined in ETSI NFV GSs [SOL005](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf).

for the APIs defined in ETSI NFV GSs SOL005 v3.3.1.



The APIs described in this repository are defined for the `Os-Ma-nfvo` reference point.

docker/Dockerfile

+4 −4
Original line number Diff line number Diff line 
# Copyright ETSI 2017

# See: https://forge.etsi.org/etsi-forge-copyright-statement.txt



FROM alpine:3.6

FROM alpine:3.10.0



RUN env

RUN apk update
@@ -16,9 +16,9 @@ RUN gem install rdoc --pre || gem install rdoc --pre 
RUN gem install asciidoctor-pdf-cjk

RUN wget https://forge.etsi.org/swagger2markup-cli-1.3.2.jar

RUN npm config set proxy $http_proxy

RUN npm install -g swagger-tools@0.10.3

RUN npm install -g json-refs@3.0.2

RUN npm install -g yamljs@0.3.0

RUN npm install -g swagger-cli

RUN npm install -g json-refs

RUN npm install -g yamljs



ADD validate-in-docker.sh /validate-in-docker.sh

RUN chmod +x /validate-in-docker.sh

docker/validate-in-docker.sh

+1 −1
Original line number Diff line number Diff line
@@ -32,7 +32,7 @@ function validate_api () { 
  mv "${deliverable}-${api}-API.pdf" "../build/"



  echo "--- Validating ${merged_file}"

  swagger-tools validate "${merged_file}"

  swagger-cli validate "${merged_file}"

  vres=$?

  echo "--- Validation done ($vres)."

src/SOL005/APIVersion/APIVersion.yaml

+26 −37
Original line number Diff line number Diff line 
swagger: "2.0"

openapi: 3.0.2



info:

  version: "1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"

  title: "SOL005 - API version interface"

  description: >

    SOL005 - API version Interface

    IMPORTANT: Please note that this file might be not aligned to the current

    version of the ETSI Group Specification it refers to and has not been

    approved by the ETSI NFV ISG. In case of discrepancies the published ETSI

    Group Specification takes precedence.

    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis

  title: SOL005 - API version interface

  description: |

    SOL005 - API version Interface IMPORTANT: Please note that this file might be not aligned to the current version of

    the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the

    published ETSI Group Specification takes precedence.

    Please report bugs to Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues

  contact:

    name: NFV-SOL WG

  license:

    name: "ETSI Forge copyright notice"

    name: ETSI Forge copyright notice

    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

  contact:

    name: "NFV-SOL WG"

  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1



externalDocs:

  description: ETSI GS NFV-SOL 005 V2.7.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf



schemes:

  - http

  - https



consumes:

  - application/json

  description: ETSI GS NFV-SOL 005 V3.3.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.03.01_60/gs_nfv-sol005v030301p.pdf



produces:

  - application/json

servers:

  - url: http://127.0.0.1/

  - url: https://127.0.0.1/



paths:

  ###############################################################################

  # API Versions                                                                #

  ###############################################################################

  '/nsd/api_versions':

    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

  /nsd/api_versions:

    $ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions



  '/nsfm/api_versions':

    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

  /nsfm/api_versions:

    $ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions



  '/nslcm/api_versions':

    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

  /nslcm/api_versions:

    $ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions



  '/nspm/api_versions':

    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

  /nspm/api_versions:

    $ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions



  '/vnfpkgm/api_versions':

    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
 
 No newline at end of file
 
  /vnfpkgm/api_versions:

    $ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions
 
 No newline at end of file