Skip to content
GitLab
Find file Normal viewHistoryPermalink
NSDManagement.yaml 94.1 KB
Newer Older
moscatelli's avatar
SOL005_6 and SOL005_7: Version added to request and response headers in NSD mgmt interface  
moscatelli committed
2001 2002 2003 
          in: header
          required: true
          type: string
rameshnaraya's avatar
Fixed SOL005 v2.4.1 Review issues.  
rameshnaraya committed
2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 
      responses:
        204:
          description: >
            204 No Content
            
            The notification was delivered successfully.
          headers:
            WWW-Authenticate:
              type: "string"
              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.
              maximum: 1
moscatelli's avatar
SOL005_6 and SOL005_7: Version added to request and response headers in NSD mgmt interface  
moscatelli committed
2018 2019 2020 2021 2022 2023 2024 
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
rameshnaraya's avatar
Fixed SOL005 v2.4.1 Review issues.  
rameshnaraya committed
2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdDeletionNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 
    post:
      summary: Notify about NSD and PNFD changes
      description: >
        This resource represents a notification endpoint. The server can use 
        this resource to send notifications to a subscribed
        client, which has provided the URI of this resource during the subscription process.
        
        The POST method delivers a notification from the server to the client.
        This method shall support the URI query parameters, request and 
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.
      parameters:
        - name: NsdDeletionNotification
          description: >
            A notification about the deletion of an on-boarded NSD.
          in: body
          required: true
          schema:
            properties:
              NsdDeletionNotification:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdDeletionNotification"           
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
moscatelli's avatar
SOL005_6 and SOL005_7: Version added to request and response headers in NSD mgmt interface  
moscatelli committed
2089 2090 2091 2092 2093 2094 2095 
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
rameshnaraya's avatar
Fixed SOL005 v2.4.1 Review issues.  
rameshnaraya committed
2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 
      responses:
        204:
          description: >
            204 No Content
            
            The notification was delivered successfully.
          headers:
            WWW-Authenticate:
              type: "string"
              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.
              maximum: 1
moscatelli's avatar
SOL005_6 and SOL005_7: Version added to request and response headers in NSD mgmt interface  
moscatelli committed
2110 2111 2112 2113 2114 2115 2116 
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
rameshnaraya's avatar
Fixed SOL005 v2.4.1 Review issues.  
rameshnaraya committed
2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  '/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdOnBoardingNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 
    post:
      summary: Notify about NSD and PNFD changes
      description: >
        This resource represents a notification endpoint. The server can use 
        this resource to send notifications to a subscribed
        client, which has provided the URI of this resource during the subscription process.
        
        The POST method delivers a notification from the server to the client.
        This method shall support the URI query parameters, request and 
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.
      parameters:
        - name: PnfdOnBoardingNotification
          description: >
            A notification about the successful on-boarding of a PNFD.
          in: body
          required: true
          schema:
            properties:
              PnfdOnBoardingNotification:          
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdOnBoardingNotification"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
moscatelli's avatar
SOL005_6 and SOL005_7: Version added to request and response headers in NSD mgmt interface  
moscatelli committed
2181 2182 2183 2184 2185 2186 2187 
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
rameshnaraya's avatar
Fixed SOL005 v2.4.1 Review issues.  
rameshnaraya committed
2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 
      responses:
        204:
          description: >
            204 No Content
            
            The notification was delivered successfully.
          headers:
            WWW-Authenticate:
              type: "string"
              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.
              maximum: 1
