VirtualisedResourcesQuotaAvailableNotification.yaml 5.18 KB
Newer Older
1
2
3
swagger: "2.0"

info:
4
  version: "1.1.1"
5
6
7
  title: DRAFT - SOL003 - Virtualised Resources Quota Available Notification interface
  description: >
    DRAFT - SOL003 - Virtualised Resources Quota Available Notification interface 
8

9
10
11
12
    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.
13
14
15
16
17
18
19
    
    In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based
    filtering mechanism is defined. This mechanism is currently not
    included in the corresponding OpenAPI design for this GS version. Changes
    to the attribute-based filtering mechanism are being considered in v2.5.1
    of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
    design.
20

21
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
22
23
24
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
25
26
27
28

externalDocs:
  description: ETSI GS NFV-SOL 003 V2.4.1
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.04.01_60/gs_NFV-SOL003v020401p.pdf
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

basePath: "/vrqan/v1"

schemes:
  - https

consumes:
  - "application/json"
produces:
  - "application/json"

paths:
###############################################################################
# Subscriptions                                                               #
###############################################################################
  '/subscriptions':
    post:
      description: >
        The POST method creates a new subscription.
48
49
50
51
52
53
54
55
56
57
        Creation of two subscription resources with the same callbackURI and
        the same filter can result in performance degradation and will provide
        duplicates of notifications to the VNFM, and might make sense only in
        very rare use cases. Consequently, the NFVO may either allow creating
        a subscription resource if another subscription resource with the same
        filter and callbackUri already exists (in which case it shall return
        the “201 Created” response code), or may decide to not create a
        duplicate subscription resource (in which case it shall return a
        “303 See Other” response code referencing the existing subscription
        resource with the same filter and callbackUri).
58
59
60
61
62
63
64
65
66
67
      parameters:
        - name: VrQuotaAvailSubscriptionRequest
          description: Details of the subscription to be created.
          in: body
          required: true
          schema:
            $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscriptionRequest"
      responses:
        201:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
68
69
            Created

70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
            Representation of the created subscription resource.
            The HTTP response shall include a "Location" HTTP header that
            points to the created subscription resource.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
          schema:
            $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription"
85
86
        303:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    get:
      description: >
        The GET method allows the server to test the notification endpoint
        that is provided by the client, e.g. during subscription.
      responses:
        204:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
110
111
            No Content

112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
            The notification endpoint was tested successfully.
            The response body shall be empty.
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"