NSDManagement.yaml 92.7 KB
Newer Older
2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 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 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 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 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 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 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          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
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    PnfdArchiveManifest.Get.200:
      description: |
        Shall be returned when the content of the manifest file has been
        read successfully.
        If the "include_signatures" URI query parameter was absent in the
        request, or if the manifest file has all security-related information
        embedded (i.e. there is no separate certificate file), the payload
        body shall contain a copy of the manifest file of the PNFD archive,
        and the "Content-Type" HTTP header shall be set to "text/plain".
        If the "include_signatures" URI query parameter was present in the
        related request and the manifest file does not have all the
        security-related information embedded (i.e. there is a separate certificate file),
        the "Content-Type" HTTP header shall be set to "application/zip" and
        the payload body shall contain a ZIP archive which includes:
        -	a copy of the manifest file of the PNFD archive;
        -	a copy of the related individual certificate file.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
            enum:
              - text/plain
              - application/zip
        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
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    IndividualPnfdArchiveArtifact.Get.200:
      description: |
        200 OK

        Shall be returned when the content of the artifact file has been read successfully.
                  
        If the "include_signatures" request URI parameter was not provided in the related request, 
        the payload body shall contain a copy of the artifact file from the PNFD archive, as defined 
        by ETSI GS NFV-SOL 004, and the "Content-Type" HTTP header shall be set according to the 
        content type of the artifact file. If the artifact is encrypted, the header shall be set to 
        the value "application/cms" (IETF RFC 7193). 
        
        If the content type cannot be determined, the header shall be set to the value 
        "application/octetstream". If the "include_signatures" request URI parameter was provided 
        in the related request, the "Content-Type" HTTP header shall be set to "application/zip"
        and the payload body shall contain a ZIP archive which includes:
        - a copy of the artifact file from the VNF package, as defined by ETSI GS NFVSOL 004
        - the related security information (individual signature file and optional related individual 
        certificate file).
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          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
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    IndividualPnfdArchiveArtifact.Get.206:
      description: |
        206 PARTIAL CONTENT

        If the NFVO supports range requests and the "include_signatures" request URI parameter was
        not present in the related request, this response shall be returned when a single consecutive 
        byte range from the content of the artifact file has been read successfully according to the 
        request.

        The response body shall contain the requested part of the artifact file from the PNFD archive, 
        as defined by ETSI GS NFV-SOL 004. 
        
        The "Content-Type" HTTP header shall be set according to the content type of the artifact file. 
        If the content type cannot be determined, the header shall be set to the value 
        "application/octet-stream".
        
        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          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
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    Subscriptions.Post.201:
      description: |
        201 CREATED

        Shall be returned when the subscription has been created successfully.
        A representation of the created "Individual subscription" resource shall
        be returned in the response body, as defined in clause 5.5.2.8.
        The HTTP response shall include a "Location:" HTTP header that points
        to the created "Individual subscription" resource.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          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
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"

    Subscriptions.Get.200:
      description: |
        200 OK

        Shall be returned when the list of subscriptions has been queried successfully.
        The response body shall contain in an array the representations of all active
        subscriptions of the functional block that invokes the method, i.e. zero or more
        representations of NSD management subscriptions as defined in clause 5.5.2.8.
        If the "filter" URI parameter was supplied in the request, the data in the
        response body shall have been transformed according to the rules specified in
        clause 5.2.2 of ETSI GS NFV-SOL 013.
        If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
        ETSI GS NFV SOL 013 for this resource, inclusion of the Link HTTP header in this
        response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV SOL 013.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          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
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            description: |
              The list of subscriptions was queried successfully.
              The response body shall contain in an array the representations of all active subscriptions
              of the functional block that invokes the method, i.e., zero or more representations of NSD management
              subscriptions as defined in clause 5.5.2.8.
              If the NFVO 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.
            type: array
            items:
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"

    IndividualSubscription.Get.200:
      description: |
        200 OK

        Shall be returned when information about an individual subscription has been read successfully.
        The response body shall contain a representation of the subscription resource.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          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
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"

    IndividualSubscription.Delete.204:
      description: |
        204 NO CONTENT

        Shall be returned when the "Individual subscription" resource
        has been deleted successfully.
        The response body shall be empty.
      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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string