Commit 8ee37475 authored by Sana Zulfiqar's avatar Sana Zulfiqar
Browse files

Added Notes in descriptions & data type references

parent fcb77db5

src/SOL009/NFVManoFaultManagement/NFVManoFaultManagement.yaml

+15 −56
Original line number Diff line number Diff line
@@ -12,8 +12,8 @@ info: 
    name: ETSI Forge copyright notice

    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

externalDocs:

  description: ETSI GS NFV-SOL 009 V3.3.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf

  description: ETSI GS NFV-SOL 009 V3.5.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf



servers:

  - url: http://127.0.0.1/nfvmanofm/v1
@@ -26,10 +26,7 @@ paths: 
  /alarms:

    get:

      description: >

        Get Alarm List. The client can use this method to retrieve information

        about the alarm list. This method shall follow the provisions specified

        in the tables 7.5.3.3.2-1 and 7.5.3.3.2-2 for URI query parameters,

        request and response data structures, and response codes.

        The client can use this method to retrieve information about the alarm list. See clause 7.5.3.3.2.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -64,10 +61,7 @@ paths: 
      - $ref: "#/components/parameters/alarmId"

    get:

      description: >

        The client can use this method to read an individual alarm. This method

        shall follow the provisions specified in the tables 7.5.4.3.2-1 and

        7.5.4.3.2-2 for URI query parameters, request and response data

        structures, and response codes.

        The client can use this method to read an individual alarm. See clause 7.5.4.3.2.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -97,10 +91,7 @@ paths: 
          $ref: ../components/SOL009_resp.yaml#/components/responses/504

    patch:

      description: >

        This method modifies an "Individual alarm" resource. This method shall

        follow the provisions specified in the tables 7.5.4.3.4-1 and

        7.5.4.3.4-2 for URI query parameters, request and response data

        structures, and response codes.

        This method modifies an "Individual alarm" resource. See clause 7.5.4.3.4.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -138,24 +129,7 @@ paths: 
  /subscriptions:

    post:

      description: >

        Subscribe. The POST method creates a new subscription. This method shall

        follow the provisions specified in the tables 7.5.5.3.1-1 and

        7.5.5.3.1-2 for URI query parameters, request and response data

        structures, and response codes. As the result of successfully executing

        this method, a new "Individual subscription" resource as defined in

        clause 7.5.6 shall have been created. This method shall not trigger any

        notification. Creation of two "Individual subscription" resources with

        the same callbackURI and the same filter can result in performance

        degradation and will provide duplicates of notifications to the API

        consumer, and might make sense only in very rare use cases.

        Consequently, the NFV-MANO functional entity may either allow creating a

        new "Individual subscription" resource if another "Individual

        subscription" resource with the same filter and callbackUri already

        exists (in which case it shall return the "201 Created" response code),

        or may decide to not create a duplicate "Individual subscription"

        resource (in which case it shall return a "303 See Other" response code

        referencing the existing "Individual subscription" resource with the

        same filter and callbackUri).

        The POST method creates a new subscription. See clause 7.5.5.3.1.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -190,12 +164,9 @@ paths: 
          $ref: ../components/SOL009_resp.yaml#/components/responses/504

    get:

      description: >

        Query Subscription Information



        The client can use this method to retrieve the list of active subscriptions for NFV-MANO functional entity

        alarms 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 7.5.5.3.2-1 and 7.5.5.3.2-2 for URI query parameters,

        request and response data structures, and response codes.

        alarms subscribed by the client. It can be used e.g. for resynchronization after error situations.

        See clause 7.5.5.3.2.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -230,11 +201,8 @@ paths: 
      - $ref: "#/components/parameters/subscriptionId"

    get:

      description: >

        Query Subscription Information. The client can use this method for

        reading an individual subscription for NFV-MANO functional entity alarms

        subscribed by the client. This method shall follow the provisions

        specified in the tables 7.5.6.3.2-1 and 7.5.6.3.2-2 for URI query

        parameters, request and response data structures, and response codes.

        The client can use this method for reading an individual subscription for NFV-MANO functional entity alarms

        subscribed by the client. See clause 7.5.6.3.2.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
@@ -264,16 +232,7 @@ paths: 
          $ref: ../components/SOL009_resp.yaml#/components/responses/504

    delete:

      description: >

        Terminate Subscription. This method terminates an individual

        subscription. This method shall follow the provisions specified in the

        tables 7.5.6.3.5-1 and 7.5.6.3.5-2 for URI query parameters, request and

        response data structures, and response codes. As the result of

        successfully executing this method, the "Individual subscription"

        resource shall not exist any longer. This means that no notifications

        for that subscription shall be sent to the formerly-subscribed API

        consumer. NOTE:	Due to race conditions, some notifications might still

        be received by the formerly-subscribed API consumer for a certain time

        period after the deletion.

        This method terminates an individual subscription. See clause 7.5.6.3.5.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
@@ -417,7 +376,8 @@ components: 
        structure, the following applies: All attributes shall match in order for the filter to match (logical "and"

        between different filter attributes). If an attribute is an array, the attribute shall match if at least one

        of the values in the array matches (logical "or" between the values of one filter attribute).



        * NOTE:	The permitted values of the "notificationTypes" attribute are spelled exactly as the names

                of the notification types to facilitate automated code generation systems.

      type: object

      properties:

        notificationTypes:
