Commit b5509559 authored by Muhammad Hamza's avatar Muhammad Hamza
Browse files

Minor fixes

parent 7a7c7ce0
Loading
Loading
Loading
Loading
+39 −39
Original line number Diff line number Diff line
@@ -955,6 +955,8 @@ components:
        This type represents a subscription request related to notifications 
        about NFV-MANO configuration and information management changes. 
      type: object
      required:
        - callbackUri
      properties:
        filter:
          description: >
@@ -975,14 +977,16 @@ components:
            This attribute shall only be present if the subscriber requires 
            authorization of notifications.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"
      required:
        - callbackUri

    CimSubscription:
      description: >
        This type represents a subscription related to notifications about 
        NFV-MANO configuration and information management changes
      type: object
      required:
        - id
        - callbackUri
        - _links
      properties:
        id:
          description: >
@@ -1009,10 +1013,6 @@ components:
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
          required:
            - self
      required:
        - id
        - callbackUri
        - _links

    ChangeStateRequest:
      description: >
@@ -1067,6 +1067,12 @@ components:
      description: >
        This type represents a Change state operation occurrence. 
      type: object
      required:
        - id
        - operationState
        - stateEnteredTime
        - startTime
        - managedObjectRef
      properties:
        id: 
          description: >
@@ -1116,12 +1122,6 @@ components:
            to reading an individual resource, and may be present according to the chosen 
            attribute selector parameter if this data type is returned in a response to 
            a query of a container resource.
      required:
        - id
        - operationState
        - stateEnteredTime
        - startTime
        - managedObjectRef

    ManoServiceInterface:
      description: >
@@ -1604,6 +1604,12 @@ components:
        * NOTE:	A cardinality greater than one supports having different interface versions or api Endpoints
                to be used for accessing the same instance of an NFV-MANO service.
      type: object
      required:
        - id
        - name
        - description
        - manoServiceInterfaceIds
        - _links
      properties:
        id:
          description: >
@@ -1646,12 +1652,6 @@ components:
              minItems: 1
          required:
            - manoServiceInterfaces
      required:
        - id
        - name
        - description
        - manoServiceInterfaceIds
        - _links

    NfvoSpecificInfo:
      description: >
@@ -1661,6 +1661,9 @@ components:
                    of the specification. For instance, "ETSI GS NFV-SOL 001 (V2.5.1)".
          NOTE 2:	If this attribute is not present, the value of this parameter is undefined.
      type: object
      required:
        - supportedVnfdFormats
        - supportedNsdFormats
      properties:
        maxOnboardedNsdNum:
          description: >
@@ -1720,9 +1723,6 @@ components:
          required:
            - nsdFormat
            - standardVersion
      required:
        - supportedVnfdFormats
        - supportedNsdFormats
        
    VnfmSpecificInfo:
      description: >
@@ -1731,6 +1731,10 @@ components:
        * NOTE:	The information to be provided in this attribute shall relate to the specification and version
                of the specification. For instance, "ETSI GS NFV-SOL 001 (V2.5.1)".
      type: object
      required:
        - resoruceMgmtModeSupport
        - managedVnfInstanceInfos
        - supportedVnfdFormats
      properties:
        resoruceMgmtModeSupport:
          description: >
@@ -1782,10 +1786,6 @@ components:
              - vnfdFormat
              - standardVersion
          minItems: 1
      required:
        - resoruceMgmtModeSupport
        - managedVnfInstanceInfos
        - supportedVnfdFormats

    VimSpecificInfo:
      description: >
@@ -1866,6 +1866,10 @@ components:
        This type represents list of parameters that can be configured on the 
        NFV MANO functional entity. 
      type: object
      required:
        - clockSyncs
        - defaultLogCompileBySizeValue
        - defaultLogCompileByTimerValue
      properties:
        clockSyncs:
          description: >
@@ -1886,10 +1890,6 @@ components:
          description: 
            Default value for the log compilation by timer to be used.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
      required:
        - clockSyncs
        - defaultLogCompileBySizeValue
        - defaultLogCompileByTimerValue
        
    ConsumedManoInterfaceInfo:
      description: >
