Skip to content

S
SOL005
Commit cbd289bb authored by ETSI CTI's avatar ETSI CTI
Browse files
Options

Merge branch '2.7.1-dev' into 'master' 

SOL005 OpenAPI representations for v2.7.1

See merge request !14
parents 0d258f2b 8886f39a
Pipeline #3231 passed with stage
    in 0 seconds
    Expand all Hide whitespace changes
    Inline Side-by-side
    Showing with 3686 additions and 1395 deletions
    Readme.md
    View file @ cbd289bb
    # NFV SOL005 APIs
    This repository hosts the [OpenAPI](https://www.openapis.org/) specificatons and other documentation
    for the APIs defined in ETSI NFV GSs [SOL005](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf).
    for the APIs defined in ETSI NFV GSs [SOL005](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf).
    The APIs described in this repository are defined for the `Os-Ma-nfvo` reference point.
    ......
    src/SOL005/APIVersion/APIVersion.yaml
    View file @ cbd289bb
    swagger: "2.0"
    info:
    version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
    version: "1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
    title: "SOL005 - API version interface"
    description: >
    SOL005 - API version Interface
    ......@@ -17,8 +17,8 @@ info:
    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
    description: ETSI GS NFV-SOL 005 V2.7.1
    url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
    schemes:
    - http
    ......@@ -34,17 +34,17 @@ paths:
    ###############################################################################
    # API Versions #
    ###############################################################################
    '/nsd/api-versions':
    '/nsd/api_versions':
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
    '/nsfm/api-versions':
    '/nsfm/api_versions':
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
    '/nslcm/api-versions':
    '/nslcm/api_versions':
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
    '/nspm/api-versions':
    '/nspm/api_versions':
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
    '/vnfpkgm/api-versions':
    '/vnfpkgm/api_versions':
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
    \ No newline at end of file
    src/SOL005/NSDManagement/NSDManagement.yaml
    View file @ cbd289bb
    This diff is collapsed.
    src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml
    View file @ cbd289bb
    ......@@ -91,6 +91,28 @@ definitions:
    type: array
    items:
    $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
    archiveSecurityOption:
    description: >
    Signals the security option used by the NSD archive as defined
    in clause 5.1 of ETSI GS NFV SOL 007.
    Valid values: OPTION_1, OPTION_2
    type: string
    enum:
    - OPTION_1
    - OPTION_2
    signingCertificate:
    description: >
    The singleton signing certificate if it is included as a file in the NSD archive.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
    artifacts:
    description: >
    Information about NSD archive artifacts contained in the NSD archive.
    This attribute shall not be present before the NSD archive content
    is on-boarded. Otherwise, this attribute shall be present if the NSD
    archive contains artifacts.
    type: array
    items:
    $ref: "#/definitions/NsdArchiveArtifactInfo"
    nsdOnboardingState:
    description: >
    On boarding state of the individual NS descriptor resource.
    ......@@ -101,8 +123,8 @@ definitions:
    clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails"
    structure.
    It shall be present when the "nsdOnboardingState"
    attribute is CREATED and the uploading or
    processing fails in NFVO.
    attribute is "ERROR", i.e. the uploading or processing has failed in NFVO,
    unless it has been requested to be excluded via an attribute selector.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
    nsdOperationalState:
    description: >
    ......@@ -200,6 +222,28 @@ definitions:
    manner. This attribute is invariant across versions
    of PNFD.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
    archiveSecurityOption:
    description: >
    Signals the security option used by the PNFD archive as defined
    in clause 5.1 of ETSI GS NFV SOL 004.
    Valid values: OPTION_1, OPTION_2
    type: string
    enum:
    - OPTION_1
    - OPTION_2
    signingCertificate:
    description: >
    The singleton signing certificate if it is included as a file in the PNFD archive.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
    artifacts:
    description: >
    Information about PNFD archive artifacts contained in the PNFD archive.
    This attribute shall not be present before the PNFD archive content is
    on-boarded. Otherwise, this attribute shall be present if the PNFD archive
    contains artifacts.
    type: array
    items:
    $ref: "#/definitions/PnfdArchiveArtifactInfo"
    pnfdOnboardingState:
    description: >
    On-boarding state of the individual PNF descriptor resource.
    ......@@ -209,8 +253,8 @@ definitions:
    Failure details of current on-boarding procedure.
    See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure.
    It shall be present when the
    pnfdOnboardingState attribute is CREATED
    and the uploading or processing fails in the NFVO.
    pnfdOnboardingState attribute is "ERROR", i.e. the uploading or processing has failed
    in the NFVO, unless it has been requested to be excluded via an attribute selector.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
    pnfdUsageState:
    description: >
    ......@@ -455,6 +499,61 @@ definitions:
    items:
    $ref: "#/definitions/PnfdUsageStateType"
    NsdArchiveArtifactInfo:
    type: object
    description: >
    This type represents an artifact contained in an NSD archive.
    It shall comply with provisions defined in Table 5.5.3.5-1.
    required:
    - artifactPath
    - checksum
    properties:
    artifactPath:
    description: >
    Path in the NSD archive, which identifies the artifact and
    also allows to access a copy of the artifact.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
    checksum:
    description: >
    Checksum of the artifact file.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum"
    metadata:
    description: >
    The metadata of the artifact that are available in the NSD Archive,
    such as Content type, size, creation date, etc.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
    PnfdArchiveArtifactInfo:
    type: object
    description: >
    This type represents an artifact contained in a PNFD archive.
    It shall comply with provisions defined in Table 5.5.3.6-1.
    required:
    - artifactPath
    - checksum
    properties:
    artifactPath:
    description: >
    Path in the PNFD archive, which identifies the artifact and
    also allows to access a copy of the artifact.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
    checksum:
    description: >
    Checksum of the artifact file.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum"
    nonManoArtifactSetId:
    description: >
    Non-MANO artifact set identifier of the non-MANO artifact set
    to which the artifact belongs, as defined in clause 4.3.7 of
    ETSI GS NFV-SOL 004. Shall be provided if the artifact is
    a non-MANO artifact, and shall be omitted otherwise.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
    metadata:
    description: >
    The metadata of the artifact that are available in the PNFD Archive,
    such as Content type, size, creation date, etc.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
    NsdOperationalStateType:
    type: string
    description: >
    ......@@ -484,15 +583,17 @@ definitions:
    The enumeration NsdOnboardingStateType shall comply with the provisions
    defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding
    state of the NSD.
    CREATED = The NSD information object is created.
    CREATED = The NSD information object has been created.
    UPLOADING = The associated NSD content is being uploaded.
    PROCESSING = The associated NSD content is being processed, e.g. validation.
    ONBOARDED = The associated NSD content is on-boarded.
    ONBOARDED = The associated NSD content has been on-boarded.
    ERROR = There was an error during upload or processing of the NSD content.
    enum:
    - CREATED
    - UPLOADING
    - PROCESSING
    - ONBOARDED
    - ERROR
    PnfdOnboardingStateType:
    type: string
    ......@@ -500,15 +601,17 @@ definitions:
    The enumeration PnfdOnboardingStateType shall comply with the provisions
    defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the on-boarding state
    of the individual PNF descriptor resource.
    CREATED = The PNF descriptor resource is created.
    CREATED = The PNF descriptor resource has been created.
    UPLOADING = The associated PNFD content is being uploaded.
    PROCESSING = The associated PNFD content is being processed, e.g. validation.
    ONBOARDED = The associated PNFD content is on-boarded.
    ONBOARDED = The associated PNFD content has been on-boarded.
    ERROR = There was an error during upload or processing of the associated PNFD content.
    enum:
    - CREATED
    - UPLOADING
    - PROCESSING
    - ONBOARDING
    - ERROR
    PnfdUsageStateType:
    type: string
    ......
    src/SOL005/NSFaultManagement/NSFaultManagement.yaml
    View file @ cbd289bb
    swagger: "2.0"
    info:
    version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
    version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
    title: "SOL005 - NS Fault Management Interface"
    description: >
    SOL005 - NS Fault Management Interface
    ......@@ -16,8 +16,8 @@ info:
    contact:
    name: "NFV-SOL WG"
    externalDocs:
    description: ETSI GS NFV-SOL 005 V2.6.1
    url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf
    description: ETSI GS NFV-SOL 005 V2.7.1
    url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020701p.pdf
    basePath: /nsfm/v1
    schemes:
    - http
    ......@@ -30,14 +30,14 @@ paths:
    ###############################################################################
    # API Versions #
    ###############################################################################
    '/api-versions':
    '/api_versions':
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
    ###############################################################################
    # Alarms #
    ###############################################################################
    '/alarms':
    #ETSI GS NFV-SOL 005 V2.6.1 location: 8.4.2
    #ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.2
    parameters:
    - name: Authorization
    description: >
    ......@@ -57,7 +57,9 @@ paths:
    description: >
    Get Alarm List.
    The client can use this method to retrieve information about the alarm list.
    The API consumer can use this method to retrieve information about the alarm list.
    This method shall follow the provisions specified in the Tables 8.4.2.3.2-1 and 8.4.2.3.2-2 for URI query parameters,
    request and response data structures, and response codes.
    parameters:
    - name: filter
    in: query
    ......@@ -155,7 +157,7 @@ paths:
    # Individual alarm #
    ###############################################################################
    '/alarms/{alarmId}':
    #ETSI GS NFV-SOL 005 V2.6.1 location: 8.4.3
    #ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.3
    parameters:
    - name: alarmId
    description: >
    ......@@ -183,7 +185,9 @@ paths:
    get:
    summary: Read individual alarm.
    description: >
    The client can use this method to read an individual alarm.
    The API consumer can use this method to read an individual alarm.
    This method shall follow the provisions specified in the Tables 8.4.3.3.2-1 and 8.4.3.3.2-2 for URI query parameters,
    request and response data structures, and response codes.
    parameters:
    - name: Accept
    description: >
    ......@@ -250,6 +254,8 @@ paths:
    Acknowledge Alarm
    This method modifies an individual alarm resource.
    This method shall follow the provisions specified in the Tables 8.4.3.3.2-1 and 8.4.3.3.2-2 for URI query parameters,
    request and response data structures, and response codes.
    parameters:
    - name: body
    in: body
    ......@@ -282,7 +288,7 @@ paths:
    Shall be returned when the request has been accepted and completed.
    The response body shall contain attribute modifications for an 'Individual alarm'
    resource (see clause 8.5.2.4).
    resource (see clause 8.5.2.8).
    headers:
    Content-Type:
    description: The MIME type of the body of the response.
    ......@@ -318,6 +324,20 @@ paths:
    406:
    $ref: "../responses/SOL005_resp.yaml#/responses/406"
    409:
    description: >
    409 CONFLICT
    Shall be returned upon the following 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.
    $ref: "../responses/SOL005_resp.yaml#/responses/409"
    412:
    $ref: "../responses/SOL005_resp.yaml#/responses/412"
    ......@@ -330,7 +350,7 @@ paths:
    #Subscriptions #
    ##############################################################################
    '/subscriptions':
    #ETSI GS NFV-SOL 005 V2.6.1 location: 8.4.4
    #ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.4
    parameters:
    - name: Authorization
    description: >
    ......@@ -424,6 +444,8 @@ paths:
    $ref: "../responses/SOL005_resp.yaml#/responses/405"
    406:
    $ref: "../responses/SOL005_resp.yaml#/responses/406"
    422:
    $ref: "../responses/SOL005_resp.yaml#/responses/422"
    500:
    $ref: "../responses/SOL005_resp.yaml#/responses/500"
    503:
    ......@@ -433,13 +455,10 @@ paths:
    description: >
    Query Subscription Information
    The client can use this method to retrieve the list of active subscriptions
    for alarms related to a NS subscribed by the client.
    It can be used e.g. for resynchronization after error situations.
    This method shall follow the provisions specified in the Tables 8.4.4.3.2-1 and 8.4.4.3.2-2
    for URI query parameters, request and response data structures, and response codes.
    Table 8.4.4.3.2-1: URI query parameters supported.
    The API consumer can use this method to retrieve the list of active subscriptions for alarms related to an NS subscribed
    by the API consumer. It can be used e.g. for resynchronization after error situations.
    This method shall follow the provisions specified in the Tables 8.4.4.3.2-1 and 8.4.4.3.2-2 for URI query parameters,
    request and response data structures, and response codes.
    parameters:
    - name: filter
    in: query
    ......@@ -477,15 +496,23 @@ paths:
    description: >
    200 OK
    The list of subscriptions has been queried successfully.
    The response body shall contain in an array the representations of all active subscriptions of the
    functional block that invokes the method, i.e. zero or more representations of FM subscriptions, as
    Shall be returned when the list of subscriptions has
    been queried successfully.
    The response body shall contain in an array the
    representations of all active subscriptions of the
    functional block that invokes the method, i.e. zero or
    more representations of FM subscriptions, as
    defined in clause 8.5.2.3.
    If the "filter" URI parameter was supplied in the request, the data in the response body shall have
    been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
    If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for
    this resource, inclusion of the Link HTTP header in this response shall follow the provisions in
    clause 5.4.2.3 of ETSI GS NFV SOL 013.
    If the "filter" URI parameter was supplied in the
    request, the data in the response body shall have
    been transformed according to the rules specified in
    clause 5.2.2 of ETSI GS NFV-SOL 013 [16].
    If the NFVO supports alternative 2 (paging)
    according to clause 5.4.2.1 of ETSI
    GS NFV-SOL 013 [16] for this resource, inclusion of
    the Link HTTP header in this response shall follow
    the provisions in clause 5.4.2.3 of ETSI
    GS NFV-SOL 013 [16].
    headers:
    Content-Type:
    description: The MIME type of the body of the response.
    ......@@ -537,7 +564,7 @@ paths:
    # Individual subscription #
    ###############################################################################
    '/subscriptions/{subscriptionId}':
    #ETSI GS NFV-SOL 005 V2.6.1 location: 8.4.5
    #ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.5
    parameters:
    - name: subscriptionId
    description: >
    ......@@ -567,9 +594,10 @@ paths:
    description: >
    Query Subscription Information
    The client can use this method for reading an individual subscription for alarms related to NSs subscribed
    by the client. This method shall follow the provisions specified in the Tables 8.4.5.3.2-1 and 8.4.5.3.2-2
    for URI query parameters, request and response data structures, and response codes
    The API consumer can use this method for reading an individual subscription for alarms related to NSs subscribed by
    the API consumer.
    This method shall follow the provisions specified in the Tables 8.4.5.3.2-1 and 8.4.5.3.2-2 for URI query parameters,
    request and response data structures, and response codes.
    parameters:
    - name: Accept
    description: >
    ......
    src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml
    View file @ cbd289bb
    ......@@ -10,7 +10,6 @@ definitions:
    - id
    - managedObjectId
    - alarmRaisedTime
    - rootCauseFaultyComponent
    - ackState
    - perceivedSeverity
    - eventTime
    ......@@ -35,19 +34,27 @@ definitions:
    description: >
    The virtualised resources that are causing the NS
    fault. It shall be present when the faulty component
    is "NS Virtual Link" or "VNF".
    is "NS Virtual Link" (see clause 8.5.3.4).
    $ref: "#/definitions/FaultyResourceInfo"
    alarmRaisedTime:
    description: >
    Alarm identifier.
    Time stamp indicating when the alarm is raised by the managed object.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
    alarmChangedTime:
    description: >
    The time stamp indicating when the alarm was cleared.
    Time stamp indicating when the alarm was last
    changed. It shall be present if the alarm has been updated.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
    alarmClearedTime:
    description: >
    Links to resources related to this notification.
    Time stamp indicating when the alarm was cleared.
    It shall be present if the alarm has been cleared.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
    alarmAcknowledgedTime:
    description: >
    Time stamp indicating when the alarm was
    acknowledged. It shall be present if the alarm has
    been acknowledged.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
    ackState:
    description: >
    ......@@ -129,9 +136,11 @@ definitions:
    New value of the "ackState" attribute in "Alarm".
    Permitted values:
    - ACKNOWLEDGED
    - UNACKNOWLEDGED
    type: string
    enum:
    - ACKNOWLEDGED
    - UNACKNOWLEDGED
    EventType:
    description: >
    The enumeration EventType represents those types of events that trigger
    ......@@ -268,8 +277,7 @@ definitions:
    callbackUri:
    description: >
    The URI of the endpoint to send the notification to.
    type: string
    format: url
    $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
    _links:
    description: >
    Links for this resource.
    ......@@ -300,8 +308,7 @@ definitions:
    callbackUri:
    description: >
    The URI of the endpoint to send the notification to.
    type: string
    format: url
    $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
    authentication:
    description: >
    Authentication parameters to configure the use of Authorization when sending notifications
    ......
    src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml
    View file @ cbd289bb
    swagger: "2.0"
    info:
    version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
    version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
    title: "SOL005 - NS Fault Management Notification interface"
    description: >
    SOL005 - NS Fault Management Notification interface
    ......@@ -14,8 +14,8 @@ info:
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
    externalDocs:
    description: ETSI GS NFV-SOL 005 V2.6.1
    url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf
    description: ETSI GS NFV-SOL 005 V2.7.1
    url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020701p.pdf
    basePath: /callback/v1
    ......@@ -40,7 +40,7 @@ paths:
    parameters:
    - name: alarmNotification
    description: >
    Information of a NS alarm.
    Information of an NS alarm.
    in: body
    required: true
    schema:
    ......@@ -104,9 +104,73 @@ paths:
    $ref: "../responses/SOL005_resp.yaml#/responses/500"
    503:
    $ref: "../responses/SOL005_resp.yaml#/responses/503"
    get:
    summary: Test the notification endpoint.
    description: >
    The GET method allows the server to test the notification endpoint that is provided by
    the API consumer, e.g. during subscription.
    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: Version
    description: >
    Version of the API requested to use when responding to this request.
    in: header
    required: true
    type: string
    responses:
    204:
    description: >
    204 No Content
    Shall be returned when the notification endpoint has been tested successfully.
    The response body shall be empty.
    headers:
    WWW-Authenticate:
    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
    minimum: 0
    Version:
    description: >
    Version of the API used in the response.
    type: string
    maximum: 1
    minimum: 1
    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/405"
    406:
    $ref: "../responses/SOL005_resp.yaml#/responses/406"
    500:
    $ref: "../responses/SOL005_resp.yaml#/responses/500"
    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.6.1 location: 8.4.6
    #ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.6
    post:
    summary: Notify about NS alarms
    description: >
    ......@@ -114,7 +178,7 @@ paths:
    parameters:
    - name: alarmClearedNotification
    description: >
    Information of the clearance of a NS alarm.
    Information of the clearance of an NS alarm.
    in: body
    required: true
    schema:
    ......@@ -315,12 +379,11 @@ paths:
    $ref: "../responses/SOL005_resp.yaml#/responses/500"
    503:
    $ref: "../responses/SOL005_resp.yaml#/responses/503"
    get:
    summary: Test the notification endpoint.
    description: >
    The GET method allows the server to test the notification endpoint that is provided by
    the client, e.g. during subscription.
    the API consumer, e.g. during subscription.
    parameters:
    - name: Accept
    description: >
    ......
    src/SOL005/NSFaultManagementNotification/definitions/SOL005NSFaultManagementNotification_def.yaml
    View file @ cbd289bb
    ......@@ -3,7 +3,11 @@
    definitions:
    AlarmNotification:
    description: >
    This type represents an alarm notification about NS faults.
    This type represents an alarm notification about NS faults. It shall comply with the provisions defined in
    Table 8.5.2.5-1.
    This notification shall be triggered by the NFVO when:
    • An alarm has been created.
    • An alarm has been updated, e.g. the severity of the alarm has changed.
    type: object
    required:
    - id
    ......@@ -39,31 +43,23 @@ definitions:
    Information about an alarm including AlarmId, affected
    NS identifier, and FaultDetails.
    $ref: "../../NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
    alarmClearedTime:
    description: >
    The time stamp indicating when the alarm was cleared.
    _links:
    description: >
    Links to resources related to this notification.
    type: object
    required:
    - subscription
    - alarm
    properties:
    subscription:
    description: >
    Link to the related subscription.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
    alarm:
    description: >
    Link to the resource that represents the related alarm.
    $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
    AlarmClearedNotification:
    description: >
    This type represents an alarm cleared notification about VNF faults.
    The notification shall be triggered by the VNFM when an alarm has been
    cleared.
    This type represents an alarm cleared notification about NS faults. It shall comply with the provisions defined in
    Table 8.5.2.6-1.
    The notification shall be triggered by the NFVO when an alarm has been cleared.
    type: object
    required:
    - id
    ......@@ -121,11 +117,9 @@ definitions:
    AlarmListRebuiltNotification:
    description: >
    This type represents a notification that the alarm list has been
    rebuilt, e.g. if the VNFM detects its storage holding the alarm
    list is corrupted.
    The notification shall be triggered by the VNFM when the alarm list has
    been rebuilt.
    This type represents a notification that the alarm list has been rebuilt, e.g. if the NFVO detects its storage holding the
    alarm list is corrupted. It shall comply with the provisions defined in Table 8.5.2.7-1.
    The notification shall be triggered by the NFVO when the alarm list has been rebuilt.
    type: object
    required:
    - id
    ......
    src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml
    View file @ cbd289bb
    swagger: "2.0"
    info:
    version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
    version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
    title: "SOL005 - NS Lifecycle Management Notification interface"
    description: >
    SOL005 - NS Lifecycle Management Notification interface
    ......@@ -14,8 +14,8 @@ info:
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
    externalDocs:
    description: ETSI GS NFV-SOL 005 V2.6.1
    url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf
    description: ETSI GS NFV-SOL 005 V2.7.1
    url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
    basePath: /callback/v1
    ......@@ -35,9 +35,10 @@ paths:
    post: