Update OpenAPI files to version v020201

Automatically generated OpenAPI files from specification version v020201

Merge request reports

Loading
+1359 −1685
Changes for MEC029_FAI.yaml: 1359 added lines, 1685 removed lines.
Original line number Diff line number Diff line
openapi: 3.1.0
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
info:
  title: "ETSI GS MEC 029 Fixed Access Information API"
  version: 2.2.1
  description: "ETSI GS MEC 029 Fixed Access Information API described using OpenAPI."
  license:
    name: BSD-3-Clause
    url: "https://forge.etsi.org/legal-matters"
  contact:
    name: ETSI Forge
    email: cti_support@etsi.org
    url: https://forge.etsi.org/rep/mec/gs029-fai-api
externalDocs:
  description: "ETSI GS MEC 029 Fixed Access Information API, v2.2.1"
  url: "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/029/02.02.01_60/gs_mec029v020201p.pdf"
  title: ETSI GS MEC 029 Fixed Access Information API
  description: The ETSI MEC ISG Fixed Access Information API described using OpenAPI.
  license:
    name: BSD-3-Clause
    url: https://forge.etsi.org/legal-matters
  version: 2.2.1
servers:
  - url: "https://localhost/fai/v1"
tags:
  - name: Queries
    description: "APIs for Device and fa_info"
  - name: Subscription
    description: "Subscription API"
  - name: "Cable line info"
    description: "Cable line info API"
  - name: "Optical network info"
    description: "Optican network Info API"
- url: https://localhost/fai/v1
paths:
  /queries/fa_info:
    get:
      summary: Retrieve current status of the FAI.
      description: The GET method is used to query information about the available fixed access networks.
      operationId: QueriesFainfoGET
      tags:
        - "Queries"
      summary: "Retrieve information on the available fixed access networks."
      description: "Retrieve information on the available fixed access networks."
      operationId: fa_infoGET
      - queries
      parameters:
        - in: query
          name: customerPremisesInfo
          schema:
            type: array
            items:
              $ref: "#/components/schemas/CpInfo"
          required: false
          description: "Comma separated list of customer premises information"
        - in: query
          name: lastMileTech
          schema:
            type: array
            items:
              type: integer
          required: false
          description: "Comma separated list of last mile technologies."
        - in: query
          name: interfaceType
          schema:
            type: array
            items:
              type: integer
          description: "Comma separated list of interface types."
        - in: query
          name: dsbw
          schema:
            type: array
            items:
              type: integer
          required: false
          description: "Comma separated list of the bandwidth (in Mbps) from the network towards the customer site."
        - in: query
          name: usbw
          schema:
            type: array
            items:
              type: integer
          required: false
          description: "Comma separated list of the bandwidth (in Mbps) from the customer site towards the network."
        - in: query
          name: latency
          schema:
            type: array
            items:
              type: integer
          required: false
          description: "Comma separated list of the maximum baseline latency (in ms) between customer site and service edge node."
      - $ref: '#/components/parameters/Query.Customerpremisesinfo'
      - $ref: '#/components/parameters/Query.Lastmiletech'
      - $ref: '#/components/parameters/Query.Interfacetype'
      - $ref: '#/components/parameters/Query.Dsbw'
      - $ref: '#/components/parameters/Query.Usbw'
      - $ref: '#/components/parameters/Query.Latency'
      responses:
        "200":
          description: "A response body containing the FAI is returned. "
        '200':
          description: Upon success, a response body containing the information of zero or more fix access networks is returned.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/FaInfo"
        "400":
          $ref: "#/components/responses/400"
        "401":
          $ref: "#/components/responses/401"
        "403":
          $ref: "#/components/responses/403"

                  $ref: '#/components/schemas/FaInfo'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
  /queries/device_info:
    get:
      summary: Retrieve current status of the device information.
      description: The GET method is used to query information about the devices that are connected to a fixed access network.
      operationId: QueriesDeviceinfoGET
      tags:
        - "Queries"
      summary: "retrieve information on the devices that are connected to a fixed access network."
      description: "retrieve information on the devices that are connected to a fixed access network."
      operationId: device_infoGET
      - queries
      parameters:
        - in: query
          name: gwId
          schema:
            type: array
            items:
              type: string
          required: false
          description: "Comma separated list of gateway identifier"
        - in: query
          name: deviceId
          schema:
            type: array
            items:
              type: string
          required: false
          description: "Comma separated list of device identifier."
        - in: query
          name: deviceStatus
          schema:
            type: array
            items:
              type: integer
          description: "Comma separated list of device status."

      - $ref: '#/components/parameters/Query.Gwid'
      - $ref: '#/components/parameters/Query.Deviceid'
      - $ref: '#/components/parameters/Query.Devicestatus'
      responses:
        "200":
          description: "Upon success, a response body containing the information of zero or more devices is returned."
        '200':
          description: Upon success, a response body containing the information of zero or more devices is returned.
          content:
            application/json:
              schema:
                type: array
                items:
                 $ref: "#/components/schemas/DeviceInfo"
        "400":
          $ref: "#/components/responses/400"
        "401":
          $ref: "#/components/responses/401"
        "403":
          $ref: "#/components/responses/403"
        "404":
          $ref: "#/components/responses/404"
        "406":
          $ref: "#/components/responses/406"
        "429":
          $ref: "#/components/responses/429"

                  $ref: '#/components/schemas/DeviceInfo'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
  /queries/cable_line_info:
    get:
      summary: Retrieve current status of the cable line information.
      description: The GET method is used to query information about the cable line of a fixed access network.
      operationId: QueriesCablelineinfoGET
      tags:
        - "Cable line info"
      summary: "It Queries information about the cable line of a fixed access network."
      description: "It Queries information about the cable line of a fixed access network."
      operationId: cable_line_infoGET
      - queries
      - cable_line_info
      parameters:
        - in: query
          name: customerPremisesInfo
          schema:
            type: array
            items:
              $ref: "#/components/schemas/CpInfo"
          required: false
          description: "Comma separated list of customer premises information"
        - in: query
          name: cmId
          schema:
            type: array
            items:
              type: string
          required: false
          description: "Comma separated list of Cable Modem identifiers."

      - $ref: '#/components/parameters/Query.Customerpremisesinfo1'
      - $ref: '#/components/parameters/Query.Cmid'
      responses:
        "200":
          description: "Upon success, a response body containing the information of zero or more cable lines is returned."
        '200':
          description: Upon success, a response body containing the information of zero or more cable lines is returned.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CableLineInfo"
        "400":
          $ref: "#/components/responses/400"
        "401":
          $ref: "#/components/responses/401"
        "403":
          $ref: "#/components/responses/403"
        "404":
          $ref: "#/components/responses/404"
        "406":
          $ref: "#/components/responses/406"
        "429":
          $ref: "#/components/responses/429"
                type: array
                items:
                  $ref: '#/components/schemas/CableLineInfo'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
  /queries/optical_network_info:
    get:
      summary: Retrieve current status of the optical network information.
      description: The GET method is used to query information about the optical network.
      operationId: QueriesOpticalnetworkinfoGET
      tags:
        - "Optical network info"
      summary: "used to query information about the optical network."
      description: "used to query information about the optical network."
      operationId: optical_network_infoGET
      - queries
      - optical_network_info
      parameters:
        - in: query
          name: customerPremisesInfo
          schema:
            type: array
            items:
              $ref: "#/components/schemas/CpInfo"
          required: false
          description: "Comma separated list of customer premises information"
        - in: query
          name: ponYS_ID
          schema:
            type: array
            items:
              type: string
          required: false
          description: "Comma separated list of optical system identifiers."
        - in: query
          name: onuId
          schema:
            type: array
            items:
              type: string
          required: false
          description: "Comma separated list of optical network unit identifiers."

      - $ref: '#/components/parameters/Query.Customerpremisesinfo2'
      - $ref: '#/components/parameters/Query.Ponys_id'
      - $ref: '#/components/parameters/Query.Onuid'
      responses:
        "200":
          description: "Upon success, a response body containing the information of zero or more optical networks is returned"
        '200':
          description: Upon success, a response body containing the information of zero or more optical networks is returned.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/PonInfo"
        "400":
          $ref: "#/components/responses/400"
        "401":
          $ref: "#/components/responses/401"
        "403":
          $ref: "#/components/responses/403"
        "404":
          $ref: "#/components/responses/404"
        "406":
          $ref: "#/components/responses/406"
        "429":
          $ref: "#/components/responses/429"

                  $ref: '#/components/schemas/PonInfo'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
  /subscriptions:
    get:
      summary: Retrieve a list of active subscriptions for this subscriber.
      description: The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor.
      operationId: SubscriptionsGET
      tags:
        - "Subscription"
      summary: "request information about the subscriptions for this requestor."
      description: "request information about the subscriptions for this requestor."
      operationId: subGET
      - subscriptions
      parameters:
        - in: query
          name: subscription_type
          schema:
            type: string
          required: false

          description: "Query parameter to filter on a specific subscription type. Permitted values onu_alarm Optical Network Unit alarm  device_abnormal_alert Device abnormal alert - cm_connectivity_state Cable Modem connectivity state - ani_alarm Access Node Interface alarm"
      - $ref: '#/components/parameters/Query.Subscription_type'
      responses:
        "200":
          description: "A response body containing the list of links to requestor subscriptions is returned."
        '200':
          description: Upon success, a response body containing the list of links to requestor's subscriptions is returned. The list shall only contain subscriptions of the subscription type specified by the URI query parameters.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SubscriptionLinkList"
        "400":
          $ref: "#/components/responses/400"
        "401":
          $ref: "#/components/responses/401"
        "403":
          $ref: "#/components/responses/403"
        "404":
          $ref: "#/components/responses/404"
        "406":
          $ref: "#/components/responses/406"
        "429":
          $ref: "#/components/responses/429"
                type: object
                properties:
                  SubscriptionLinkList:
                    $ref: '#/components/schemas/SubscriptionLinkList'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
    post:
      summary: Create a new subscription.
      description: The POST method is used to create a new subscription to FAI notifications. Upon success, the response contains entity body describing the created subscription.
      operationId: SubscriptionsPOST
      tags:
        - "Subscription"
      summary: " create a new subscription to FAI notifications."
      description: " create a new subscription to FAI notifications."
      operationId: subPOST
      - subscriptions
      requestBody:
        required: true
        description: 'The entity body in the request contains data type of the specific FAI event subscription that is to be created, where the data type options are listed below:

          OnuAlarmSubscription.

          DevInfoSubscription.

          CmConnSubscription.

          AniAlarmSubscription.'
        content:
          application/json:
            schema:
              oneOf:
                - $ref: "#/components/schemas/OnuAlarmSubscription"
                - $ref: "#/components/schemas/DevInfoSubscription"
                - $ref: "#/components/schemas/CmConnSubscription"
                - $ref: "#/components/schemas/AniAlarmSubscription"

              type: object
              properties:
                OnuAlarmSubscription:
                  $ref: '#/components/schemas/OnuAlarmSubscription'
      responses:
        "201":
          description: "In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type."
        '201':
          description: 'Indicates successful resource creation, where the resource URI shall be returned in the HTTP Location header field.


            In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type from the list below:

            OnuAlarmSubscription.

            DevInfoSubscription.

            CmConnSubscription.

            AniAlarmSubscription.'
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: "#/components/schemas/OnuAlarmSubscription"
                  - $ref: "#/components/schemas/DevInfoSubscription"
                  - $ref: "#/components/schemas/CmConnSubscription"
                  - $ref: "#/components/schemas/AniAlarmSubscription"
        "400":
          $ref: "#/components/responses/400"
        "401":
          $ref: "#/components/responses/401"
        "403":
          $ref: "#/components/responses/403"
        "404":
          $ref: "#/components/responses/404"
        "406":
          $ref: "#/components/responses/406"
        "415":
          $ref: "#/components/responses/415"
        "422":
          $ref: "#/components/responses/422"
        "429":
          $ref: "#/components/responses/429"

                type: object
                properties:
                  OnuAlarmSubscription:
                    $ref: '#/components/schemas/OnuAlarmSubscription'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
      callbacks:
        notification:
          "{$request.body#/callbackReference}":
          '{$request.body#/callbackUri}':
            post:
              summary: "Callback POST used to send a notification"
              description: "A notification from FAIS."
              operationId: notificationPOST
              summary: Callback POST used to send a notification
              description: Subscription notification
              operationId: notificationPOST710301
              requestBody:
                description: Subscription notification
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      properties:
                        subscriptionNotification:
                          oneOf:
                        - $ref: "#/components/schemas/OnuAlarmNotification"
                        - $ref: "#/components/schemas/DevInfoNotification"
                        - $ref: "#/components/schemas/CmConnNotification"
                        - $ref: "#/components/schemas/AniAlarmNotification"
                          - $ref: '#/components/schemas/OnuAlarmSubscription'
                          - $ref: '#/components/schemas/DevInfoSubscription'
                          - $ref: '#/components/schemas/CmConnSubscription'
                          - $ref: '#/components/schemas/AniAlarmSubscription'
              responses:
                "204":
                  $ref: "#/components/responses/204"
                "400":
                  $ref: "#/components/responses/400"

                '204':
                  description: No content
                '404':
                  description: Not found
      parameters: []
  /subscriptions/{subscriptionId}:
    parameters:
      - in: path
        name: subscriptionId
        description: "Refers to created subscription, where the FAI API allocates a unique resource name for this subscription"
        schema:
          type: string
        required: true

    get:
      summary: Retrieve information on current specific subscription.
      description: The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription.
      operationId: SubscriptionsGETSubscriptionid
      tags:
        - "Subscription"
      summary: "Retrieve information about this subscription."
      description: "Retrieve information about this subscription."
      operationId: individualSubscriptionGET

      - subscriptions
      responses:
        "200":
          description: "A response body containing data type describing the specific FAI event subscription is returned"
        '200':
          description: 'Upon success, a response body containing data type describing the specific FAI event subscription is returned. The allowed data types for subscriptions are as follows:

            OnuAlarmSubscription.

            DevInfoSubscription.

            CmConnSubscription.

            AniAlarmSubscription.'
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: "#/components/schemas/OnuAlarmSubscription"
                  - $ref: "#/components/schemas/DevInfoSubscription"
                  - $ref: "#/components/schemas/CmConnSubscription"
                  - $ref: "#/components/schemas/AniAlarmSubscription"
        "400":
          $ref: "#/components/responses/400"
        "401":
          $ref: "#/components/responses/401"
        "403":
          $ref: "#/components/responses/403"
        "404":
          $ref: "#/components/responses/404"
        "406":
          $ref: "#/components/responses/406"
        "429":
          $ref: "#/components/responses/429"

                type: object
                properties:
                  OnuAlarmSubscription:
                    $ref: '#/components/schemas/OnuAlarmSubscription'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
      parameters:
      - name: subscriptionId
        in: path
        required: true
        description: The unique identifier of the subscriptionId.
        schema:
          type: string
    put:
      summary: Modify existing subscription by sending a new data structure.
      description: The PUT method is used to update the existing subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request.
      operationId: SubscriptionsPUTSubscriptionid
      tags:
        - "Subscription"
      summary: "Used to update the existing subscription."
      description: "Used to update the existing subscription."
      operationId: individualSubscriptionPUT
      requestBody:
      - subscriptions
      parameters:
      - name: subscriptionId
        in: path
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: "#/components/schemas/OnuAlarmSubscription"
                - $ref: "#/components/schemas/DevInfoSubscription"
                - $ref: "#/components/schemas/CmConnSubscription"
                - $ref: "#/components/schemas/AniAlarmSubscription"
      responses:
        "200":
          description: "A response body containing data type describing the updated subscription is returned"
          content:
            application/json:
        description: The unique identifier of the subscriptionId.
        schema:
                oneOf:
                  - $ref: "#/components/schemas/OnuAlarmSubscription"
                  - $ref: "#/components/schemas/DevInfoSubscription"
                  - $ref: "#/components/schemas/CmConnSubscription"
                  - $ref: "#/components/schemas/AniAlarmSubscription"
        "400":
          $ref: "#/components/responses/400"
        "401":
          $ref: "#/components/responses/401"

        "403":
          $ref: "#/components/responses/403"

        "404":
          $ref: "#/components/responses/404"

        "406":
          $ref: "#/components/responses/406"

        "412":
          $ref: "#/components/responses/412"

        "422":
          $ref: "#/components/responses/422"

        "429":
          $ref: "#/components/responses/429"
          type: string
    delete:
      summary: Cancel the existing subscription.
      description: The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription.
      operationId: SubscriptionsDELETESubscriptionid
      tags:
        - "Subscription"
      summary: "Used to cancel the existing subscription."
      description: "Used to cancel the existing subscription."
      operationId: individualSubscriptionDELETE
      - subscriptions
      responses:
        "204":
          $ref: "#/components/responses/204"
        "401":
          $ref: "#/components/responses/401"
        "403":
          $ref: "#/components/responses/403"
        "404":
          $ref: "#/components/responses/404"
        "429":
          $ref: "#/components/responses/429"

        '204':
          $ref: '#/components/responses/204'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
      parameters:
      - name: subscriptionId
        in: path
        required: true
        description: The unique identifier of the subscriptionId.
        schema:
          type: string
components:
  schemas:
    AniAlarmNotification.alarm:
      description: "Indicates the alarm of the ANI: 0 = LowReceivedOpticalPower. 1 = HighReceivedOpticalPower. 2 = SignalFailure. 3 = SignalDegrade. 4 = LowTransmitOpticalPower.5 = HighTransmitOpticalPower.6 = LaserBiasCurrent."
    LinkType:
      x-etsi-ref: 6.5.8
      type: object
      properties:
        href:
          description: URI referring to a resource
          type: string
          format: uri
      required:
      - href
    Href:
      description: The URI referring to the subscription.
      type: string
      format: uri
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
        title:
          type: string
          description: A short, human-readable summary of the problem type
        status:
          type: integer
          format: uint32
          description: The HTTP status code for this occurrence of the problem
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem
        instance:
          type: string
          format: uri
          description: A URI reference that identifies the specific occurrence of the problem
    FaInfo:
      x-etsi-ref: 6.2.2
      type: object
      properties:
        timeStamp:
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
        customerPremisesInfo:
          description: The physical location of a customer site.
          $ref: '#/components/schemas/CpInfo'
        lastMileTech:
          type: integer
          enum:
        - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
          - 7
          - 8
          description: 'An informative field identifying the last mile access technology used.

    AniAlarmNotification.aniId:
      properties:
        onuId:
          description: The unique identifiers for the optical network unit.
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        aniIndex:
          description: The index of an access network interface supported by the optical network unit.
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
      required:
        - onuId
        - aniIndex
            The valid values are:

    AniAlarmNotification:
      properties:
        alarm:
          $ref: "#/components/schemas/AniAlarmNotification.alarm"
        aniId:
          $ref: "#/components/schemas/AniAlarmNotification.aniId"
            1 = ADSL.

        customerPremisesInfo:
          description: The physical location of the related customer sites.
          items:
            $ref: "#/components/schemas/CpInfo"
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: CpInfo
        notificationType:
          description: Shall be set to "AniAlarmNotification".
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        onuId:
          type: string
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
      required:
        - notificationType
        - aniIndex
        - alarm
      type: object
      x-etsi-ref: 6.4.6
            2 = VDSL.

    AniAlarmSubscription.filterCriteriaAniAlarm.alarms:
      description: "In case alarms is not included in the subscription request, the default value -1 = All shall be used and included in the response:\n0  =\tLowReceivedOpticalPower.\n(Received downstream optical power below threshold.)\n1  =\tHighReceivedOpticalPower.\n\t(Received downstream optical power above threshold.)\n2  =\tSignalFalure.\n(Bit error-based signal fail.)\n3  =\tSignalDegrade.\n(Bit error-based signal degrade.)\n4  =\tLowTransmitOpticalPower.\n(Transmit optical power below lower threshold.)\n5  =\tHighTransmitOpticalPower.\n(Transmit optical power above upper threshold.)\n6  =\tLaserBiasCurrent.\n(Laser bias current above threshold determined by vendor.)\n-1 =\tAll."
            3 = GPON.

            4 = XGPON.

            5 = NGPON2.

            6 = XGSPON.

            7 = GFAST.

            8 = P2PEthernet.'
        interfaceType:
          type: integer
          enum:
        - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        - -1
      type: integer
          - 7
          - 8
          - 9
          - 10
          description: 'The physical interface used for the end customer site:

    AniAlarmSubscription.links:
      properties:
        self:
          # description': Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LinkType
          $ref: "#/components/schemas/LinkType"
      required:
        - self
            1   =   100BASE-TX.

    AniAlarmSubscription.filterCriteriaAniAlarm:
      description: "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response."
      required:
        - onuId
        - aniId
      properties:
        customerPremisesInfo:
          required:
            - onuId
            - aniId
          description: 0 to N physical locations of the customer sites.
          type: array
          items:
            $ref: "#/components/schemas/CpInfo"
            2   =   1000BASE-TX.

          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: CpInfo
        onuId:
          description: "1 to N unique identifiers for the optical network units.  Typical it is the unique serial number for each ONU, which contains the vendor ID and version number. The first four bytes are an ASCII-encoded four-letter vendor ID. The second four bytes are a binary encoded serial number, under the control of the ONU vendor."
          type: array
          items:
            type: string
            x-etsi-mec-cardinality: "1..N"
            x-etsi-mec-origin-type: String
            3   =   1000BASE-LX.

        aniId:
          description: ""
          type: object
            4   =   1000BASELX10.

            5   =   1000BASEBX10.

            6   =   1000BASE-LH.

            7   =   1000Base-ZX.

            8   =   ADSL-RJ11.

            9   =   VDSL-RJ11.

            10 =   GPON.'
        dsbw:
          description: The bandwidth (in Mbps) from the network towards the customer site.
          type: integer
        usbw:
          description: The bandwidth (in Mbps) from the customer site towards the network.
          type: integer
        latency:
          description: Maximum baseline latency (in ms) between customer site and service edge node.
          type: integer
      required:
            - onuId
            - aniIndex
      - customerPremisesInfo
      - lastMileTech
      - interfaceType
    DeviceInfo:
      x-etsi-ref: 6.2.3
      type: object
      properties:
            onuId:
              description: "The unique identifiers for the optical network unit"
              type: string
            aniIndex:
              description: "The index of an access network interface supported by the optical network unit"
              type: string
        alarms:
          type: array
          items:
            $ref: "#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm.alarms"
        timeStamp:
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
        gwId:
          description: 'Information (typically the serial number) to identify an Internet Gateway Device through which the customer premises device is connected.

    AniAlarmSubscription:
      properties:
        subscriptionType:
          description: 'Shall be set to \"AniAlarmSubscription\"'
          type: string
        _links:
          $ref: "#/components/schemas/AniAlarmSubscription.links"
        aniIndex:
          description: The index of an access network interface supported by the optical network unit.
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.
          format: uri

            This value shall remain fixed over the lifetime of the device, including across firmware updates.'
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: URI
        requestTestNotification:
          description: Shall be set to TRUE by the service consumer to request
          type: boolean      
        websockNotifConfig:
          description: Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.
          $ref: "#/components/schemas/WebsockNotifConfig" 
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        filterCriteriaAniAlarm:
          $ref: "#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm"
      required:
        - subscriptionType
        - callbackReference
        - filterCriteriaAniAlarm
        - onuId
        - aniIndex
      type: object
      x-etsi-ref: 6.3.6
        deviceId:
          description: 'Typically, the serial number of the device.


    CableLineInfo.cmStatus:
      description: "It provides CM connectivity status information of the CM."
      type: object
      required:
        - ifIndex
        - cmRegState
        - resets
        - lostSyncs
        - invalidRegRsps
        - energyMgt1x1OperStatus
        - emDlsOperStatus
      properties:
        ifIndex:
          description: "It denotes the MAC Domain interface index of the CM."
            This value shall remain fixed over the lifetime of the device, including across firmware updates.'
          type: string
        cmRegState:
        deviceStatus:
          type: integer
          description: "It indicates the CM connectivity state. Enumeration of:  1 = notReady. 2 = notSynchronized. 3 = phySynchronized. 4 = dsTopologyResolutionInProgress.5 = usParametersAcquired. 6 = rangingInProgress.7 = rangingComplete. 8 = eaeInProgress.9 = dhcpv4InProgress. 10 = dhcpv6InProgress.11 = dhcpV4Complete.12 = dhcpV6Complete.13 = todEstablished.14 = securityEstablished.15 = configFileDownloadComplete.16 = registrationInProgress.17 = registrationComplete. 18 = accessDenied. 19 =operational. 20 = bpiInit.21 =forwardingDisabled. 22 = rangingInProgress. 23 = rfMuteAll."
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
          - 9
          - 10
          - 11
          - 12
          - 13
          - 14
          - 15
          - 16
          - 17
          - 18
          - 19
          - 20
          - 21
          - 22
          - 23   
        resets:
          description: "It denotes the number of times the CM reset or initialized this interface."
          type: integer
        lostSyncs:
          description: "It denotes the number of times the CM lost synchronization with the downstream channel."
          type: integer
        invalidRegRsps:
          description: "It denotes the number of times the CM received invalid registration response messages."
          type: integer
        energyMgt1x1OperStatus:
          description: "It indicates whether the CM is currently operating in Energy Management 1x1 Mode."
          type: boolean
        emDlsOperStatus:
          description: "It indicates whether the CM is currently operating in Energy Management DLS Mode."
          type: boolean          
          description: 'Current operational status of the device. Enumeration of:

            1 = Up.

            2 = Initializing.

    CableLineInfo.cmDpvStats:
      required:
        - ifIndex
        - lastMeasLatency
        - lastMeasTime
        - minLatency
        - maxLatency
        - avgLatency
        - numMeas
      properties:
        ifIndex:
          description: It represents the interface Index of the Downstream Interface where the measurements are taken.
          type: string
        lastMeasLatency:
          description: The last latency measurement
            3 = Error.

            4 = Disabled.'
        upTime:
          description: Time in seconds since the device was last restarted.
          type: integer
        lastMeasTime:
         $ref: "#/components/schemas/TimeStamp"
        minLatency:
          description: The minimum latency measurement.
        iPConnectionUpTime:
          description: The time in seconds that the IP interface has been connected.
          type: integer
        maxLatency:
          description: The maximum latency measurement.
        totalBytesSent:
          description: Total number of IP payload bytes sent since the device was last restarted.
          type: integer
        avgLatency:
          description: The average latency measurement.
        totalBytesReceived:
          description: Total number of IP payload bytes received since the device was last restarted.
          type: integer
        numMeas:
          description: The number of latency measurements made.
        totalPacketsSent:
          description: Total number of packets sent since the device was last restarted.
          type: integer

    CableLineInfo.serviceFlowStats.serviceFlowInfo:
        totalPacketsReceived:
          description: Total number of packets received since the device was last restarted.
          type: integer
        iPPingDiagnostics:
          description: The result of an IP-layer ping test.
          $ref: '#/components/schemas/IPPingDiagnostics'
        traceRouteDiagnostics:
          description: The result of an IP-layer trace-route test.
          $ref: '#/components/schemas/TraceRouteDiagnostics'
        downloadDiagnostics:
          description: The result of a HTTP and FTP DownloadDiagnostics Test.
          $ref: '#/components/schemas/DownloadDiagnostics'
        uploadDiagnostics:
          description: The result of a HTTP and FTP UploadDiagnostics Test.
          $ref: '#/components/schemas/UploadDiagnostics'
      required:
      - gwId
      - deviceId
      - deviceStatus
      - upTime
      - iPConnectionUpTime
      - totalBytesSent
      - totalBytesReceived
      - totalPacketsSent
      - totalPacketsReceived
    CableLineInfo:
      x-etsi-ref: 6.2.4
      type: object
      properties:
        timeStamp:
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
        customerPremisesInfo:
          description: The physical location of a customer site.
          $ref: '#/components/schemas/CpInfo'
        cmId:
          description: 'Information (typically the serial number) to identify a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system.


            This value SHALL remain fixed over the lifetime of the device, including across firmware updates.'
          type: string
        cmStatus:
          $ref: '#/components/schemas/CmStatus'
        cmDpvStats:
          $ref: '#/components/schemas/CmDpvStats'
        serviceFlowStats:
          $ref: '#/components/schemas/ServiceFlowStats'
      required:
         - serviceFlowId
         - description
         - timeCreated
         - timeActive
         - policedDropPkts
         - policedDelayPkts
         - aqmDroppedPkts
      - customerPremisesInfo
      - cmId
    PonInfo:
      x-etsi-ref: 6.2.5
      type: object
      properties:
          serviceFlowId:
            description: It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain.
            type: integer
          pkts:
            description: For outgoing Service Flows, this attribute counts the number of Packet Data PDUs forwarded to this Service Flow. For incoming upstream CMTS service flows, this attribute counts the number of Packet Data PDUs actually received on the Service Flow identified by the SID for which the packet was scheduled.
            type: integer
          timeCreated:
            description: For outgoing Service Flows, this attribute counts the number of Packet Data PDUs forwarded to this Service Flow. For incoming upstream CMTS service flows, this attribute counts the number of Packet Data PDUs actually received on the Service Flow identified by the SID for which the packet was scheduled.
            $ref: "#/components/schemas/TimeStamp"
          timeActive:
            description: FIt indicates the number of seconds that the service flow has been active
        timeStamp:
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
        customerPremisesInfo:
          description: The physical location of a customer site.
          $ref: '#/components/schemas/CpInfo'
        ponSYS_ID:
          description: 'The 20-bit identity of the optical system within a certain domain.

            This is a reference value set by the OSS.'
          type: string
        onuId:
          description: Information to identify an Optical Network Unit.
          type: string
        ponTech:
          type: integer
          policedDropPkts:
            description: For upstream service flows, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to 1) exceeding the selected Buffer Size for the service flow; or 2) UGS packets dropped due to exceeding the Unsolicited Grant Size with a Request/Transmission policy that requires such packets to be dropped.
          enum:
          - 1
          - 2
          - 3
          - 4
          description: 'An informative field identifying the optical technology used.


            The valid values are:

            1 = GPON.

            2 = XGPON.

            3 = NGPON2.

            4 = XGSPON.'
        operationalState:
          type: integer
          policedDelayPkts:
            description: It counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate.
          enum:
          - 0
          - 1
          description: 'It reports whether the ONU is currently capable of performing its function. Valid values are:

            0 = enabled

            1 = disabled'
        dsRate:
          type: integer
          aqmDroppedPkts:
            description: For upstream service flows on which AQM is enabled, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to Active Queue Management drop decisions.
          enum:
          - 1
          - 2
          description: "Downstream line rate, valid values are:\n1 =\t2,48832 Gbit/s: G-PON [i.9]; or\nNG-PON2 option 2 [i.8].\n2 =\t9,95328 Gbit/s:  XG-PON [i.10]; or\nXGS-PON [i.11]; or\nNG-PON2 option 1 [i.8]."
        usRate:
          type: integer

    CableLineInfo.serviceFlowStats:
          enum:
          - 1
          - 2
          - 3
          description: "Upstream line rate, valid values are:\n1 =\t1,24416 Gbit/s: G-PON option 1 [i.9].\n2 =\t2,48832 Gbit/s: G-PON option 2 [i.9]; or\nXG-PON [i.10]; or\nNG-PON2 option 2 [i.8].\n3 =\t9,95328 Gbit/s: XGS-PON [i.11]; or\nNG-PON2 option 1 [i.8]."
      required:
      - customerPremisesInfo
      - ponSYS_ID
      - onuId
      - ponTech
      - operationalState
      - dsRate
      - usRate
    OnuAlarmSubscription:
      x-etsi-ref: 6.3.2
      type: object
      properties:
        subscriptionType:
          description: Shall be set to "OnuAlarmSubscription".
          type: string
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. See note.
          type: string
          format: uri
        requestTestNotification:
          description: "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause\_6.12a.\nDefault: FALSE. "
          type: boolean
        websockNotifConfig:
          description: Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. See note.
          $ref: '#/components/schemas/WebsockNotifConfig'
        _links:
          $ref: '#/components/schemas/_links'
        filterCriteriaOnuAlarm:
          $ref: '#/components/schemas/FilterCriteriaOnuAlarm'
        expiryDeadline:
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
      required:
        - ifIndex
        - serviceFlowInfo
      - subscriptionType
      - filterCriteriaOnuAlarm
      description: "|-\n  NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a."
    DevInfoSubscription:
      x-etsi-ref: 6.3.3
      type: object
      properties:
        ifIndex:
            description: It represents the interface index of the MAC Domain of the Service Flow.
        subscriptionType:
          description: Shall be set to "DevInfoSubscription".
          type: string
        serviceFlowInfo:
            description: It represents the information of a Service Flow.
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. See note.
          type: string
          format: uri
        requestTestNotification:
          description: "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause\_6.12a.\nDefault: FALSE. "
          type: boolean
        websockNotifConfig:
          description: Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. See note.
          $ref: '#/components/schemas/WebsockNotifConfig'
        _links:
          $ref: '#/components/schemas/_links'
        filterCriteriaDevInfo:
          $ref: '#/components/schemas/FilterCriteriaDevInfo'
        expiryDeadline:
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
      required:
      - subscriptionType
      - filterCriteriaDevInfo
      description: "|-\n  NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a."
    CmConnSubscription:
      x-etsi-ref: 6.3.4
      type: object
      properties:
        subscriptionType:
          description: Shall be set to "CmConnSubscription".
          type: string
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
          type: string
          format: uri
        requestTestNotification:
          description: "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause\_6.12a.\nDefault: FALSE. "
          type: boolean
        websockNotifConfig:
          description: Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. See note 1.
          $ref: '#/components/schemas/WebsockNotifConfig'
        _links:
          $ref: '#/components/schemas/_links'
        filterCriteriaCmConn:
          $ref: '#/components/schemas/FilterCriteriaCmConn'
        expiryDeadline:
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
      required:
      - subscriptionType
      - filterCriteriaCmConn
      description: "|-\n  NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nNOTE 2:\t'notReady' indicates that the CM has not started the registration process yet.\n\t'notSynchronized' indicates that the CM has not initiated or completed the synchronization of the downstream physical layer.\n\t'phySynchronized' indicates that the CM has completed the synchronization of the downstream physical layer.\n\t'dsTopologyResolutionInProgress' indicates that the CM is attempting to determine its MD-DS-SG.\n\t'usParametersAcquired' indicates that the CM has completed the upstream parameters acquisition or have completed the downstream and upstream service groups resolution.\n\t'rangingInProgress' indicates that the CM has initiated the initial ranging process.\n\t'rangingComplete' indicates that the CM has completed initial ranging and received a Ranging Status of success from the CMTS in the RNG-RSP message.\n\t'eaeInProgress' indicates that the CM has sent an Auth Info message for EAE.\n\t'dhcpv4InProgress' indicates that the CM has sent a DHCPv4 DISCOVER to gain IP connectivity.\n\t'dhcpv6InProgress' indicates that the CM has sent a DHCPv6 Solicit message.\n\t'dhcpv4Complete' indicates that the CM has received a DHCPv4 ACK message from the CMTS.\n\t'dhcpv6Complete' indicates that the CM has received a DHCPv6 Reply message from the CMTS.\n\t'todEstablished' indicates that the CM has successfully acquired time of day.\n\t'securityEstablished' indicates that the CM has successfully completed the BPI initialization process.\n\t'configFileDownloadComplete' indicates that the CM has completed the config file download process.\n\t'registrationInProgress' indicates that the CM has sent a Registration Request.\n\t'registrationComplete' indicates that the CM has successfully completed the Registration process with the CMTS.\n\t'accessDenied' indicates that the CM has received a registration aborted notification from the CMTS.\n\t'operational' indicates that the CM has completed all necessary initialization steps and is operational.\n\t'bpiInit' indicates that the CM has started the BPI initialization process as indicated in the CM config file.\n\t'forwardingDisabled' indicates that the registration process was completed, but the network access option in the received configuration file prohibits forwarding."
    SubscriptionLinkList:
      x-etsi-ref: 6.3.5
      type: object
      properties:
        _links:
          $ref: '#/components/schemas/_links1'
      required:
      - _links
    AniAlarmSubscription:
      x-etsi-ref: 6.3.6
      type: object
      properties:
        subscriptionType:
          description: Shall be set to "AniAlarmSubscription".
          type: string
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. See note.
          type: string
          format: uri
        requestTestNotification:
          description: "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause\_6.12a.\nDefault: FALSE. "
          type: boolean
        websockNotifConfig:
          description: Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. See note.
          $ref: '#/components/schemas/WebsockNotifConfig'
        _links:
          $ref: '#/components/schemas/_links'
        filterCriteriaAniAlarm:
          $ref: '#/components/schemas/FilterCriteriaAniAlarm'
        onuId:
          description: The unique identifiers for the optical network unit,
          type: string
        aniIndex:
          description: The index of an access network interface supported by the optical network unit.
          type: string
        alarms:
          description: "In case alarms is not included in the subscription request, the default value -1 = All shall be used and included in the response:\n0  =\tLowReceivedOpticalPower.\n(Received downstream optical power below threshold.)\n1  =\tHighReceivedOpticalPower.\n\t(Received downstream optical power above threshold.)\n2  =\tSignalFalure.\n(Bit error-based signal fail.)\n3  =\tSignalDegrade.\n(Bit error-based signal degrade.)\n4  =\tLowTransmitOpticalPower.\n(Transmit optical power below lower threshold.)\n5  =\tHighTransmitOpticalPower.\n(Transmit optical power above upper threshold.)\n6  =\tLaserBiasCurrent.\n(Laser bias current above threshold determined by vendor.)\n-1 =\tAll."
          type: array
          minItems: 0
          items:
                $ref: "#/components/schemas/CableLineInfo.serviceFlowStats.serviceFlowInfo"

    CableLineInfo:
      type: object
            type: integer
        expiryDeadline:
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
      required:
        - customerPremisesInfo
        - cmId
      - subscriptionType
      - filterCriteriaAniAlarm
      - onuId
      - aniIndex
      description: "|-\n  NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a."
    OnuAlarmNotification:
      x-etsi-ref: 6.4.2
      type: object
      properties:
        notificationType:
          description: Shall be set to "OnuAlarmNotification".
          type: string
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
        customerPremisesInfo:
          # description': The physical location of a customer site.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': CpInfo
          $ref: "#/components/schemas/CpInfo"          
        cmId:
          description: The physical location of the related customer sites.
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/CpInfo'
        onuId:
          description: The unique identifier for an optical network unit.
          type: string
          description: Information (typically the serial number) to identify a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system.
                        This value SHALL remain fixed over the lifetime of the device, including across firmware updates.        
        cmStatus:
          $ref: "#/components/schemas/CableLineInfo.cmStatus"
        cmDpvStats:
           $ref: "#/components/schemas/CableLineInfo.cmDpvStats"
        serviceFlowStats:
          $ref: "#/components/schemas/CableLineInfo.serviceFlowStats"
      x-etsi-ref: 6.2.4

    CmConnNotification.cmIf.cmRegState:
      description: "It indicates the CM connectivity state. Enumeration of  1 = notReady. 2 = notSynchronized. 3 = phySynchronized. 4 = dsTopologyResolutionInProgress.5 = usParametersAcquired. 6 = rangingInProgress.7 = rangingComplete. 8 = eaeInProgress.9 = dhcpv4InProgress. 10 = dhcpv6InProgress.11 = dhcpV4Complete.12 = dhcpV6Complete.13 = todEstablished.14 = securityEstablished.15 = configFileDownloadComplete.16 = registrationInProgress.17 = registrationComplete. 18 = accessDenied. 19 =operational. 20 = bpiInit.21 =forwardingDisabled. 22 = rangingInProgress. 23 = rfMuteAll."
        alarm:
          type: integer
          enum:
          - 0
          - 1
          - 2
          - 3
@@ -816,413 +807,300 @@ components:
          - 13
          - 14
          - 15
        - 16
        - 17
        - 18
        - 19
        - 20
        - 21
      type: integer

    CmConnNotification.cmIf:
      description: ""
          description: "Indicates the alarm of the ONU:\n0  \t= \tEquipmentAlarm.\n1  \t= \tPoweringAlarm.\n2  \t= \tBatteryMissing.\n3  \t= \tBatteryFailure.\n4  \t= \tBatteryLow.\n5  \t= \tPhysicalIntrusion.\n6  \t= \tOnuSelfTestFailure.\n7  \t= \tDyingGasp.\n8  \t= \tTemperatureYellow.\n9  \t= \tTemperatureRed.\n10 \t= \tVoltageYellow.\n11 \t= \tVoltageRed.\n12 \t= \tOnuManualPowerOff.\n13 \t= \tInvImage.\n14 \t= \tPseOverloadYellow.\n15 \t= \tPseOverloadRed."
      required:
      - notificationType
      - onuId
      - alarm
    DevInfoNotification:
      x-etsi-ref: 6.4.3
      type: object
      properties:
        cmId:
          description: The Cable Modem identifier.
        notificationType:
          description: Shall be set to "DevInfoNotification".
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        cmRegState:
          items:
            $ref: "#/components/schemas/CmConnNotification.cmIf.cmRegState"
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Enum
        ifIndex:
          description: The MAC Domain interface index of the CM.
          items:
        timeStamp:
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
        deviceId:
          description: The identifier for a device.
          type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
      required:
        - cmId
        - ifIndex
        - cmRegState
        deviceErrStatus:
          type: integer
          enum:
          - 1
          - 2
          description: 'Indicates the abnormal operational status of the device. Enumeration of:

    CmConnNotification:
            1 = Error.

            2 = Disabled.'
      required:
      - notificationType
        - cmIf
      - deviceId
      - deviceErrStatus
    CmConnNotification:
      x-etsi-ref: 6.4.4
      type: object
      properties:
        cmIf:
          type: array
          items:
            $ref: "#/components/schemas/CmConnNotification.cmIf"
        customerPremisesInfo:
          # description': The physical location of a customer site.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': CpInfo
          $ref: "#/components/schemas/CpInfo"
        notificationType:
          description: 'Shall be set to \"CmconnNotification\".'
          description: Shall be set to "CmconnNotification".
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
        customerPremisesInfo:
          description: The physical location of a customer site.
          $ref: '#/components/schemas/CpInfo'
        cmIf:
          type: array
          items:
            $ref: '#/components/schemas/CmIf1'
      required:
      - notificationType
      - cmIf
    ExpiryNotification:
      x-etsi-ref: 6.4.5
      type: object

      x-etsi-ref: 6.4.4

    CmConnSubscription.links:
      description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
      properties:
        self:
          # description': Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LinkType
          $ref: "#/components/schemas/LinkType"
        timeStamp:
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
        _links:
          $ref: '#/components/schemas/_links2'
        expiryDeadline:
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
      required:
        - self
      - _links
      - expiryDeadline
    AniAlarmNotification:
      x-etsi-ref: 6.4.6
      type: object
      x-etsi-mec-cardinality: 0..1

    CmConnSubscription.filterCriteriaCmConn.cmIf.cmRegState:
      description: "It indicates the CM connectivity state. Enumeration of:  1 = notReady. 2 = notSynchronized. 3 = phySynchronized. 4 = dsTopologyResolutionInProgress.5 = usParametersAcquired. 6 = rangingInProgress.7 = rangingComplete. 8 = eaeInProgress.9 = dhcpv4InProgress. 10 = dhcpv6InProgress.11 = dhcpV4Complete.12 = dhcpV6Complete.13 = todEstablished.14 = securityEstablished.15 = configFileDownloadComplete.16 = registrationInProgress.17 = registrationComplete. 18 = accessDenied. 19 =operational. 20 = bpiInit.21 =forwardingDisabled."
      properties:
        notificationType:
          description: Shall be set to "AniAlarmNotification".
          type: string
        timeStamp:
          description: Time stamp.
          $ref: '#/components/schemas/TimeStamp'
        customerPremisesInfo:
          description: The physical location of the related customer sites.
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/CpInfo'
        onuId:
          description: The unique identifiers for the optical network unit.
          type: string
        aniId:
          $ref: '#/components/schemas/AniId'
        aniIndex:
          description: The index of an access network interface supported by the optical network unit.
          type: string
        alarm:
          type: integer
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
        - 13
        - 14
        - 15
        - 16
        - 17
        - 18
        - 19
        - 20
        - 21
      type: integer
          description: 'Indicates the alarm of the ANI:

    CmConnSubscription.filterCriteriaCmConn.cmIf:
      description: ""
      properties:
        cmId:
          description: The identifier of a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system.
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        cmRegState:
          items:
            $ref: "#/components/schemas/CmConnSubscription.filterCriteriaCmConn.cmIf.cmRegState"
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Enum
        ifIndex:
          description: The MAC Domain interface index of the CM.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
      required:
        - cmId
        - ifIndex
        - cmRegState
    CmConnSubscription.filterCriteriaCmConn:
      description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
      properties:
        cmIf:
          type: array
          items:
            $ref: "#/components/schemas/CmConnSubscription.filterCriteriaCmConn.cmIf"
        customerPremisesInfo:
          # description': The physical location of a customer site.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': CpInfo
          $ref: "#/components/schemas/CpInfo"
            0 = LowReceivedOpticalPower.

      type: object
      x-etsi-mec-cardinality: "1"
            1 = HighReceivedOpticalPower.

    CmConnSubscription:
            2 = SignalFailure.

            3 = SignalDegrade.

            4 = LowTransmitOpticalPower.

            5 = HighTransmitOpticalPower.

            6 = LaserBiasCurrent.'
      required:
      - notificationType
      - onuId
      - aniIndex
      - alarm
    TestNotification:
      x-etsi-ref: 6.4.7
      type: object
      properties:
        _links:
          $ref: "#/components/schemas/CmConnSubscription.links"
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.
          format: uri
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: URI
        requestTestNotification:
          description: Shall be set to TRUE by the service consumer to request
          type: boolean      
        websockNotifConfig:
          description: Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.
          $ref: "#/components/schemas/WebsockNotifConfig" 
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        filterCriteriaCmConn:
          $ref: "#/components/schemas/CmConnSubscription.filterCriteriaCmConn"
        subscriptionType:
          description: Shall be set to "CmConnSubscription".
        notificationType:
          description: Shall be set to "TestNotification".
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        _links:
          $ref: '#/components/schemas/_links3'
      required:
        - subscriptionType
        - filterCriteriaCmConn
      - notificationType
      - _links
    TimeStamp:
      x-etsi-ref: 6.5.2
      type: object
      x-etsi-notes: "NOTE:\t'notReady' indicates that the CM has not started the registration process yet.\n\t'notSynchronized' indicates that the CM has not initiated or completed the synchronization of the downstream physical layer.\n\t'phySynchronized' indicates that the CM has completed the synchronization of the downstream physical layer.\n\t'dsTopologyResolutionInProgress' indicates that the CM is attempting to determine its MD-DS-SG.\n\t'usParametersAcquired' indicates that the CM has completed the upstream parameters acquisition or have completed the downstream and upstream service groups resolution.\n\t'rangingInProgress' indicates that the CM has initiated the initial ranging process.\n\t'rangingComplete' indicates that the CM has completed initial ranging and received a Ranging Status of success from the CMTS in the RNG-RSP message.\n\t'eaeInProgress' indicates that the CM has sent an Auth Info message for EAE.\n\t'dhcpv4InProgress' indicates that the CM has sent a DHCPv4 DISCOVER to gain IP connectivity.\n\t'dhcpv6InProgress' indicates that the CM has sent a DHCPv6 Solicit message.\n\t'dhcpv4Complete' indicates that the CM has received a DHCPv4 ACK message from the CMTS.\n\t'dhcpv6Complete' indicates that the CM has received a DHCPv6 Reply message from the CMTS.\n\t'todEstablished' indicates that the CM has successfully acquired time of day.\n\t'securityEstablished' indicates that the CM has successfully completed the BPI initialization process.\n\t'configFileDownloadComplete' indicates that the CM has completed the config file download process.\n\t'registrationInProgress' indicates that the CM has sent a Registration Request.\n\t'registrationComplete' indicates that the CM has successfully completed the Registration process with the CMTS.\n\t'accessDenied' indicates that the CM has received a registration aborted notification from the CMTS.\n\t'operational' indicates that the CM has completed all necessary initialization steps and is operational.\n\t'bpiInit' indicates that the CM has started the BPI initialization process as indicated in the CM config file.\n\t'forwardingDisabled' indicates that the registration process was completed, but the network access option in the received configuration file prohibits forwarding."
      x-etsi-ref: 6.3.4
      properties:
        seconds:
          description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
          type: integer
          format: uint32
        nanoSeconds:
          description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
          type: integer
          format: uint32
      required:
      - seconds
      - nanoSeconds
    CpInfo:
      x-etsi-ref: 6.5.3
      type: object
      properties:
        latitude:
          description: "Latitude (DATUM=WGS84) -90 to 90 in decimal degree format DDD.ddd"
          format: Float
          description: 'Latitude (DATUM=WGS84)

            -90 to 90 in decimal degree format DDD.ddd'
          type: number
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Float
          format: float
        longitude:
          description: "Longitude (DATUM=WGS84) -180 to 180 in decimal degree format DDD.ddd"
          format: Float
          description: 'Longitude (DATUM=WGS84)

            -180 to 180 in decimal degree format DDD.ddd'
          type: number
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Float
          format: float
        postalCode:
          description: Postal code for the location
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
    IPPingDiagnostics:
      x-etsi-ref: 6.5.4
      type: object
      x-etsi-ref: 6.5.3
    DevInfoNotification:
      properties:
        deviceErrStatus:
          $ref: "#/components/schemas/deviceErrStatus"
        #  x-etsi-mec-cardinality: '1'
        # x-etsi-mec-origin-type: Enum
        deviceId:
          description: The identifier for a device.
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        notificationType:
          description: Shall be set to "DevInfoNotification".
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
      required:
        - notificationType
        - deviceId
        - deviceErrStatus
      type: object
      x-etsi-ref: 6.4.3

    deviceErrStatus:
      description: "The abnormal operational status of the device. Enumeration of:  1 = Error. 2 = Disabled."
        diagnosticsState:
          type: integer
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          description: 'The state of the IP ping test. Enumeration of:

            1 = None.

            2 = Requested.

            3 = Complete.

            4 = Error_CannotResolveHostName.

            5 = Error_Internal.

            6 = Error_Other.'
        host:
          description: Host name or address of the host to ping.
          type: string
        numberOfRepetitions:
          description: Number of repetitions of the ping test to perform before reporting the results.
          type: integer
        timeout:
          description: Timeout in milliseconds for the ping test.
          type: integer
        dataBlockSize:
          description: Size of the data block in bytes to be sent for each ping.
          type: integer
        successCount:
          description: 'Result parameter indicating the number of successful

            pings (those in which a successful response was received prior to the timeout) in the most recent ping test.'
          type: integer
        failureCount:
          description: Result parameter indicating the number of failed pings in the most recent ping test.
          type: integer
        averageResponseTime:
          description: 'Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test.


            If there were no successful responses, this value shall be zero.'
          type: integer
        minimumResponseTime:
          description: 'Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test.


    DevInfoSubscription.links:
      description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
      properties:
        self:
          # description': Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LinkType
          $ref: "#/components/schemas/LinkType"
      required:
        - self
      type: object
      x-etsi-mec-cardinality: 0..1
            If there were no successful responses, this value shall be zero.'
          type: integer
        maximumResponseTime:
          description: 'Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test.

    DevInfoSubscription.filterCriteriaDevInfo:
      description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
      properties:
        deviceErrStatus:
          items:
            $ref: "#/components/schemas/deviceErrStatus"
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Enum
        deviceId:
          description: The device identifier.
          items:
            type: string
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        gwId:
          description: The identifier of an Internet Gateway Device through which the customer premises device is connected.
          items:
            type: string
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
      type: object
      x-etsi-mec-cardinality: "1"

    DevInfoSubscription:
      properties:
        _links:
          $ref: "#/components/schemas/DevInfoSubscription.links"
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.
          format: uri
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: URI
        requestTestNotification:
          description: Shall be set to TRUE by the service consumer to request
          type: boolean      
        websockNotifConfig:
          description: Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.
          $ref: "#/components/schemas/WebsockNotifConfig" 
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        filterCriteriaDevInfo:
          $ref: "#/components/schemas/DevInfoSubscription.filterCriteriaDevInfo"
        subscriptionType:
          description: Shall be set to "DevInfoSubscription".
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
            If there were no successful responses, this value shall be zero.'
          type: integer
      required:
        - subscriptionType
        - callbackReference
        - filterCriteriaDevInfo
      - diagnosticsState
    TraceRouteDiagnostics:
      x-etsi-ref: 6.5.5
      type: object
      x-etsi-ref: 6.3.3

    DeviceInfo.deviceStatus:
      description: "Current operational status of the device. Enumeration of: 1 = Up. 2 = Initializing. 3 = Error. 4 = Disabled."
      properties:
        diagnosticsState:
          type: integer
          enum:
          - 1
          - 2
          - 3
          - 4
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
    DeviceInfo:
      properties:
        deviceId:
          description: "Typically, the serial number of the device.This value shall remain fixed over the lifetime of the device, including across firmware updates."
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        deviceStatus:
          $ref: "#/components/schemas/DeviceInfo.deviceStatus"
        downloadDiagnostics:
          # description': The result of a HTTP and FTP DownloadDiagnostics Test.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': DownloadDiagnostics
          $ref: "#/components/schemas/DownloadDiagnostics"
        gwId:
          description:
            "Information (typically the serial number) to identify an Internet Gateway Device through which the customer premises device is connected. This value shall remain fixed over the lifetime of the device, including across firmware updates."
          items:
          - 5
          - 6
          - 7
          description: 'The state of the IP trace-route test. Enumeration of:

            1 = None.

            2 = Requested.

            3 = Complete.

            4 = Error_CannotResolveHostName.

            5 = Error_MaxHopCountExceeded.

            6 = Error_Internal.

            7 = Error_Other.'
        host:
          description: Host name or address of the host to find a route to.
          type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        iPConnectionUpTime:
          description: The time in seconds that the IP interface has been connected.
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
        iPPingDiagnostics:
          # description': The result of an IP-layer ping test.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': IPPingDiagnostics
          $ref: "#/components/schemas/IPPingDiagnostics"
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        totalBytesReceived:
          description: Total number of IP payload bytes received since the device was last restarted.
        timeout:
          description: Timeout in milliseconds for the trace route test.
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
        totalBytesSent:
          description: Total number of IP payload bytes sent since the device was last restarted.
        dataBlockSize:
          description: Size of the data block in bytes to be sent for each trace route.
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
        totalPacketsReceived:
          description: Total number of packets received since the device was last restarted.
        maxHopCount:
          description: The maximum number of hop used in outgoing probe packets. The default is 30 hops.
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
        totalPacketsSent:
          description: Total number of packets sent since the device was last restarted.
        responseTime:
          description: 'Result parameter indicating the response time in milliseconds the most recent trace route test.


            If a route could not be determined, this value shall be zero.'
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
        traceRouteDiagnostics:
          # description': The result of an IP-layer trace-route test.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TraceRouteDiagnostics
          $ref: "#/components/schemas/TraceRouteDiagnostics"
        upTime:
          description: Time in seconds since the device was last restarted.
        numberOfRouteHops:
          description: 'Result parameter indicating the number of hops within the discovered route.


            If a route could not be determined, this value shall be zero.'
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
        uploadDiagnostics:
          # description': The result of a HTTP and FTP UploadDiagnostics Test.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': UploadDiagnostics
          $ref: "#/components/schemas/UploadDiagnostics"
      required:
        - gwId
        - deviceId
        - deviceStatus
        - upTime
        - iPConnectionUpTime
        - totalBytesSent
        - totalBytesReceived
        - totalPacketsSent
        - totalPacketsReceived
      - diagnosticsState
    DownloadDiagnostics:
      x-etsi-ref: 6.5.6
      type: object
      x-etsi-ref: 6.2.3
    DownloadDiagnostics.diagnosticsState:
      description: "The state of the HTTP and FTP download test. Enumeration of:1 = None.2 = Requested.3 = Completed.4 = Error_InitConnectionFailed.5 = Error_NoResponse.6 = Error_TransferFailed. 7 = Error_PasswordRequestFailed.8 = Error_LoginFailed.9 = Error_NoTransferMode.10 = Error_NoPASV.11 = Error_IncorrectSize.12 = Error_Timeout."
      properties:
        diagnosticsState:
          type: integer
          enum:
          - 1
          - 2
