Commit 64f6fb64 authored by Michele Carignani's avatar Michele Carignani
Browse files

Merge branch '2.5.1-dev'

parents 2017f0c4 778626c9
Pipeline #2647 passed with stage
in 0 seconds
swagger: "2.0"
info:
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - API version interface"
description: >
SOL005 - API version Interface
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
contact:
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 005 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
paths:
###############################################################################
# API Versions #
###############################################################################
'/nsd/api-versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
'/nsfm/api-versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
'/nslcm/api-versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
'/nspm/api-versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
'/vnfpkgm/api-versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
\ No newline at end of file
This diff is collapsed.
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
Identifier:
description: >
An identifier with the intention of being globally unique.
type: string
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
String:
description: >
This type represents stack of string values
type: string
Version:
description: >
A Version.
type: string
Uri:
description: >
String formatted according to IETF RFC 3986.
type: string
Link:
description: >
This type represents a link to a resource.
type: object
required:
- href
properties:
href:
description: >
URI of the referenced resource.
type: string
format: url
DateTime:
description: >
Date-time stamp.
Representation: String formatted according to IETF RFC 3339.
type: string
format: "date-time"
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:
- statussss
- 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
\ No newline at end of file
This diff is collapsed.
responses:
409-alarm-state-conflict:
description: >
Conflict
Error: The operation cannot be executed currently, due
to a conflict with the state of the "Individual alarm" resource.
Typically, this is due to the fact that the alarm is already
in the state that is requested to be set (such as trying to
acknowledge an already-acknowledged alarm).
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
type: string
maximum: 1
minimum: 0
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
\ No newline at end of file
swagger: "2.0"
info:
version: "1.0.0"
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NS Fault Management Notification interface"
description: >
SOL005 - NS Fault Management Notification interface
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to. In case of
discrepancies the published ETSI Group Specification takes precedence.
In clause 4.3.2 of ETSI GS NFV-SOL 002 v2.4.1, an attribute-based
filtering mechanism is defined. This mechanism is currently not
included in the corresponding OpenAPI design for this GS version. Changes
to the attribute-based filtering mechanism are being considered in v2.5.1
of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
design.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
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
externalDocs:
description: ETSI GS NFV-SOL 005 V2.4.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
description: ETSI GS NFV-SOL 005 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
basePath: /callback/v1
......@@ -55,9 +44,7 @@ paths:
in: body
required: true
schema:
properties:
AlarmNotification:
$ref: "definitions/SOL005NSFaultManagementNotification_def.yaml#/definitions/AlarmNotification"
$ref: "definitions/SOL005NSFaultManagementNotification_def.yaml#/definitions/AlarmNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
......@@ -108,15 +95,15 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
500:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.6
......@@ -131,9 +118,7 @@ paths:
in: body
required: true
schema:
properties:
AlarmClearedNotification:
$ref: "definitions/SOL005NSFaultManagementNotification_def.yaml#/definitions/AlarmClearedNotification"
$ref: "definitions/SOL005NSFaultManagementNotification_def.yaml#/definitions/AlarmClearedNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
......@@ -170,7 +155,7 @@ paths:
The response body shall be empty.
headers:
WWW-Authenticate:
type: "string"
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
......@@ -184,15 +169,15 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
500:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification':
post:
......@@ -206,9 +191,7 @@ paths:
in: body
required: true
schema:
properties:
AlarmListRebuiltNotification:
$ref: "definitions/SOL005NSFaultManagementNotification_def.yaml#/definitions/AlarmListRebuiltNotification"
$ref: "definitions/SOL005NSFaultManagementNotification_def.yaml#/definitions/AlarmListRebuiltNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
......@@ -259,15 +242,15 @@ paths:
maximum: 1
minimum: 1
400:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
500:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/503"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint
......@@ -312,12 +295,12 @@ paths:
maximum: 1
minimum: 0
400:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
500:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../NSFaultManagement/responses/SOL005_resp.yaml#/responses/503"
\ No newline at end of file
$ref: "../responses/SOL005_resp.yaml#/responses/503"
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment