SOL005_def.yaml 14.6 KB
Newer Older
1 2
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
3
definitions:
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
  Identifier:
    description: >
      An identifier with the intention of being globally unique.
    type: string

  IdentifierInNs:
    description: >
      An identifier that is unique with respect to a NS. Representation: string of variable length.
    type: string

  IdentifierInNsd:
    description: >
      An identifier that is unique within a NS descriptor. Representation: string of variable length.
    type: string

  IdentifierInPnf:
    description: >
      An Identifier that is unique within respect to a PNF. Representation: string of variable length.
    type: string

  IdentifierInVim:
    description: >
      An identifier maintained by the VIM or other resource provider.
      It is expected to be unique within the VIM instance. Representation: string of variable length.
    type: string

  DateTime:
    description: >
      Date-time stamp.
      Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.
    format: date-time

  Uri:
    description: >
      String formatted according to IETF RFC 3986.
    type: string
    format: uri

  Boolean:
    description: >
      The Boolean is a data type having two values (TRUE and FALSE).
    type: boolean

  MacAddress:
    description: >
      A MAC address. Representation: string that consists of groups of two hexadecimal digits,
      separated by hyphens or colons.
    type: string

  IpAddress:
    description: >
      An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal
      integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that
      consists of groups of zero to four hexadecimal digits, separated by colons.
    type: string
    format:
      - ipv4
      - ipv6

  IpAddressPrefix:
    description: >
      An IPV4 or IPV6 address range in CIDR format. For IPV4 address range, refer to IETF RFC 4632 [12].
      For IPV6 address range, refer to IETF RFC 4291.
    type: string

  Version:
    description: >
      A Version. Representation: string of variable length.
    type: string

  String:
    description: >
      A string as defined in IETF RFC 8259.
    type: string

  Number:
    description: >
      A number as defined in IETF RFC 8259.
    type: number

  KeyValuePairs:
    description: >
      This type represents a list of key-value pairs. The order of the pairs in the list is not significant.
      In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions
      defined in clause 4 of IETF RFC 7159.
    type: object

  ProblemDetails:
    #SOL005 location: 4.3.5.3-1
    description: >
      The definition of the general "ProblemDetails" data structure from
      IETF RFC 7807 [19] is reproduced in this structure. Compared to the
      general framework defined in IETF RFC 7807 [19], the "status" and
      "detail" attributes are mandated to be included by the present document,
      to ensure that the response contains additional textual information about
      an error. IETF RFC 7807 [19] foresees extensibility of the
      "ProblemDetails" type. It is possible that particular APIs in the present
      document, or particular implementations, define extensions to define
      additional attributes that provide more information about the error.
      The description column only provides some explanation of the meaning to
      Facilitate understanding of the design. For a full description, see
      IETF RFC 7807 [19].
    type: object
    required:
      - status
      - detail
    properties:
      type:
        description: >
          A URI reference according to IETF RFC 3986 [5] that identifies the
          problem type. It is encouraged that the URI provides human-readable
          documentation for the problem (e.g. using HTML) when dereferenced.
          When this member is not present, its value is assumed to be
          "about:blank".
        type: string
        format: URI
      title:
        description: >
          A short, human-readable summary of the problem type. It should not
          change from occurrence to occurrence of the problem, except for
          purposes of localization. If type is given and other than
          "about:blank", this attribute shall also be provided.
          A short, human-readable summary of the problem
          type.  It SHOULD NOT change from occurrence to occurrence of the
          problem, except for purposes of localization (e.g., using
          proactive content negotiation; see [RFC7231], Section 3.4).
        type: string
      status:
        description: >
          The HTTP status code for this occurrence of the problem.
          The HTTP status code ([RFC7231], Section 6) generated by the origin
          server for this occurrence of the problem.
        type: integer
      detail:
        description: >
          A human-readable explanation specific to this occurrence of the
          problem.
        type: string
      instance:
        description: >
          A URI reference that identifies the specific occurrence of the
          problem. It may yield further information if dereferenced.
        type: string
        format: URI

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
  Link:
    description: >
      This type represents a link to a resource.
    type: object
    required:
      - href
    properties:
      href:
        description: >
          URI of a resource referenced from a notification.
          Should be an absolute URI (i.e. a URI that contains {apiRoot}),
          however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted)
          if the {apiRoot} information is not available.
        type: string
        format: url

  NotificationLink:
    description: >
      This type represents a link to a resource in a notification, using an absolute or relative URI.
    type: object
    required:
      - href
    properties:
      href:
        description: >
          URI of a resource referenced from a notification.
          Should be an absolute URI (i.e. a URI that contains {apiRoot}),
          however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted)
          if the {apiRoot} information is not available.
        type: string
179 180
        format: url

181
  NsInstanceSubscriptionFilter:
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
    description: >
      This type represents subscription filter criteria to match NS instances.
    type: object
    properties:
      nsdIds:
        description: >
          If present, match NS instances that were created
          based on a NSD identified by one of the nsdId
          values listed in this attribute.
        type: array
        items:
          $ref: "#/definitions/Identifier"
      vnfdIds:
        description: >
          If present, match NS instances that contain VNF
          instances that were created based on a VNFD
          identified by one of the vnfdId values listed in
          this attribute.
        type: array
        items:
          $ref: "#/definitions/Identifier"
      pnfdIds:
        description: >
          If present, match NS instances that contain
          PNFs that are represented by a PNFD identified
          by one of the pnfdId values listed in this
          attribute.
        type: array
        items:
          $ref: "#/definitions/Identifier"
      nsInstanceIds:
        description: >
          If present, match NS instances with an instance
          identifier listed in this attribute.
        type: array
        items:
          $ref: "#/definitions/Identifier"
      nsInstanceNames:
        description: >
          If present, match NS instances with a NS
          Instance Name listed in this attribute.
        type: array
        items:
          $ref: "#/definitions/String"