@@ -1236,93 +1114,40 @@ components:
          - 10
          - 11
          - 12
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
    DownloadDiagnostics:
      properties:
        bOMTime:
          # description': Begin of transmission time in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        diagnosticsState:
          $ref: "#/components/schemas/DownloadDiagnostics.diagnosticsState"
          description: "The state of the HTTP and FTP download test. Enumeration of:\n1 \t= \tNone.\n2 \t= \tRequested.\n3 \t= \tCompleted.\n4 \t= \tError_InitConnectionFailed.\n5 \t= \tError_NoResponse.\n6 \t= \tError_TransferFailed.\n7 \t= \tError_PasswordRequestFailed.\n8 \t= \tError_LoginFailed.\n9 \t= \tError_NoTransferMode.\n10 \t= \tError_NoPASV.\n11 \t= \tError_IncorrectSize.\n12 \t= \tError_Timeout."
        downloadURI:
          description: The URI for the device to perform the download on.
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        eOMTime:
          # description': End of transmission in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
          format: uri
        rOMTime:
          # description': Request time in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        tCPOpenReponseTime:
          # description': Response time in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        tCPOpenRequestTime:
          # description': Request time in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
          description: Request time in UTC, which shall be specified to microsecond precision.
          $ref: '#/components/schemas/TimeStamp'
        bOMTime:
          description: Begin of transmission time in UTC, which shall be specified to microsecond precision.
          $ref: '#/components/schemas/TimeStamp'
        eOMTime:
          description: End of transmission in UTC, which shall be specified to microsecond precision.
          $ref: '#/components/schemas/TimeStamp'
        testBytesReceived:
          description: The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between bOMTime and eOMTime.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        totalBytesReceived:
          description: The total number of bytes received on the Interface between bOMTime and eOMTime.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        tCPOpenRequestTime:
          description: Request time in UTC, which shall be specified to microsecond precision.
          $ref: '#/components/schemas/TimeStamp'
        tCPOpenReponseTime:
          description: Response time in UTC, which shall be specified to microsecond precision.
          $ref: '#/components/schemas/TimeStamp'
      required:
      - diagnosticsState
    UploadDiagnostics:
      x-etsi-ref: 6.5.7
      type: object
      x-etsi-ref: 6.5.6
    ExpiryNotification.links:
      description: List of hyperlinks related to the resource.
      properties:
        self:
          description: Self referring URI. This shall be included in the response from the FAIS. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
          format: uri
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: URI
      required:
        - self
      type: object
      x-etsi-mec-cardinality: "1"
    ExpiryNotification:
      properties:
        _links:
          $ref: "#/components/schemas/ExpiryNotification.links"
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
      required:
        - _links
        - expiryDeadline
      type: object
      x-etsi-ref: 6.4.5

    FaInfo.connectivityInfo.interfaceType:
      description: "The physical interface used for the end customer site:1   =   100BASE-TX.2   =   1000BASE-TX.3   =   1000BASE-LX.4   =   1000BASELX10.5   =   1000BASEBX10. 6   =   1000BASE-LH.7   =   1000Base-ZX. 8   =   ADSL-RJ11.9   =   VDSL-RJ11.10 =   GPON."
        diagnosticsState:
          type: integer
          enum:
          - 1
          - 2