moscatelli's avatar
SOL005_6 and SOL005_7: Version added to request and response headers in NSD mgmt interface  
moscatelli committed
2202 2203 2204 2205 2206 2207 2208 
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
rameshnaraya's avatar
Fixed SOL005 v2.4.1 Review issues.  
rameshnaraya committed
2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  '/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdOnBoardingFailureNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 
    post:
      summary: Notify about NSD and PNFD changes
      description: >
        This resource represents a notification endpoint. The server can use 
        this resource to send notifications to a subscribed
        client, which has provided the URI of this resource during the subscription process.
        
        The POST method delivers a notification from the server to the client.
        This method shall support the URI query parameters, request and 
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.
      parameters:
        - name: PnfdOnBoardingFailureNotification
          description: >
            A notification about the failure of on-boarding a PNFD.
          in: body
          required: true
          schema:
            properties:
              PnfdOnBoardingFailureNotification:          
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdOnBoardingFailureNotification"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
moscatelli's avatar
SOL005_6 and SOL005_7: Version added to request and response headers in NSD mgmt interface  
moscatelli committed
2273 2274 2275 2276 2277 2278 2279 
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
rameshnaraya's avatar
Fixed SOL005 v2.4.1 Review issues.  
rameshnaraya committed
2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 
      responses:
        204:
          description: >
            204 No Content
            
            The notification was delivered successfully.
          headers:
            WWW-Authenticate:
              type: "string"
              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.
              maximum: 1
moscatelli's avatar
SOL005_6 and SOL005_7: Version added to request and response headers in NSD mgmt interface  
moscatelli committed
2294 2295 2296 2297 2298 2299 2300 
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
rameshnaraya's avatar
Fixed SOL005 v2.4.1 Review issues.  
rameshnaraya committed
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  '/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdDeletionNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10     
    post:
      summary: Notify about NSD and PNFD changes
      description: >
        This resource represents a notification endpoint. The server can use 
        this resource to send notifications to a subscribed
        client, which has provided the URI of this resource during the subscription process.
        
        The POST method delivers a notification from the server to the client.
        This method shall support the URI query parameters, request and 
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.        
      parameters:
        - name: PnfdDeletionNotification
          description: >
            A notification about the deletion of an on-boarded PNFD.
          in: body
          required: true
          schema:
            properties:
              PnfdDeletionNotification:           
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdDeletionNotification"            
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
moscatelli's avatar
SOL005_6 and SOL005_7: Version added to request and response headers in NSD mgmt interface  
moscatelli committed
2365 2366 2367 2368 2369 2370 2371 
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
rameshnaraya's avatar
Fixed SOL005 v2.4.1 Review issues.  
rameshnaraya committed
2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 
      responses:
        204:
          description: >
            204 No Content
            
            The notification was delivered successfully.
          headers:
            WWW-Authenticate:
              type: "string"
              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.
              maximum: 1
moscatelli's avatar
SOL005_6 and SOL005_7: Version added to request and response headers in NSD mgmt interface  
moscatelli committed
2386 2387 2388 2389 2390 2391 2392 
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
rameshnaraya's avatar
Fixed SOL005 v2.4.1 Review issues.  
rameshnaraya committed
2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
          
    get:
      summary: Test the notification endpoint
      description: >
        This resource represents a notification endpoint. The server can use 
        this resource to send notifications to a subscribed
        client, which has provided the URI of this resource during the subscription process.
      
        The GET method allows the server to test the notification endpoint 
        that is provided by the client, e.g. during subscription.
        This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters,
        request and response data structures, and response codes.        
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
moscatelli's avatar
SOL005_6 and SOL005_7: Version added to request and response headers in NSD mgmt interface  
moscatelli committed
2440 2441 2442 2443 2444 2445 
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
rameshnaraya's avatar
Fixed SOL005 v2.4.1 Review issues.  
rameshnaraya committed
2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 
      responses:
        204:
          description: >
            204 No Content
            
            The notification endpoint was tested successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              type: "string"
              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.
              maximum: 1
              minimum: 0
moscatelli's avatar
SOL005_6 and SOL005_7: Version added to request and response headers in NSD mgmt interface  
moscatelli committed
2462 2463 2464 2465 2466 2467 
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
rameshnaraya's avatar
Merge Request Issue. Re committing NSD Files.  
rameshnaraya committed
2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
Show full blame