227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
  ResourceHandle:
    description: >
      This type represents the information that allows addressing a virtualised resource
      that is used by a VNF instance or by an NS instance. Information about the resource
      is available from the VIM.
    type: object
    required:
      - resourceId
    properties:
      vimId:
        description: >
          Identifier of the VIM under whose control this resource is placed.
          This attribute shall be present if VNF-related resource management
          in direct mode is applicable. It shall also be present for resources
          that are part of an NS instance such as virtual link resources.
        $ref: "#/definitions/Identifier"
      resourceProviderId:
        description: >
          Identifier of the entity responsible for the management of the resource.
          This attribute shall only be supported and present when VNF-related resource
          management in indirect mode is applicable.
          The identification scheme is outside the scope of the present document.
        $ref: "#/definitions/Identifier"
      resourceId:
        description: >
          Identifier of the resource in the scope of the VIM or the resource provider.
        $ref: "#/definitions/IdentifierInVim"
      vimLevelResourceType:
        description: >
          Type of the resource in the scope of the VIM or the resource provider.
          The value set of the "vimLevelResourceType" attribute is within the scope
          of the VIM or the resource provider and can be used as information that
          complements the ResourceHandle.
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
        type: string

  ApiVersionInformation:
    description: >
      This type represents API version information.
    type: object
    required:
      - uriPrefix
      - apiVersions
    properties:
      uriPrefix:
        description: >
          Specifies the URI prefix for the API, in the following form
          {apiRoot}/{apiName}/{apiMajorVersion}/.
        type: string
      apiVersions:
        description: >
          Version(s) supported for the API signalled by the uriPrefix attribute.
        type: array
        items:
          type: object
281 282
          required:
            - version
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
          properties:
            version:
              description: >
                Identifies a supported version. The value of the version attribute shall
                be a version identifier as specified in clause 4.6.1.
              type: string
            isDeprecated:
              description: >
                If such information is available, this attribute indicates whether use of the
                version signaled by the version attribute is deprecated (true) or not (false).
                A deprecated version is still supported by the API producer but is recommended
                not to be used any longer. When a version is no longer supported, it does not
                appear in the response body.
              $ref: "#/definitions/Boolean"
            retirementDate:
              description: >
                The date and time after which the API version will no longer be supported.
                This attribute may be included if the value of the isDeprecated attribute
                is set to true and shall be absent otherwise.
              $ref: "#/definitions/DateTime"
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383

  SubscriptionAuthentication:
    type: object
    required:
      - authType
    properties:
      authType:
        description: >
          Defines the types of Authentication / Authorization which the API
          consumer is willing to accept when receiving a notification.
          Permitted values:
          - BASIC: In every HTTP request to the notification endpoint, use
            HTTP Basic authentication with the client credentials.
          - OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the
            notification endpoint, use an OAuth 2.0 Bearer token, obtained
            using the client credentials grant type.
          - TLS_CERT: Every HTTP request to the notification endpoint is sent
            over a mutually authenticated TLS session, i.e. not only the
            server is authenticated, but also the client is authenticated
            during the TLS tunnel setup.
        type: array
        items:
          type: string
          enum:
            - BASIC
            - OAUTH2_CLIENT_CREDENTIALS
            - TLS_CERT
      paramsBasic:
        description: >
          Parameters for authentication/authorization using BASIC.
          Shall be present if authType is "BASIC" and the contained
          information has not been provisioned out of band.
          Shall be absent otherwise.
        type: object
        properties:
          userName:
            description: >
              Username to be used in HTTP Basic authentication. Shall be
              present if it has not been provisioned out of band.
            type: string
          password:
            description: >
              Password to be used in HTTP Basic authentication. Shall be
              present if it has not been provisioned out of band.
            type: string
      paramsOauth2ClientCredentials:
        description: >
          Parameters for authentication/authorization using
          OAUTH2_CLIENT_CREDENTIALS.
          Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the
          contained information has not been provisioned out of band.
          Shall be absent otherwise.
        type: object
        properties:
          clientId:
            description: >
              Client identifier to be used in the access token request of the
              OAuth 2.0 client credentials grant type.
              Shall be present if it has not been provisioned out of band.
              The clientId and clientPassword passed in a subscription shall
              not be the same as the clientId and clientPassword that are used
              to obtain authorization for API requests. Client credentials may
              differ between subscriptions. The value of clientPassword should
              be generated by a random process.
            type: string
          clientPassword:
            description: >
              Client password to be used in the access token request of the
              OAuth 2.0 client credentials grant type.
              Shall be present if it has not been provisioned out of band.
              The clientId and clientPassword passed in a subscription shall
              not be the same as the clientId and clientPassword that are used
              to obtain authorization for API requests. Client credentials may
              differ between subscriptions. The value of clientPassword should
              be generated by a random process.
            type: string
          tokenEndpoint:
            description: >
              The token endpoint from which the access token can be obtained.
              Shall be present if it has not been provisioned out of band.
            $ref: "#/definitions/Uri"