VNFLifecycleManagement.yaml 82.5 KB
Newer Older
Gergely Csatari's avatar
Gergely Csatari committed
2001
2002
2003
              type: string
              maximum: 1
              minimum: 0
2004
2005
2006
2007
2008
2009
2010
          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:
2011
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
2012
2013
2014
2015
2016
2017
2018
2019
        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"
2020
2021
2022
  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
  '/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
2038
2039
2040
        Query Subscription Information


2041
2042
        The GET method retrieves information about a subscription by reading
        an individual subscription resource.
Gergely Csatari's avatar
Gergely Csatari committed
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
      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
2058
2059
2060
2061
2062
2063
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
2064
2065
      responses:
        200:
2066
          description: >
2067
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
2068

2069
2070
2071
2072
2073
2074
2075
2076
2077
            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
2078
2079
2080
2081
2082
2083
2084
2085
            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
2086
2087
2088
2089
2090
2091
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
2092
2093
2094
2095
2096
2097
2098
2099
2100
          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:
2101
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
        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
2112
2113
        Terminate Subscription

2114

2115
        The DELETE method terminates an individual subscription.
Gergely Csatari's avatar
Gergely Csatari committed
2116
2117
2118
2119
2120
2121
2122
2123
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
2124
2125
2126
2127
2128
2129
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
2130
2131
      responses:
        204:
2132
          description: >
2133
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
2134

2135
2136
            The subscription resource was deleted successfully.
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
2137
2138
2139
2140
2141
2142
2143
2144
2145
          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
2146
2147
2148
2149
2150
2151
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
2152
2153
2154
2155
2156
2157
2158
        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:
2159
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
2160
2161
2162
2163
2164
2165
2166
2167
        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