@@ -1905,6 +1905,13 @@ components:
                    modify the value of the security sensitive attribute, and the modification request includes new
                    attribute values, the whole modification request shall be rejected, and proper error information returned.
      type: object
      required:
        - id
        - name
        - type
        - standardVersion
        - apiVersion
        - apiEndpoint
      properties:
        name:
          description: >
@@ -1966,13 +1973,6 @@ components:
            Security related information including credentials information if needed 
            for consuming the API. See note 2.
          $ref: "#/components/schemas/ClientInterfaceSecurityInfo"
      required:
        - id
        - name
        - type
        - standardVersion
        - apiVersion
        - apiEndpoint
        
    CimNotificationsFilter:
      description: >
@@ -2008,6 +2008,8 @@ components:
        This type represents parameters for connecting to an NTP server.
        * NOTE:	Either ipAddress or hostname shall be set, but not both at the same time.
      type: object
      required:
        - type
      properties:
        type:
          description: >
@@ -2038,8 +2040,6 @@ components:
            Information for the other types of clock synchronization. 
            May be present if type = "OTHER".
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
      required:
        - type
        
    ServerInterfaceSecurityInfo:
      description: >
@@ -3056,7 +3056,7 @@ components:
      description: >
        303 SEE OTHER

        SShall be returned when a subscription with the same 
        Shall be returned when a subscription with the same 
        callbackURI and the same filter already exists and the 
        policy of NFV-MANO functional entity is to not create 
        redundant subscriptions.
+20 −20
Original line number Diff line number Diff line
@@ -164,6 +164,15 @@ components:
        configuration and information of the NFV-MANO functional entity
        have been changed.
      type: object
      required:
        - id
        - notificationType
        - subscriptionId
        - timeStamp
        - informationChangedTime
        - manoEntityId
        - changedInfo
        - _links
      properties:
        id:
          description: >
@@ -212,20 +221,21 @@ components:
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
          required:
            - self
      required:
        - id
        - notificationType
        - subscriptionId
        - timeStamp
        - informationChangedTime
        - manoEntityId
        - changedInfo
        - _links

    ChangeStateNotification:
      description: >
        This type represents a Change state operation occurrence.
      type: object
      required:
        - id
        - notificationType
        - subscriptionId
        - timestamp
        - changeStateOpOccId
        - stateChangedTime
        - changeStateOperationState
        - managedObjectRef
        - _links
      properties:
        id:
          description: >
@@ -298,13 +308,3 @@ components:
            - subscription
            - objectInstance
            - changeStateOpOcc
 No newline at end of file
      required:
        - id
        - notificationType
        - subscriptionId
        - timestamp
        - changeStateOpOccId
        - stateChangedTime
        - changeStateOperationState
        - managedObjectRef
        - _links
 No newline at end of file
+1 −1
Original line number Diff line number Diff line
@@ -576,7 +576,7 @@ components:
      description: >
        303 SEE OTHER

        SShall be returned when a subscription with the same
        Shall be returned when a subscription with the same
        callbackURI and the same filter already exists and the
        policy of NFV-MANO functional entity is to not create
        redundant subscriptions.
+55 −21
Original line number Diff line number Diff line
@@ -238,8 +238,8 @@ paths:
      requestBody:
        $ref: "#/components/requestBodies/CompileLogRequest"
      responses:
        "200":
          $ref: '#/components/responses/LogReportCompiled.Post.200'
        "201":
          $ref: '#/components/responses/LogReportCompiled.Post.201'
        "202":
          $ref: '#/components/responses/LogReportCompiled.Post.202'
        "303":
@@ -472,7 +472,9 @@ components:

  responses:
    Subscription.Delete.204:
      description: >-
      description: >
        204 NO CONTENT

        Shall be returned when the "Individual subscription" resource has been deleted successfully.
        The response body shall be empty.
      headers:
@@ -494,7 +496,9 @@ components:
            type: string

    Subscription.Get.200:
      description: >-
      description: >
        200 OK

        Shall be returned when the subscription has been read successfully.
        The response body shall contain a representation of the "Individual subscription" resource,
        as defined in clause 8.6.2.3.
@@ -521,7 +525,9 @@ components:
            $ref: "#/components/schemas/LogmSubscription"

    Subscriptions.Get.200:
      description: >-
      description: >
        200 OK

        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 log management
