VNFLifecycleManagement.yaml 86.8 KB
Newer Older
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
            All attribute names that appear in the LccnSubscription and in 
            data types referenced from it shall be supported by the VNFM 
            in the filter expression.
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be 
            supported by the VNFM if the VNFM supports alternative 2 (paging) 
            according to clause 4.7.2.1 for this resource.
          in: query
          required: false
          type: string
2015
2016
2017
2018
2019
2020
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
2021
2022
      responses:
        200:
2023
          description: >
2024
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
2025

2026
            The list of subscriptions was queried successfully. The response
2027
2028
2029
2030
2031
2032
2033
2034
            body shall contain the in an array representations of all active 
            subscriptions of the functional block that invokes the method, 
            i.e. zero or more representations of lifecycle change notification
            subscriptions as defined in clause 5.5.2.16.
            If the VNFM supports alternative 2 (paging) according to 
            clause 4.7.2.1 for this resource, inclusion of the Link 
            HTTP header in this response shall follow the provisions 
            in clause 4.7.2.3.
2035
2036
2037
2038
2039
2040
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
2041
2042
2043
2044
2045
2046
2047
2048
            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.
              type: string
              maximum: 1
              minimum: 0
2049
2050
2051
2052
2053
2054
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
2055
2056
2057
2058
2059
2060
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
2061
2062
2063
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription"
        400:
2064
          description: >
Gergely Csatari's avatar
Gergely Csatari committed
2065
2066
            Bad Request

2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
            Invalid attribute-based filtering parameters.
            The response body shall contain a ProblemDetails structure, in
            which the "detail" attribute should convey more information about
            the error.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
2077
2078
2079
2080
2081
2082
2083
2084
            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.
              type: string
              maximum: 1
              minimum: 0
2085
2086
2087
2088
2089
2090
2091
          schema:
            $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
2092
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
2093
2094
2095
2096
2097
2098
2099
2100
        405:
          $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"
2101
2102
2103
  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
  '/subscriptions/{subscriptionId}':
    #SOL003 location: 5.4.19
    parameters:
      - name: subscriptionId
        description: >
          Identifier of this subscription.
          This identifier can be retrieved from the resource referenced by
          the "Location" HTTP header in the response to a POST request
          creating a new subscription resource. It can also be retrieved from
          the "id" attribute in the payload body of that response.
        in: path
        type: string
        required: true
    get:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
2119
2120
2121
        Query Subscription Information


2122
2123
        The GET method retrieves information about a subscription by reading
        an individual subscription resource.
Gergely Csatari's avatar
Gergely Csatari committed
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
      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
2139
2140
2141
2142
2143
2144
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
2145
2146
      responses:
        200:
2147
          description: >
2148
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
2149

2150
2151
2152
2153
2154
2155
2156
2157
2158
            The operation has completed successfully.
            The response body shall contain a representation of the
            subscription resource.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
2159
2160
2161
2162
2163
2164
2165
2166
            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.
              type: string
              maximum: 1
              minimum: 0
2167
2168
2169
2170
2171
2172
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
2173
2174
2175
2176
2177
2178
2179
2180
2181
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription"
        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:
2182
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
        405:
          $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"
    delete:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
2193
2194
        Terminate Subscription

2195

2196
        The DELETE method terminates an individual subscription.
Gergely Csatari's avatar
Gergely Csatari committed
2197
2198
2199
2200
2201
2202
2203
2204
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
2205
2206
2207
2208
2209
2210
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
2211
2212
      responses:
        204:
2213
          description: >
2214
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
2215

2216
2217
            The subscription resource was deleted successfully.
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
2218
2219
2220
2221
2222
2223
2224
2225
2226
          headers:
            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.
              type: string
              maximum: 1
              minimum: 0
2227
2228
2229
2230
2231
2232
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
2233
2234
2235
2236
2237
2238
2239
        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:
2240
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
2241
2242
2243
2244
2245
2246
2247
2248
        405:
          $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"
For faster browsing, not all history is shown. View entire blame