Newer
Older
swagger: "2.0"
info:
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to and has not been
approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
license:
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli
committed
contact:
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 005 V2.4.1
moscatelli
committed
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/nspm/v1"
schemes:
- https
consumes:
- "application/json"
produces:
moscatelli
committed
- "application/json"
moscatelli
committed
###############################################################################
# PM Jobs #
###############################################################################
rameshnaraya
committed
'/pm_jobs':
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.2
post:
description: >
The POST method creates a PM job.
This method shall follow the provisions specified in the
Tables 7.4.2.3.1-1 and 7.4.2.3.1-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
parameters:
moscatelli
committed
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
- name: CreatePmJobRequest
in: body
required: true
schema:
type: object
required:
- CreatePmJobRequest
properties:
CreatePmJobRequest:
$ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/CreatePmJobRequest"
description: >
The VNF creation 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
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
rameshnaraya
committed
201:
moscatelli
committed
description: >
moscatelli
committed
The PM job was created successfully.
The response body shall contain a representation of
the created PM job resource, as defined in clause 7.5.2.7.
The HTTP response shall include a "Location" HTTP
header that points to the created PM job resource.
rameshnaraya
committed
schema:
moscatelli
committed
type: object
properties:
PmJob:
$ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmJob"
headers:
Content-Type:
moscatelli
committed
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
WWW-Authenticate:
moscatelli
committed
type: string
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/404"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
get:
moscatelli
committed
description: >
The client can use this method to retrieve information about PM jobs.
rameshnaraya
committed
parameters:
moscatelli
committed
- name: filter
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Attribute-based filtering expression according to clause 4.3.2.
The NFVO shall support receiving this parameter as part of the URI query string.
The OSS/BSS may supply this parameter.
rameshnaraya
committed
All attribute names that appear in the PmJob and in data types referenced from it
shall be supported by the NFVO in the filter expression.
moscatelli
committed
- name: all_fields
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Include all complex attributes in the response. See clause 4.3.3 for details. The
NFVO shall support this parameter.
- name: include
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Complex attributes to be included into the response. See clause 4.3.3 for details. The
NFVO should support this parameter.
- name: exclude
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Complex attributes to be excluded from the response. See clause 4.3.3 for details.
The NFVO should support this parameter.
- name: exclude_default
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Indicates to exclude the following complex attributes from the response.
rameshnaraya
committed
See clause 4.3.3 for details. The NFVO shall support this parameter.
The following attributes shall be excluded from the PmJob structure in the response
body if this parameter is provided, or none of the parameters "all_fields," "fields",
"exclude_fields", "exclude_default" are provided:
moscatelli
committed
reports.
- name: nextpage_opaque_marker
description: >
Marker to obtain the next page of a paged response. Shall be supported by the NFVO
if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
in: query
required: false
type: string
rameshnaraya
committed
- 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
Loading
Loading full blame...