src/SOL003/components/SOL003_params.yaml

   1 components:
   2   parameters:
   3     Version:
   4       name: Version
   5       description: >
   6         Version of the API requested to use when responding to this request.
   7       in: header
   8       required: true
   9       schema:
  10         type: string
  11
  12     Accept:
  13       name: Accept
  14       description: >
  15         Content-Types that are acceptable for the response. Reference: IETF RFC 7231.
  16       in: header
  17       required: true
  18       schema:
  19         type: string
  20
  21     Authorization:
  22       name: Authorization
  23       description: >
  24         The authorization token for the request. Reference: IETF RFC 7235.
  25       in: header
  26       required: false
  27       schema:
  28         type: string
  29
  30     ContentType:
  31       name: Content-Type
  32       description: |
  33         The MIME type of the body of the request. Reference: IETF RFC 7231
  34       in: header
  35       required: true
  36       schema:
  37         type: string
  38
  39     filter:
  40       name: filter
  41       description: >
  42         Attribute-based filtering expression according to clause 5.2 of ETSI
  43         GS NFV-SOL 013. The VNFM shall support
  44         receiving this parameter as part of the URI query string. The API
  45         consumer may supply this parameter. All attribute names that appear
  46         in the FmSubscription and in data types referenced from it shall be
  47         supported by the NFV-MANO functional entity in the filter
  48         expression.
  49       in: query
  50       required: false
  51       schema:
  52         type: string
  53
  54     all_fields:
  55       name: all_fields
  56       description: >
  57         Include all complex attributes in the response. See clause
  58         5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity
  59         shall support this parameter.
  60       in: query
  61       required: false
  62       schema:
  63         type: string
  64
  65     fields:
  66       name: fields
  67       description: >
  68         Complex attributes to be included into the response. See clause
  69         5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional
  70         entity should support this parameter.
  71       in: query
  72       required: false
  73       schema:
  74         type: string
  75
  76     exclude_fields:
  77       name: exclude_fields
  78       description: >
  79         Complex attributes to be excluded from the response. See clause
  80         5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional
  81         entity should support this parameter.
  82       in: query
  83       required: false
  84       schema:
  85         type: string
  86
  87     exclude_default:
  88       name: exclude_default
  89       in: query
  90       description: >-
  91         Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013
  92         for details. The VNFM shall support this parameter.
  93         The following attributes shall be excluded from the VnfLcmOpOcc structure in the response
  94         body if this parameter is provided, or none of the parameters "all_fields," "fields",
  95         "exclude_fields", "exclude_default" are provided:
  96         -       operationParams
  97         -       error
  98         -       resourceChanges
  99         -       changedInfo
 100         -       changedExtConnectivity
 101         -       lcmCoordinations
 102         -       modificationsTriggeredByVnfPkgChange
 103         -       warnings
 104       required: false
 105       schema:
 106         type: string
 107
 108     nextpage_opaque_marker:
 109       name: nextpage_opaque_marker
 110       description: >
 111         Marker to obtain the next page of a paged response. Shall be supported by
 112         the VNFM if the entity supports alternative 2 (paging)
 113         according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
 114       in: query
 115       required: false
 116       schema:
 117         type: string