@@ -1334,159 +1159,57 @@ components:
          - 8
          - 9
          - 10
          - 11
          - 12
          description: "The state of the HTTP and FTP download test. Enumeration of:\n1 \t= \tNone.\n2 \t= \tRequested.\n3 \t= \tCompleted.\n4 \t= \tError_InitConnectionFailed.\n5 \t= \tError_NoResponse.\n6 \t= \tError_PasswordRequestFailed.\n7 \t= \tError_LoginFailed.\n8 \t= \tError_NoTransferMode.\n9 \t= \tError_NoPASV.\n10 \t= \tError_NoCWD.\n11 \t= \tError_NoSTOR.\n12 \t= \tError_NoTransferComplete."
        uploadURI:
          description: The URI for the device to perform the upload to.
          type: string
          format: uri
        testFileLength:
          description: The size of the file (in bytes) to be uploaded to the server.
          type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
    FaInfo.connectivityInfo.lastMileTech:
      description: "An informative field identifying the last mile access technology used.The valid values are:1 = ADSL.2 = VDSL.3 = GPON. 4 = XGPON.5 = NGPON2. 6 = XGSPON. 7 = GFAST.8 = P2PEthernet."
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
    FaInfo.connectivityInfo:
      description: The per connectivity domain FAI as defined below.
      properties:
        dsbw:
          description: The bandwidth (in Mbps) from the network towards the customer site.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        interfaceType:
          $ref: "#/components/schemas/FaInfo.connectivityInfo.interfaceType"
        lastMileTech:
          $ref: "#/components/schemas/FaInfo.connectivityInfo.lastMileTech"
        latency:
          description: Maximum baseline latency (in ms) between customer site and service edge node.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        usbw:
          description: The bandwidth (in Mbps) from the customer site towards the network.
        rOMTime:
          description: Request time in UTC, which shall be specified to microsecond precision.
          $ref: '#/components/schemas/TimeStamp'
        bOMTime:
          description: Begin of transmission time in UTC, which shall be specified to microsecond precision.
          $ref: '#/components/schemas/TimeStamp'
        eOMTime:
          description: End of transmission in UTC, which shall be specified to microsecond precision.
          $ref: '#/components/schemas/TimeStamp'
        testBytesSent:
          description: The test traffic sent in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between bOMTime and eOMTime.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        tCPOpenRequestTime:
          description: Request time in UTC, which shall be specified to microsecond precision.
          $ref: '#/components/schemas/TimeStamp'
        tCPOpenReponseTime:
          description: Response time in UTC, which shall be specified to microsecond precision.
          $ref: '#/components/schemas/TimeStamp'
      required:
        - lastMileTech
        - interfaceType

    FaInfo:
      properties:
        connectivityInfo:
          type: array
          items:
            $ref: "#/components/schemas/FaInfo.connectivityInfo"
        customerPremisesInfo:
          description: The physical location of a customer site.
          items:
            $ref: "#/components/schemas/CpInfo"
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: CpInfo
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
      - diagnosticsState
    WebsockNotifConfig:
      x-etsi-ref: 6.5.9
      type: object
      required:
        - customerPremisesInfo

      x-etsi-ref: 6.2.2

    IPPingDiagnostics.diagnosticsState:
      description: "The state of the IP ping test. Enumeration of: 1 = None. 2 = Requested. 3 = Complete. 4 = Error_CannotResolveHostName. 5 = Error_Internal.6 = Error_Other."
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum

    IPPingDiagnostics:
      properties:
        averageResponseTime:
          description:
            "Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test.


            If there were no successful responses, this value shall be zero."
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        dataBlockSize:
          description: Size of the data block in bytes to be sent for each ping.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        diagnosticsState:
          $ref: "#/components/schemas/IPPingDiagnostics.diagnosticsState"
        failureCount:
          description: Result parameter indicating the number of failed pings in the most recent ping test.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        host:
          description: Host name or address of the host to ping.
        websocketUri:
          description: Set by FAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        maximumResponseTime:
          description:
            "Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test.


            If there were no successful responses, this value shall be zero."
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        minimumResponseTime:
          description:
            "Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test.


            If there were no successful responses, this value shall be zero."
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        numberOfRepetitions:
          description: Number of repetitions of the ping test to perform before reporting the results.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        successCount:
          description: "Result parameter indicating the number of successful

            pings (those in which a successful response was received prior to the timeout) in the most recent ping test."
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        timeout:
          description: Timeout in milliseconds for the ping test.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
      required:
        - diagnosticsState
          format: uri
        requestWebsocketUri:
          description: Set to true by the service consumer to indicate that Websocket delivery is requested.
          type: boolean
    CmStatus:
      description: It provides CM connectivity status information of the CM.
      type: object
      x-etsi-ref: 6.5.4

    OnuAlarmNotification.alarm:
      description: "Indicates the alarm of the ONU:0  = EquipmentAlarm.1  = PoweringAlarm.2  = BatteryMissing.3  = BatteryFailure.4  = BatteryLow.5  = PhysicalIntrusion. 6  = OnuSelfTestFailure. 7  = DyingGasp. 8  = TemperatureYellow.9  = TemperatureRed.10 = VoltageYellow.11 = VoltageRed.12 = OnuManualPowerOff. 13 = InvImage.14 = PseOverloadYellow.15 = PseOverloadRed."
      properties:
        ifIndex:
          description: It denotes the MAC Domain interface index of the CM.
          type: string
        cmRegState:
          type: integer
          enum:
        - 0
          - 1
          - 2
          - 3