@@ -427,9 +387,8 @@ components: 
            * AlarmNotification

            * AlarmClearedNotification

            * AlarmListRebuiltNotification

            The permitted values of the "notificationTypes" attribute are

            spelled exactly as the names of the notification types to

            facilitate automated code generation systems.



            See note.

          type: array

          items:

            type: string

src/SOL009/NFVManoFaultManagementNotification/NFVManoFaultManagementNotification.yaml

+9 −27
Original line number Diff line number Diff line 
openapi: 3.0.2

info:

  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

  version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

  title: SOL009 - NFV-MANO Fault Management Notification Operation

  description: >

    SOL009 - NFV-MANO Fault Management Notification Operation
@@ -12,8 +12,8 @@ info: 
    name: ETSI Forge copyright notice

    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

externalDocs:

  description: ETSI GS NFV-SOL 009 V3.3.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf

  description: ETSI GS NFV-SOL 009 V3.5.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf



security:

  - OauthSecurity:
@@ -29,10 +29,7 @@ paths: 
      description: >

        The POST method notifies an NFV-MANO functional entity alarm or that the

        alarm list has been rebuilt. The API consumer shall have previously

        created an "Individual subscription" resource with a matching filter.

        This method shall follow the provisions specified in the tables

        7.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and

        response data structures, and response codes.

        created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
@@ -59,10 +56,7 @@ paths: 
    get:

      description: >

        The GET method allows the server to test the notification endpoint that

        is provided by the client, e.g. during subscription. This method shall

        follow the provisions specified in the tables 7.5.7.3.2-1 and

        7.5.7.3.2-2 for URI query parameters, request and response data

        structures, and response codes.

        is provided by the client, e.g. during subscription. See clause 7.5.7.3.2.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
@@ -88,10 +82,7 @@ paths: 
      description: >

        The POST method notifies an NFV-MANO functional entity alarm or that the

        alarm list has been rebuilt. The API consumer shall have previously

        created an "Individual subscription" resource with a matching filter.

        This method shall follow the provisions specified in the tables

        7.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and

        response data structures, and response codes.

        created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
@@ -118,10 +109,7 @@ paths: 
    get:

      description: >

        The GET method allows the server to test the notification endpoint that

        is provided by the client, e.g. during subscription. This method shall

        follow the provisions specified in the tables 7.5.7.3.2-1 and

        7.5.7.3.2-2 for URI query parameters, request and response data

        structures, and response codes.

        is provided by the client, e.g. during subscription. See clause 7.5.7.3.2.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
@@ -147,10 +135,7 @@ paths: 
      description: >

        The POST method notifies an NFV-MANO functional entity alarm or that the

        alarm list has been rebuilt. The API consumer shall have previously

        created an "Individual subscription" resource with a matching filter.

        This method shall follow the provisions specified in the tables

        7.5.7.3.1-1 and 7.5.7.3.1-2 for URI query parameters, request and

        response data structures, and response codes.

        created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
@@ -177,10 +162,7 @@ paths: 
    get:

      description: >

        The GET method allows the server to test the notification endpoint that

        is provided by the client, e.g. during subscription. This method shall

        follow the provisions specified in the tables 7.5.7.3.2-1 and

        7.5.7.3.2-2 for URI query parameters, request and response data

        structures, and response codes.

        is provided by the client, e.g. during subscription. See clause 7.5.7.3.2.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"

src/SOL009/NFVManoLogManagement/NFVManoLogManagement.yaml

+55 −69

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL009/NFVManoLogManagementNotification/NFVManoLogManagementNotification.yaml

+4 −8
Original line number Diff line number Diff line 
openapi: 3.0.2

info:

  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

  version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

  title: SOL009 - NFV-MANO Log Management Notification Operation

  description: >

    SOL009 - NFV-MANO Log Management Notification Operation
@@ -14,7 +14,7 @@ info: 
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

externalDocs:

  description: ETSI GS NFV-SOL 009 V3.3.1

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf

  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf



security:

  - OauthSecurity:
@@ -35,9 +35,7 @@ paths: 
      description: >-

        The POST method delivers a notification regarding a log management event from the API producer to the API

        consumer. The API consumer shall have previously created an "Individual subscription" resource with a

        matching filter.

        This method shall follow the provisions specified in the tables 8.5.9.3.1-1 and 8.5.9.3.1-2 for URI query

        parameters, request and response data structures, and response codes.

        matching filter. See clause 8.5.9.3.1.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
@@ -70,9 +68,7 @@ paths: 
    get:

      description: >-

        The GET method allows the API producer to test the notification endpoint that is provided by the API

        consumer, e.g. during subscription.

        This method shall follow the provisions specified in the tables 8.5.9.3.2-1 and 8.5.9.3.2-2 for URI

        query parameters, request and response data structures, and response codes.

        consumer, e.g. during subscription. See clause 8.5.9.3.2.

      parameters:

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"

        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"

src/SOL009/NFVManoPerformanceManagement/NFVManoPerformanceManagement.yaml

+34 −67

File changed.

Preview size limit exceeded, changes collapsed.