@@ -556,7 +562,9 @@ components:
              $ref: "#/components/schemas/LogmSubscription"

    Subscriptions.Post.201:
      description: >-
      description: >
        201 CREATED

        Shall be returned when the subscription has been created successfully.
        A representation of the created "Individual subscription" resource shall be returned in the response body,
        as defined in clause 8.6.2.3.
@@ -590,7 +598,9 @@ components:
            $ref: "#/components/schemas/LogmSubscription"

    Subscriptions.Post.303:
      description: >-
      description: >
        303 SEE OTHER

        Shall be returned when a subscription with the same callbackURI and the same filter already exists and the
        policy of the NFV-MANO functional entity is to not create redundant subscriptions.
        The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing
@@ -619,8 +629,10 @@ components:
          schema:
            type: string

    LogReportCompiled.Post.200:
      description: >-
    LogReportCompiled.Post.201:
      description: >
        201 CREATED

        Shall be returned for a successful compilation of the log data and creation of the associated log report
        (synchronous mode).
        The response body shall contain a representation of the log report resource, as defined in clause 8.6.2.7.
@@ -655,7 +667,7 @@ components:

    subscriptions.post.422:
      description: >
        422 Unprocessable Entity
        422 UNPROCESSABLE ENTITY

        Shall be returned upon the following error: The content type
        of the payload body is supported and the payload body of a request
@@ -690,7 +702,9 @@ components:
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"

    LogReportCompiled.Post.202:
      description: >-
      description: >
        202 ACCEPTED

        Shall be returned when the request has been accepted for processing, and it is expected to take some
        time to compile the log file and create the associated log report (asynchronous mode).
        The response body shall be empty.
@@ -721,7 +735,9 @@ components:
            type: string

    LogReportCompiled.Post.303:
      description: >-
      description: >
        303 SEE OTHER

        Shall be returned when a log data compilation and report creation is already ongoing, or a log report has just been
        created, for the specified logging job at the time of processing the request.
        The response body shall be empty.
@@ -752,7 +768,9 @@ components:
            type: string

    LogReportCompiled.Post.422:
      description: >-
      description: >
        422 UNPROCESSABLE ENTITY

        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
        including rules for the presence of the response body.
        Specifically, in case of this task resource, the response code 422 shall also be returned if the
@@ -783,7 +801,9 @@ components:
            $ref: '../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails'

    LogReport.Get.200:
      description: >-
      description: >
        200 OK

        Shall be returned when information of an individual log report has been read successfully.
        The response body shall contain a representation of the "Individual log report" resource, as
        defined in clause 8.6.2.7.
@@ -810,7 +830,9 @@ components:
            $ref: "#/components/schemas/LogReport"

    LogReport.Get.202:
      description: >-
      description: >
        202 ACCEPTED

        Shall be returned if the creation of the log report is ongoing and no log report is available yet
        (applicable in asynchronous mode of the "Compile log task" resource).
        The response body shall be empty.
@@ -833,7 +855,9 @@ components:
            type: string

    IndividualLoggingJob.Get.200:
      description: >-
      description: >
        200 OK

        Shall be returned when information about an individual logging job has been read successfully.
        The response body shall contain a representation of the "Individual logging job" resource,
        as defined in clause 8.6.2.6.
@@ -860,7 +884,9 @@ components:
            $ref: "#/components/schemas/LoggingJob"

    IndividualLoggingJob.Delete.204:
      description: >-
      description: >
        204 NO CONTENT

        Shall be returned when the logging job has been deleted successfully.
        The response body shall be empty.
      headers:
@@ -878,7 +904,9 @@ components:
            type: string

    LoggingJobs.Post.201:
      description: >-
      description: >
        201 CREATED

        The response body contains the Application Context as it was created
        by the MEC system
      headers:
@@ -904,7 +932,9 @@ components:
            $ref: "#/components/schemas/LoggingJob"

    LoggingJobs.Get.200:
      description: >-
      description: >
        200 OK

        Shall be returned when information about zero or more logging jobs has been queried successfully.

        The response body shall contain in an array the representations of zero or more logging jobs, as
