SOL005_params.yaml 5.83 KB
Newer Older
1
2
3
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
components:
  parameters:
    Version:
      name: Version
      description: >
        Version of the API requested to use when responding to this request.
      in: header
      required: true
      schema:
        type: string

    Accept:
      name: Accept
      description: >
        Content-Types that are acceptable for the response. Reference: IETF RFC 7231.
      in: header
      required: true
      schema:
        type: string

    Authorization:
      name: Authorization
      description: >
        The authorization token for the request. Reference: IETF RFC 7235.
      in: header
      required: false
      schema:
        type: string

    ContentType:
      name: Content-Type
      description: |
        The MIME type of the body of the request. Reference: IETF RFC 7231
      in: header
      required: true
      schema:
        type: string

39
40
41
42
    Range:
      name: Range
      in: header
      description: |
43
        The request may contain a "Range" HTTP header to obtain single range of bytes from the resource file.
44
45
46
47
48
49
50
51
        This can be used to continue an aborted transmission.
        If the NFVO does not support range requests, it should return the whole file with a 200 OK response instead.
      required: false
      style: simple
      explode: false
      schema:
        type: string

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
    filter:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI
        GS NFV-SOL 013. The NFV-MANO functional entity shall support
        receiving this parameter as part of the URI query string. The API
        consumer may supply this parameter. All attribute names that appear
        in the FmSubscription and in data types referenced from it shall be
        supported by the NFV-MANO functional entity in the filter
        expression.
      in: query
      required: false
      schema:
        type: string

    all_fields:
      name: all_fields
      description: >
        Include all complex attributes in the response. See clause
        5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity
        shall support this parameter.
      in: query
      required: false
      schema:
        type: string

    fields:
      name: fields
      description: >
        Complex attributes to be included into the response. See clause
        5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional
        entity should support this parameter.
      in: query
      required: false
      schema:
        type: string

    exclude_fields:
      name: exclude_fields
      description: >
        Complex attributes to be excluded from the response. See clause
        5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional
        entity should support this parameter.
      in: query
      required: false
      schema:
        type: string

    exclude_default:
      name: exclude_default
      in: query
      description: >-
        Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013
        for details. The NFV-MANO functional entity shall support this parameter.
        The NFVO shall support this parameter.

        The following attributes shall be excluded from the NsInstance structure in the response body if this parameter
        is provided, or none of the parameters "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
        -	vnfInstances
        -	pnfInfo
        -	virtualLinkInfo
        -	vnffgInfo
        -	sapInfo
        -	nsScaleStatus
        -	additionalAffinityOrAntiAffinityRules
117
        -   wanConnectionInfo
118
119
120
121
122
123
124
125
126
127
128
129
      required: false
      schema:
        type: string

    nextpage_opaque_marker:
      name: nextpage_opaque_marker
      description: >
        Marker to obtain the next page of a paged response. Shall be supported by
        the NFV-MANO functional entity if the entity supports alternative 2 (paging)
        according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
      in: query
      required: false
130
131
132
      schema:
        type: string

133
134
    include_signatures:
      name: include_signatures
135
136
137
138
139
140
141
142
143
144
145
146
147
148
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
      description: >
        If this parameter is provided, the NFVO shall include in the ZIP archive the security information
        as specified above.
        This URI query parameter is a flag, i.e. it shall have no value. The NFVO shall support this parameter.
      in: query
      required: false
      schema:
        type: string

    exclude_all_mano_artifacts:
      name: exclude_all_mano_artifacts
      in: query
      description: |
        Flag (i.e. parameter without value) that instructs the NFVO to exclude the set of additional MANO artifacts
        (i.e. those that are not images) from the response payload body. The NFVO shall support this parameter.
        The VNFM may supply this parameter.
      required: false
      style: form
      explode: true
      schema:
        type: string

    exclude_all_non_mano_artifacts:
      name: exclude_all_non_mano_artifacts
      in: query
      description: |
        Flag (i.e. parameter without value) that instructs the NFVO to exclude the set of non-MANO artifacts from the
        response payload body. The NFVO shall support this parameter. The VNFM may supply this parameter.
      required: false
      style: form
      explode: true
      schema:
        type: string

    select_non_mano_artifact_sets:
      name: select_non_mano_artifact_sets
      in: query
      description: |
        Comma-separated list of non-MANO artifact set identifiers for which the artifacts are to be included in the
        response body. The NFVO should support this parameter. If the NFVO does not support this parameter, it shall
        ignore it, i.e. provide a response as if no parameter was provided. The VNFM may supply this parameter.
      required: false
      style: form
      explode: true
179
180
      schema:
        type: string