@@ -1502,559 +1225,510 @@ components:
          - 13
          - 14
          - 15
          - 16
          - 17
          - 18
          - 19
          - 20
          - 21
          - 22
          - 23
          description: "It defines the CM connectivity state. Enumeration of:\n1 \t= \tother.\n2 \t= \tnotReady.\n3 \t= \tnotSynchronized.\n4 \t= \tphySynchronized.\n5 \t= \tusParametersAcquired.\n6 \t= \trangingComplete.\n7 \t= \tdhcpV4Complete.\n8 \t= \ttodEstablished.\n9 \t= \tsecurityEstablished.\n10 \t= \tconfigFileDownloadComplete.\n11 \t= \tregistrationComplete.\n12 \t= \toperational.\n13 \t= \taccessDenied.\n14 \t= \teaeInProgress.\n15 \t= \tdhcpv4InProgress.\n16 \t= \tdhcpv6InProgress.\n17 \t= \tdhcpV6Complete.\n18 \t= \tregistrationInProgress.\n19 \t= \tbpiInit.\n20 \t= \tforwardingDisabled.\n21 \t= \tdsTopologyResolutionInProgress.\n22 \t= \trangingInProgress.\n23 \t= \trfMuteAll."
        resets:
          description: It denotes the number of times the CM reset or initialized this interface.
          type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
    OnuAlarmNotification:
        lostSyncs:
          description: It denotes the number of times the CM lost synchronization with the downstream channel.
          type: integer
        invalidRegRsps:
          description: It denotes the number of times the CM received invalid registration response messages.
          type: integer
        energyMgt1x1OperStatus:
          description: It indicates whether the CM is currently operating in Energy Management 1x1 Mode.
          type: boolean
        emDlsOperStatus:
          description: It indicates whether the CM is currently operating in Energy Management DLS Mode.
          type: boolean
      required:
      - ifIndex
      - cmRegState
      - resets
      - lostSyncs
      - invalidRegRsps
      - energyMgt1x1OperStatus
      - emDlsOperStatus
    CmDpvStats:
      description: It represents the DOCSIS Path Verify Statistics collected in the cable modem device.
      type: object
      properties:
        alarm:
          $ref: "#/components/schemas/OnuAlarmNotification.alarm"
        customerPremisesInfo:
          description: The physical location of the related customer sites.
          items:
            $ref: "#/components/schemas/CpInfo"
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: CpInfo
        notificationType:
          description: Shall be set to "OnuAlarmNotification".
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        onuId:
          description: The unique identifier for an optical network unit.
        ifIndex:
          description: It represents the interface Index of the Downstream Interface where the measurements are taken.
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        lastMeasLatency:
          description: The last latency measurement.
          type: integer
        lastMeasTime:
          description: The last measurement time of the last latency measurement.
          $ref: '#/components/schemas/TimeStamp'
        minLatency:
          description: The minimum latency measurement.
          type: integer
        maxLatency:
          description: The maximum latency measurement.
          type: integer
        avgLatency:
          description: The average latency measurement.
          type: integer
        numMeas:
          description: The number of latency measurements made.
          type: integer
      required:
        - notificationType
        - onuId
        - alarm
      - ifIndex
      - lastMeasLatency
      - lastMeasTime
      - minLatency
      - maxLatency
      - avgLatency
      - numMeas
    ServiceFlowInfo:
      description: It represents the information of a Service Flow.
      type: object
      x-etsi-ref: 6.4.2

    OnuAlarmSubscription.alarms:
      description: "In case alarms is not included in the subscription request, the default value -1 = All shall be used and included in the response:\n0  =\tEquipmentAlarm.\n\t(Functional failure on an internal interface.)\n1  =\tPoweringAlarm.\n\t(Loss of external power to battery backup unit. This alarm is typically derived through an external interface to a battery backup unit, and indicates that AC is no longer available to maintain battery charge.)\n2  =\tBatteryMissing.\n\t(Battery is provisioned but missing.)\n3  =\tBatteryFailure.\n\t(Battery is provisioned and present but cannot recharge.)\n4  =\tBatteryLow.\n\t(Battery is provisioned and present but its voltage is too low.)\n5  =\tPhysicalIntrusion.\n\t(Applies if the ONU supports detection such as door or box open.)\n6  =\tOnuSelfTestFailure.\n\t(ONU has failed autonomous self-test.)\n7  =\tDyingGasp.\n\t(ONU is powering off imminently due to loss of power to the ONU itself.)\n8  =\tTemperatureYellow.\n\t(No service shutdown at present, but the circuit pack is operating beyond its recommended range.)\n9  =\tTemperatureRed.\n\t(Some services have been shut down to avoid equipment damage.)\n10 =\tVoltageYellow.\n\t(No service shutdown at present, but the line power voltage is below its recommended minimum.)\n11 =\tVoltageRed.\n\t(Some services have been shut down to avoid power collapse.)\n12 =\tOnuManualPowerOff.\n\t(The ONU is shutting down because the subscriber has turned off its power switch.)\n13 =\tInvImage.\n\t(Software image is invalid.)\n14 =\tPseOverloadYellow.\n\t(Indicates that the ONU is nearing its maximum ability to supply the known PoE demand of the attached PDs. The thresholds for declaring and clearing this alarm are vendor-specific.)\n15 =\tPseOverloadRed.\n\t(Indicates that the ONU is unable to supply all of the PoE demand of the attached PDs and has removed or reduced power to at least one PD.)\n-1 =\tAll."
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
        - 13
        - 14
        - 15
        - -1
      properties:
        serviceFlowId:
          description: It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain.
          type: integer
        pkts:
          description: For outgoing Service Flows, this attribute counts the number of Packet Data PDUs forwarded to this Service Flow. For incoming upstream CMTS service flows, this attribute counts the number of Packet Data PDUs actually received on the Service Flow identified by the SID for which the packet was scheduled.
          type: integer
        timeCreated:
          description: It indicates the time when the service flow was created.
          $ref: '#/components/schemas/TimeStamp'
        timeActive:
          description: It indicates the number of seconds that the service flow has been active.
          type: integer
        policedDropPkts:
          description: "For upstream service flows, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to:\n1)\texceeding the selected Buffer Size for the service flow; or\n2)\tUGS packets dropped due to exceeding the Unsolicited Grant Size with a Request/Transmission policy that requires such packets to be dropped."
          type: integer
        policedDelayPkts:
          description: It counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate.
          type: integer
    OnuAlarmSubscription.links:
        aqmDroppedPkts:
          description: For upstream service flows on which AQM is enabled, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to Active Queue Management drop decisions.
          type: integer
      required:
      - serviceFlowId
      - pkts
      - timeCreated
      - timeActive
      - policedDropPkts
      - policedDelayPkts
      - aqmDroppedPkts
    ServiceFlowStats:
      description: It describes statistics associated with the Service Flows in a managed device.
      type: object
      properties:
        ifIndex:
          description: It represents the interface index of the MAC Domain of the Service Flow.
          type: string
        serviceFlowInfo:
          type: array
          items:
            $ref: '#/components/schemas/ServiceFlowInfo'
      required:
      - ifIndex
      - serviceFlowInfo
    _links:
      description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
      type: object
      properties:
        self:
          # description': Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LinkType
          $ref: "#/components/schemas/LinkType"
          description: Self-referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
          $ref: '#/components/schemas/LinkType'
      required:
      - self
      type: object
      x-etsi-mec-cardinality: 0..1
    OnuAlarmSubscription.filterCriteriaOnuAlarm:
    FilterCriteriaOnuAlarm:
      description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
      type: object
      properties:
        alarms:
          items:
            $ref: "#/components/schemas/OnuAlarmSubscription.alarms"
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Enum
        customerPremisesInfo:
          description: 0 to N physical locations of the customer sites.
          items:
            $ref: "#/components/schemas/CpInfo"
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: CpInfo
          minItems: 0
          items:
            $ref: '#/components/schemas/CpInfo'
        onuId:
          description: "1 to N unique identifiers for the optical network units. Typical it is the unique serial number for each ONU, which contains the vendor ID and version number. The first four bytes are an ASCII-encoded four-letter vendor ID. The second four bytes are a binary encoded serial number, under the control of the ONU vendor."
          description: '1 to N unique identifiers for the optical network units.

            Typical it is the unique serial number for each ONU, which contains the vendor ID and version number. The first four bytes are an ASCII-encoded four-letter vendor ID. The second four bytes are a binary encoded serial number, under the control of the ONU vendor.'
          type: array
          minItems: 1
          items:
            type: string
          minItems: 1
        alarms:
          description: "In case alarms is not included in the subscription request, the default value -1 = All shall be used and included in the response:\n0  =\tEquipmentAlarm.\n\t(Functional failure on an internal interface.)\n1  =\tPoweringAlarm.\n\t(Loss of external power to battery backup unit. This alarm is typically derived through an external interface to a battery backup unit, and indicates that AC is no longer available to maintain battery charge.)\n2  =\tBatteryMissing.\n\t(Battery is provisioned but missing.)\n3  =\tBatteryFailure.\n\t(Battery is provisioned and present but cannot recharge.)\n4  =\tBatteryLow.\n\t(Battery is provisioned and present but its voltage is too low.)\n5  =\tPhysicalIntrusion.\n\t(Applies if the ONU supports detection such as door or box open.)\n6  =\tOnuSelfTestFailure.\n\t(ONU has failed autonomous self-test.)\n7  =\tDyingGasp.\n\t(ONU is powering off imminently due to loss of power to the ONU itself.)\n8  =\tTemperatureYellow.\n\t(No service shutdown at present, but the circuit pack is operating beyond its recommended range.)\n9  =\tTemperatureRed.\n\t(Some services have been shut down to avoid equipment damage.)\n10 =\tVoltageYellow.\n\t(No service shutdown at present, but the line power voltage is below its recommended minimum.)\n11 =\tVoltageRed.\n\t(Some services have been shut down to avoid power collapse.)\n12 =\tOnuManualPowerOff.\n\t(The ONU is shutting down because the subscriber has turned off its power switch.)\n13 =\tInvImage.\n\t(Software image is invalid.)\n14 =\tPseOverloadYellow.\n\t(Indicates that the ONU is nearing its maximum ability to supply the known PoE demand of the attached PDs. The thresholds for declaring and clearing this alarm are vendor-specific.)\n15 =\tPseOverloadRed.\n\t(Indicates that the ONU is unable to supply all of the PoE demand of the attached PDs and has removed or reduced power to at least one PD.)\n-1 =\tAll."
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
          minItems: 0
          items:
            type: integer
      required:
      - onuId
    FilterCriteriaDevInfo:
      description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
      type: object
      x-etsi-mec-cardinality: "1"
      properties:
        gwId:
          description: The identifier of an Internet Gateway Device through which the customer premises device is connected.
          type: array
          minItems: 0
          items:
            type: string
        deviceId:
          description: The device identifier.
          type: array
          minItems: 0
          items:
            type: string
        deviceErrStatus:
          description: 'The abnormal operational status of the device. Enumeration of:

    WebsockNotifConfig:
            1 = Error.

            2 = Disabled.'
          type: array
          minItems: 0
          items:
            type: integer
    CmIf:
      description: ''
      type: object
      properties:
        subscriptionType:
          description: Set by FAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.
        cmId:
          description: The identifier of a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system.
          type: string
          format: uri
        requestWebsocketUri:
          description: Set to true by the service consumer to indicate that Websocket delivery is requested.
          type: boolean        
    OnuAlarmSubscription:
      properties:
        _links:
          $ref: "#/components/schemas/OnuAlarmSubscription.links"
        callbackReference:
          description: URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.
          format: uri
        ifIndex:
          description: The MAC Domain interface index of the CM.
          type: array
          minItems: 1
          items:
            type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: URI
        requestTestNotification:
          description: Shall be set to TRUE by the service consumer to request
          type: boolean      
        websockNotifConfig:
          description: Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.
          $ref: "#/components/schemas/WebsockNotifConfig" 
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        filterCriteriaOnuAlarm:
          $ref: "#/components/schemas/OnuAlarmSubscription.filterCriteriaOnuAlarm"
        subscriptionType:
          description: Shall be set to \"OnuAlarmSubscription\".
        cmRegState:
          description: "It indicates the CM connectivity state.  See note 2 for detail. Enumeration of:\n1 \t= \tnotReady.\n2 \t= \tnotSynchronized.\n3 \t= \tphySynchronized.\n4 \t= \tdsTopologyResolutionInProgress.\n5 \t= \tusParametersAcquired.\n6 \t= \trangingInProgress.\n7 \t= \trangingComplete.\n8 \t= \teaeInProgress.\n9 \t= \tdhcpv4InProgress.\n10 \t= \tdhcpv6InProgress.\n11 \t= \tdhcpV4Complete.\n12 \t= \tdhcpV6Complete.\n13 \t= \ttodEstablished.\n14 \t= \tsecurityEstablished.\n15 \t= \tconfigFileDownloadComplete.\n16 \t= \tregistrationInProgress.\n17 \t= \tregistrationComplete.\n18 \t= \taccessDenied.\n19 \t=\toperational.\n20 \t= \tbpiInit.\n21 \t= \tforwardingDisabled."
          type: array
          minItems: 1
          items:
            type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
      required:
        - subscriptionType
        - filterCriteriaOnuAlarm
      - cmId
      - ifIndex
      - cmRegState
    FilterCriteriaCmConn:
      description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
      type: object
      x-etsi-ref: 6.3.2

    PonInfo.opticalNetworkInfo.dsRate:
      description: "Downstream line rate, valid values are:\n1 =\t2,48832 Gbit/s: G-PON [i.9]; or\nNG-PON2 option 2 [i.8].\n2 =\t9,95328 Gbit/s:  XG-PON [i.10]; or\n XGS-PON [i.11]; or\nNG-PON2 option 1 [i.8]."
      enum:
        - 1
        - 2
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
    PonInfo.opticalNetworkInfo.operationalState:
      description: "It reports whether the ONU is currently capable of performing its function. Valid values are: 0 = enabled 1 = disabled"
      enum:
        - 0
        - 1
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
    PonInfo.opticalNetworkInfo.ponTech:
      description: "An informative field identifying the optical technology used. The valid values are: 1 = GPON. 2 = XGPON.3 = NGPON2. 4 = XGSPON."
      enum:
        - 1
        - 2
        - 3
        - 4
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
    PonInfo.opticalNetworkInfo.usRate:
      description: "Upstream line rate, valid values are:\n1 =\t1,24416 Gbit/s: G-PON option 1 [i.9].\n2 =\t2,48832 Gbit/s: G-PON option 2 [i.9]; or\nXG-PON [i.10]; or\nNG-PON2 option 2 [i.8].\n3 =\t9,95328 Gbit/s: XGS-PON [i.11]; or\nNG-PON2 option 1 [i.8]."
      enum:
        - 1
        - 2
        - 3
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum

    PonInfo:
      properties:
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        customerPremisesInfo:
          description: The physical location of a customer site.
          items:
            $ref: "#/components/schemas/CpInfo"
          minItems: 1
          $ref: '#/components/schemas/CpInfo'
        cmIf:
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: CpInfo
        ponSYS_ID:
          description: "The 20-bit identity of the optical system within a certain domain.This is a reference value set by the OSS."
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        onuId:
          description: Information to identify an Optical Network Unit.
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        ponTech:
          $ref: "#/components/schemas/PonInfo.opticalNetworkInfo.ponTech"  
        operationalState:
          $ref: "#/components/schemas/PonInfo.opticalNetworkInfo.operationalState"                  
        dsRate:
          $ref: "#/components/schemas/PonInfo.opticalNetworkInfo.dsRate"



        usRate:
          $ref: "#/components/schemas/PonInfo.opticalNetworkInfo.usRate"          
      required:
        - customerPremisesInfo
        - ponSYS_ID
        - opticalNetworkInfo
        - onuId
        - ponTech
        - operationalState
        - dsRate
        - usRate
      type: object
      x-etsi-ref: 6.2.5

    SubscriptionLinkList.links.subscription.subscriptionType:
      description: Type of the subscription. The string shall be set according to the "subscriptionType" attribute of the associated subscription data type defined in clauses 6.3.2, 6.3.3, 6.3.4 and 6.3.6 "OnuAlarmSubscription" "DevInfoSubscription" "CmConnSubscription" "AniAlarmSubscription"
      enum:
        - "OnuAlarmSubscription"
        - "DevInfoSubscription"
        - "CmConnSubscription"
        - AniAlarmSubscription"
      type: string
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum


    SubscriptionLinkList.links.subscription:
          items:
            $ref: '#/components/schemas/CmIf'
    Subscriptions:
      description: The service consumer's subscriptions.
      type: object
      properties:
        href:
          description: The URI referring to the subscription.
          format: uri
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: URI
          format: uri
        subscriptionType:
          $ref: "#/components/schemas/SubscriptionLinkList.links.subscription.subscriptionType"
          description: "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type defined in clauses\_6.3.2, 6.3.3, 6.3.4 and 6.3.6:\n\"OnuAlarmSubscription\"\n\"DevInfoSubscription\"\n\"CmConnSubscription\"\n\"AniAlarmSubscription\""
          type: string
      required:
      - href
      - subscriptionType

    SubscriptionLinkList.links:
    _links1:
      description: Hyperlinks related to the resource.
      type: object
      required:
        - self
      properties:
        self:
          $ref: "#/components/schemas/LinkType"
          description: URI of this resource.
          $ref: '#/components/schemas/LinkType'
        subscriptions:
          description: The service consumer's subscriptions.
          type: array
          items:
            $ref: "#/components/schemas/SubscriptionLinkList.links.subscription"

    SubscriptionLinkList:
      properties:
        _links:
          $ref: "#/components/schemas/SubscriptionLinkList.links"
            $ref: '#/components/schemas/Subscriptions'
      required:
        - _links
      type: object
      x-etsi-ref: 6.3.5

    TestNotification:
      - self
    AniId:
      description: ''
      type: object
      required:
        - notificationType
        - _links
      properties:
        notificationType:
          description: Shall be set to "TestNotification
          type: string
        _links:
          description: Hyperlink related to the resource.
    FilterCriteriaAniAlarm:
      description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
      type: object
          required:
            - subscription
          properties:
            subscription:
              $ref: "#/components/schemas/LinkType"

          

    TimeStamp:
      properties:
        nanoSeconds:
          description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
          format: Uint32
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Uint32
        seconds:
          description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
          format: Uint32
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Uint32
      required:
        - seconds
        - nanoSeconds
      type: object
      x-etsi-ref: 6.5.2

    TraceRouteDiagnostics.diagnosticsState:
      description: "The state of the IP trace-route test. Enumeration of: 1 = None. 2 = Requested. 3 = Complete.  4 = Error_CannotResolveHostName. 5 = Error_MaxHopCountExceeded. 6 = Error_Internal. 7 = Error_Other."
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
        customerPremisesInfo:
          description: 0 to N physical locations of the customer sites.
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/CpInfo'
        onuId:
          description: '1 to N unique identifiers for the optical network units.

    TraceRouteDiagnostics:
      properties:
        dataBlockSize:
          description: Size of the data block in bytes to be sent for each trace route.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        diagnosticsState:
          $ref: "#/components/schemas/TraceRouteDiagnostics.diagnosticsState"
        host:
          description: Host name or address of the host to find a route to.
            Typical it is the unique serial number for each ONU, which contains the vendor ID and version number. The first four bytes are an ASCII-encoded four-letter vendor ID. The second four bytes are a binary encoded serial number, under the control of the ONU vendor.'
          type: array
          minItems: 1
          items:
            type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        maxHopCount:
          description: The maximum number of hop used in outgoing probe packets. The default is 30 hops.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        numberOfRouteHops:
          description:
            "Result parameter indicating the number of hops within the discovered route.


            If a route could not be determined, this value shall be zero."
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        responseTime:
          description:
            "Result parameter indicating the response time in milliseconds the most recent trace route test.


            If a route could not be determined, this value shall be zero."
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        timeout:
          description: Timeout in milliseconds for the trace route test.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        aniId:
          type: array
          items:
            $ref: '#/components/schemas/AniId'
      required:
        - diagnosticsState
      - onuId
      - aniId
    CmIf1:
      description: ''
      type: object
      x-etsi-ref: 6.5.5

    UploadDiagnostics.diagnosticsState:
      description: "The state of the HTTP and FTP download test. Enumeration of: 1 = None. 2 = Requested. 3 = Completed. 4 = Error_InitConnectionFailed. 5 = Error_NoResponse.  6 = Error_PasswordRequestFailed. 7 = Error_LoginFailed. 8 = Error_NoTransferMode. 9 = Error_NoPASV.  10 = Error_NoCWD. 11 = Error_NoSTOR.12 = Error_NoTransferComplete."
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
    UploadDiagnostics:
      properties:
        bOMTime:
          # description': Begin of transmission time in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        diagnosticsState:
          $ref: "#/components/schemas/UploadDiagnostics.diagnosticsState"
        eOMTime:
          # description': End of transmission in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        rOMTime:
          # description': Request time in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        tCPOpenReponseTime:
          # description': Response time in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        tCPOpenRequestTime:
          # description': Request time in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        testBytesSent:
          description: The test traffic sent in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between bOMTime and eOMTime.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        testFileLength:
          description: "The size of the file (in bytes) to be uploaded to the

            server."
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        uploadURI:
          description: The URI for the device to perform the upload to.
          format: uri
        cmId:
          description: The Cable Modem identifier.
          type: string
        ifIndex:
          description: The MAC Domain interface index of the CM.
          type: array
          minItems: 1
          items:
            type: string
        cmRegState:
          description: "It indicates the CM connectivity state. Enumeration of:\n1 \t= \tnotReady.\n2 \t= \tnotSynchronized.\n3 \t= \tphySynchronized.\n4 \t= \tdsTopologyResolutionInProgress.\n5 \t= \tusParametersAcquired.\n6 \t= \trangingInProgress.\n7 \t= \trangingComplete.\n8 \t= \teaeInProgress.\n9 \t= \tdhcpv4InProgress.\n10 \t= \tdhcpv6InProgress.\n11 \t= \tdhcpV4Complete.\n12 \t= \tdhcpV6Complete.\n13 \t= \ttodEstablished.\n14 \t= \tsecurityEstablished.\n15 \t= \tconfigFileDownloadComplete.\n16 \t= \tregistrationInProgress.\n17 \t= \tregistrationComplete.\n18 \t= \taccessDenied.\n19 \t= \toperational.\n20 \t= \tbpiInit.\n21 \t= \tforwardingDisabled."
          type: array
          minItems: 1
          items:
            type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
      required:
        - diagnosticsState
      type: object
      x-etsi-ref: 6.5.7

    LinkType:
      description: >-
        'URI referring to a resource'
      - cmId
      - ifIndex
      - cmRegState
    _links2:
      description: List of hyperlinks related to the resource.
      type: object
      required:
        - href
      properties:
        href:
          $ref: "#/components/schemas/Href"
    Href:
      description: >-
        The URI referring to the subscription.
      type: string
      format: uri
    ProblemDetails:
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of the problem
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        instance:
          description: A URI reference that identifies the specific occurrence of the problem
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        status:
          description: The HTTP status code for this occurrence of the problem
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        title:
          description: A short, human-readable summary of the problem type
        self:
          description: Self-referring URI. This shall be included in the response from the FAIS. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        type:
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
      required:
      - self
    _links3:
      description: 'Hyperlink related to the resource. '
      type: object
      properties:
        subscription:
          description: URI identifying the subscription for the test notification.
          $ref: '#/components/schemas/LinkType'
      required:
      - subscription
  responses:
    "204":
    '200':
      description: OK
    '204':
      description: No Content
    "206":
      description: Partial content
    "400":
      description: "Bad Request : used to indicate that incorrect parameters were passed to the request."
    '400':
      description: 'Bad Request: used to indicate that incorrect parameters were passed to the request.'
      content:
        application/json:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "401":
      description: "Unauthorized :  used when the client did not submit credentials."
            $ref: '#/components/schemas/ProblemDetails'
    '401':
      description: 'Unauthorized: used when the client did not submit credentials.'
      content:
        application/json:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "403":
      description: "Forbidden :  operation is not allowed given the current status of the resource."
            $ref: '#/components/schemas/ProblemDetails'
    '403':
      description: 'Forbidden: operation is not allowed given the current status of the resource.'
      content:
        application/json:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "404":
      description: "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI."
            $ref: '#/components/schemas/ProblemDetails'
    '404':
      description: 'Not Found: used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
        application/json:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "406":
      description: "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client."
            $ref: '#/components/schemas/ProblemDetails'
    '406':
      description: 'Not Acceptable: used to indicate that the server cannot provide the any of the content formats supported by the client.'
      content:
        application/json:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "409":
      description: "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource"
            $ref: '#/components/schemas/ProblemDetails'
    '412':
      description: 'Precondition failed: used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
      content:
        application/json:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "412":
      description: "Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT"
            $ref: '#/components/schemas/ProblemDetails'
    '415':
      description: 'Unsupported Media Type: used to indicate that the server or the client does not support the content type of the entity body.'
      content:
        application/json:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "415":
      description: "Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body."
            $ref: '#/components/schemas/ProblemDetails'
    '422':
      description: 'Unprocessable Entity: used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
      content:
        application/json:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "422":
      description: "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported."
            $ref: '#/components/schemas/ProblemDetails'
    '429':
      description: 'Too Many Requests: used when a rate limiter has triggered.'
      content:
        application/json:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "429":
      description: "Too Many Requests : used when a rate limiter has triggered."
      content:
        application/json:
            $ref: '#/components/schemas/ProblemDetails'
  parameters:
    Query.Customerpremisesinfo:
      description: Comma separated list of customer premises information defined in clause 6.2.2.
      name: customerpremisesinfo
      in: query
      required: false
      x-exportParamName: Query.Customerpremisesinfo
      schema:
        $ref: '#/components/schemas/CpInfo'
    Query.Lastmiletech:
      description: "Comma separated list of last mile technologies defined in clause\_6.2.2."
      name: lastmiletech
      in: query
      required: false
      x-exportParamName: Query.Lastmiletech
      schema:
        type: array
        items:
          type: integer
    Query.Interfacetype:
      description: Comma separated list of interface types defined in clause 6.2.2.
      name: interfacetype
      in: query
      required: false
      x-exportParamName: Query.Interfacetype
      schema:
        type: array
        items:
          type: integer
    Query.Dsbw:
      description: Comma separated list of the bandwidth (in Mbps) from the network towards the customer site defined in clause 6.2.2.
      name: dsbw
      in: query
      required: false
      x-exportParamName: Query.Dsbw
      schema:
        type: array
        items:
          type: integer
    Query.Usbw:
      description: Comma separated list of the bandwidth (in Mbps) from the customer site towards the network defined in clause 6.2.2.
      name: usbw
      in: query
      required: false
      x-exportParamName: Query.Usbw
      schema:
        type: array
        items:
          type: integer
    Query.Latency:
      description: "Comma separated list of the maximum baseline latency (in ms) between customer site and service edge node defined in clause\_6.2.2."
      name: latency
      in: query
      required: false
      x-exportParamName: Query.Latency
      schema:
        type: array
        items:
          type: integer
    Query.Gwid:
      description: Comma separated list of gateway identifier defined in clause 6.2.3.
      name: gwid
      in: query
      required: false
      x-exportParamName: Query.Gwid
      schema:
        type: array
        items:
          type: string
    Query.Deviceid:
      description: Comma separated list of device identifier defined in clause 6.2.3.
      name: deviceid
      in: query
      required: false
      x-exportParamName: Query.Deviceid
      schema:
            $ref: "#/components/schemas/ProblemDetails"
        type: array
        items:
          type: string
    Query.Devicestatus:
      description: Comma separated list of device status defined in clause 6.2.3.
      name: devicestatus
      in: query
      required: false
      x-exportParamName: Query.Devicestatus
      schema:
        type: array
        items:
          type: integer
    Query.Customerpremisesinfo1:
      description: Comma separated list of customer premises information defined in clause 6.2.4.
      name: customerpremisesinfo
      in: query
      required: false
      x-exportParamName: Query.Customerpremisesinfo1
      schema:
        $ref: '#/components/schemas/CpInfo'
    Query.Cmid:
      description: Comma separated list of Cable Modem identifiers defined in clause 6.2.4.
      name: cmid
      in: query
      required: false
      x-exportParamName: Query.Cmid
      schema:
        type: array
        items:
          type: string
    Query.Customerpremisesinfo2:
      description: Comma separated list of customer premises information defined in clause 6.2.5.
      name: customerpremisesinfo
      in: query
      required: false
      x-exportParamName: Query.Customerpremisesinfo2
      schema:
        $ref: '#/components/schemas/CpInfo'
    Query.Ponys_id:
      description: Comma separated list of optical system identifiers defined in clause 6.2.5.
      name: ponys_id
      in: query
      required: false
      x-exportParamName: Query.Ponys_id
      schema:
        type: array
        items:
          type: string
    Query.Onuid:
      description: Comma separated list of optical network unit identifiers defined in clause 6.2.5.
      name: onuid
      in: query
      required: false
      x-exportParamName: Query.Onuid
      schema:
        type: array
        items:
          type: string
    Query.Subscription_type:
      description: "Query parameter to filter on a specific subscription type. Permitted values:\nonu_alarm\tOptical Network Unit alarm\ndevice_abnormal_alert\tDevice abnormal alert\ncm_connectivity_state\tCable Modem connectivity state \nani_alarm\tAccess Node Interface alarm."
      name: subscription_type
      in: query
      required: false
      x-exportParamName: Query.Subscription_type
      schema:
        type: string
Loading