VNFIndicatorNotification.yaml 8.52 KB
Newer Older
1
openapi: 3.0.2
2

3
info:
f.moscatelli's avatar
f.moscatelli committed
4
  title: SOL002 - VNF Indicator Notification interface
5
  description: |
f.moscatelli's avatar
f.moscatelli committed
6 7 8
    SOL002 - VNF Indicator Notification interface

    IMPORTANT: Please note that this file might be not aligned to
9
    the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG.
f.moscatelli's avatar
f.moscatelli committed
10 11
    In case of discrepancies the published ETSI Group Specification takes precedence.

12
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
13 14
  contact:
    name: NFV-SOL WG
15
  license:
16
    name: ETSI Forge copyright notice
17
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
18
  version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
19

20
externalDocs:
21
  description: ETSI GS NFV-SOL 002 V3.3.1
22
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf
23

24 25 26
servers:
  - url: http://127.0.0.1/callback/v1
  - url: https://127.0.0.1/callback/v1
27 28

paths:
29
  '/URI-is-provided-by-the-client-when-creating-the-subscription_VnfIndicatorValueChangeNotification':
30
    parameters:
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
    get:
      summary: Test notification endpoint.
      description: |
        Service Unavailable
        The GET method allows the server to test the notification endpoint that is provided by the client,
        e.g. during subscription.
      responses:
        "204":
          $ref: '#/components/responses/VNFInNotification.Get'
        "400":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
        "401":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
        "403":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
        "405":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
        "406":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
        "500":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
        "503":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503

57 58
    post:
      summary: Notification endpoint
59 60 61 62 63
      description: |
        The API producer can use this resource to send notifications related to VNF indicator value changes to a
        subscribed API consumer, which has provided the URI of this resource during the subscription process.
        The POST method delivers a notification from API producer to an API consumer. The API  consumer shall have
        previously created an "Individual subscription" resource with a  matching filter.
64
      parameters:
65 66 67
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfIndicatorValueChangeNotification'
68
      responses:
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
        "204":
          $ref: '#/components/responses/VNFInNotification.Post'
        "400":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
        "401":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
        "403":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
        "405":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
        "406":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
        "500":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
        "503":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
85

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
  '/URI-is-provided-by-the-client-when-creating-the-subscription_SupportedIndicatorsChangeNotification':
    parameters:
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
    get:
      summary: Test notification endpoint.
      description: |
        Service Unavailable
        The GET method allows the server to test the notification endpoint that is provided by the client,
        e.g. during subscription.
      responses:
        "204":
          $ref: '#/components/responses/VNFInNotification.Get'
        "400":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
        "401":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
        "403":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
        "405":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
        "406":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
        "500":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
        "503":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503

    post:
      summary: Notification endpoint
      description: |
        The API producer can use this resource to send notifications related to VNF indicator value changes to a
        subscribed API consumer, which has provided the URI of this resource during the subscription process.
        The POST method delivers a notification from API producer to an API consumer. The API  consumer shall have
        previously created an "Individual subscription" resource with a  matching filter.
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/SupportedIndicatorsChangeNotification'
      responses:
        "204":
          $ref: '#/components/responses/VNFInNotification.Post'
        "400":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
        "401":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
        "403":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
        "405":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
        "406":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
        "500":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
        "503":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503

143 144 145 146 147 148 149 150 151 152
components:
  requestBodies:
    VnfIndicatorValueChangeNotification:
      description: |
        A notification about VNF indicator value changes.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification
      required: true
153

154 155 156 157 158 159 160 161 162
    SupportedIndicatorsChangeNotification:
      description: |
        A notification about changes of the set of supported indicators.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/SupportedIndicatorsChangeNotification
      required: true

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
  responses:
    VNFInNotification.Get:
      description: |
        201 NO CONTENT
        Shall be returned to indicate the notification endpoint has been  tested successfully. The response body
        shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
      content: {}
186

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
    VNFInNotification.Post:
      description: |
        204 NO CONTENT
        Shall be returned when the notification has been delivered successfully. The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
      content: {}