@@ -943,7 +973,9 @@ components:
              $ref: "#/components/schemas/LoggingJob"

    LogReportAvailableNotification.Post.204:
      description: >-
      description: >
        204 NO CONTENT
        
        Shall be returned when the notification has been delivered successfully.
      headers:
        Content-Type:
@@ -964,7 +996,9 @@ components:
            type: string

    LogReportAvailableNotification.Get.204:
      description: >-
      description: >
        204 NO CONTENT

        Shall be returned to indicate that the notification endpoint has been tested successfully.
        The response body shall be empty.
      headers:
+35 −35
Original line number Diff line number Diff line
@@ -245,7 +245,7 @@ paths:
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
      requestBody:
        $ref: "#/components/requestBodies/CreateThesholdRequest"
        $ref: "#/components/requestBodies/CreateThresholdRequest"
      responses:
        "201": 
          $ref: "#/components/responses/Thresholds.Post.201"
@@ -408,6 +408,11 @@ components:
      description: >
        This type represents a request to create a PM job. 
      type: object
      required:
        - objectType
        - objectInstanceIds
        - criteria
        - callbackUri
      properties:
        objectType:
          description: >
@@ -457,16 +462,18 @@ components:
            This attribute shall only be present if the subscriber requires
            authorization of notifications.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"
      required:
        - objectType
        - objectInstanceIds
        - criteria
        - callbackUri

    PmJob:
      description: >
        This type represents a PM job. 
      type: object
      required:
        - id
        - objectType
        - objectInstanceIds
        - criteria
        - _links
        - callbackUri
      properties:
        id:
          description: >
@@ -554,18 +561,16 @@ components:
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
          required:
            - self
      required:
        - id
        - objectType
        - objectInstanceIds
        - criteria
        - _links
        - callbackUri

    CreateThresholdRequest :
      description: >
        This type represents a request to create a threshold. 
      type: object
      required:
        - objectType
        - objectInstanceId
        - criteria
        - callbackUri
      properties:
        objectType:
          description: >
@@ -608,16 +613,19 @@ components:
            This attribute shall only be present if the subscriber requires
            authorization of notifications.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"

    Threshold:
      description: >
        This type represents a threshold.
      type: object
      required:
        - id
        - objectType
        - objectInstanceId
        - subjObjectInstanceIds
        - criteria
        - _links
        - callbackUri

    Threshold:
      description: >

      type: object
      properties:
        id:
          description: >
@@ -672,14 +680,6 @@ components:
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
          required:
            - self
      required:
        - id
        - objectType
        - objectInstanceId
        - subjObjectInstanceIds
        - criteria
        - _links
        - callbackUri
    
    PerformanceReport:
      description: >
@@ -687,6 +687,8 @@ components:
        entity to the API consumer as a result of collecting performance information as part 
        of a PM job. 
      type: object
      required:
        - entries
      properties:
        entries: 
          description: >
@@ -750,8 +752,6 @@ components:
              - performanceMetric
              - performanceValues
          minItems: 1
      required:
        - entries

    PmJobModifications:
      description: >
@@ -803,6 +803,9 @@ components:
        * NOTE 2:	In particular when choosing short collection and reporting periods, the number of PM jobs that can
                    be supported depends on the capability of the producing entity.
      type: object
      required:
        - collectionPeriod
        - reportingPeriod
      properties:
        performanceMetric: 
          description: >
@@ -840,9 +843,6 @@ components:
            The boundary shall allow a single reporting as well as periodic reporting up to 
            the boundary.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
      required:
        - collectionPeriod
        - reportingPeriod

    ThresholdCriteria:
      description: >
@@ -853,6 +853,9 @@ components:
                    When processing a request to create a threshold, implementations should enforce a suitable minimum
                    value for this attribute (e.g. override the value or reject the request).
      type: object
      required:
        - performanceMetric
        - thresholdType
      properties:
        performanceMetric:
          description: >
@@ -898,9 +901,6 @@ components:
          required: 
            - thresholdValue
            - hysteresis
      required:
        - performanceMetric
        - thresholdType

    #----------------
    # common types to SOL009
@@ -1584,7 +1584,7 @@ components:
            $ref: "#/components/schemas/CreatePmJobRequest"
      required: true

    CreateThesholdRequest:
    CreateThresholdRequest:
      description: >
        Request parameters to create a threshold. 
      content:
Loading