@itentialopensource/adapter-nokia_altiplano/report/adapter-openapi.yaml

This adapter integrates with system described as: Nokia Altiplano.

openapi: 3.0.0
info:
  title: Nokia Altiplano
  contact: {}
  version: '1.0'
servers:
- url: http://nokiaaltiplano.com/{base-url}/rest
  variables:
    base-url:
      default: DefaultParameterValue
paths:
  /auth/login:
    post:
      tags:
      - Intent
      summary: GetAccessToken
      description: Get Access Token and Refresh Token by Login method before executing any other RESTCONF request.
      operationId: GetAccessToken
      parameters: []
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /restconf/data/ibn:ibn/{intent}/dependents-summary:
    post:
      tags:
      - Intent
      summary: dependentsSummaryForDevice
      description: Dependents-summary for device
      operationId: dependentsSummaryForDevice
      parameters:
      - name: intent
        in: path
        description: the intent
        required: true
        style: simple
        schema:
          type: string
          example: intent=INES-172-31-30-140,device-fx
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /restconf/operations/ibn:search-intents:
    post:
      tags:
      - Intent
      summary: getuplinkConnectionConfiguration
      description: >-
        This request sample is used to search intents.

        This request contains all the filter elements, elements which should not be part of search filter should be removed before sending the request.
      operationId: getuplinkConnectionConfiguration
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Getuplink-connectionconfigurationRequest'
              - example:
                  ibn:input:
                    filter:
                      intent-type-list:
                        intent-type: uplink-connection
                      target: INES-172-31-30-140
                      predicate: MATCHES
                      required-network-state: active
                      order-by: asc.intent-type
                      config-required: 'true'
                    page-number: '0'
                    page-size: '10'
            example:
              ibn:input:
                filter:
                  intent-type-list:
                    intent-type: uplink-connection
                  target: INES-172-31-30-140
                  predicate: MATCHES
                  required-network-state: active
                  order-by: asc.intent-type
                  config-required: 'true'
                page-number: '0'
                page-size: '10'
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /restconf/data/ibn:ibn/{intent},fiber/dependents-summary:
    post:
      tags:
      - Intent
      summary: dependentsSummaryFiber
      description: Dependents summary fiber
      operationId: dependentsSummaryFiber
      parameters:
      - name: intent
        in: path
        description: the intent
        required: true
        style: simple
        schema:
          type: string
          example: intent=INES-1-1-4-3
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /restconf/data/ibn:ibn:
    post:
      tags:
      - Intent
      summary: createOnt
      description: Create ont
      operationId: createOnt
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateontRequest'
              - example:
                  ibn:intent:
                    target: INES-1-1-4-3-a
                    intent-type: ont
                    intent-type-version: '4'
                    required-network-state: active
                    intent-specific-data:
                      ont:ont:
                        ont-type: G-010G-Q
                        fiber-name: INES-1-1-4-3
                        expected-serial-number: ALCLF846403A
                        onu-service-profile: default
                        uni-service-configuration:
                          uni-id: LAN1
                          service-profile: default
            example:
              ibn:intent:
                target: INES-1-1-4-3-a
                intent-type: ont
                intent-type-version: '4'
                required-network-state: active
                intent-specific-data:
                  ont:ont:
                    ont-type: G-010G-Q
                    fiber-name: INES-1-1-4-3
                    expected-serial-number: ALCLF846403A
                    onu-service-profile: default
                    uni-service-configuration:
                      uni-id: LAN1
                      service-profile: default
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /restconf/data/ibn:ibn/{intent},ont:
    get:
      tags:
      - Intent
      summary: getOnt
      description: GET ont
      operationId: getOnt
      parameters:
      - name: intent
        in: path
        description: the intent
        required: true
        style: simple
        schema:
          type: string
          example: intent=INES-1-1-4-3
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - Intent
      summary: lockOnt
      description: >-
        This request sample is used to modify intent state.

        The value of required-network-state can be active or suspend or delete
      operationId: lockOnt
      parameters:
      - name: intent
        in: path
        description: the intent
        required: true
        style: simple
        schema:
          type: string
          example: intent=INES-1-1-4-3
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/LockontRequest'
              - example:
                  ibn:intent:
                    intent-type-version: 4
                    required-network-state: suspend
            example:
              ibn:intent:
                intent-type-version: 4
                required-network-state: suspend
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Intent
      summary: deleteOnt
      description: This request sample is used to delete an intent.
      operationId: deleteOnt
      parameters:
      - name: intent
        in: path
        description: the intent
        required: true
        style: simple
        schema:
          type: string
          example: intent=INES-1-1-4-3
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /restconf/data/ibn:ibn/{intent},ont/synchronize:
    post:
      tags:
      - Intent
      summary: synchronizeOnt
      description: Synchronize ont
      operationId: synchronizeOnt
      parameters:
      - name: intent
        in: path
        description: the intent
        required: true
        style: simple
        schema:
          type: string
          example: intent=INES-1-1-4-3
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /restconf/data/ibn:ibn/{intent},ont/audit:
    post:
      tags:
      - Intent
      summary: auditOnt
      description: Audit ont
      operationId: auditOnt
      parameters:
      - name: intent
        in: path
        description: the intent
        required: true
        style: simple
        schema:
          type: string
          example: intent=INES-1-1-4-3
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /restconf/data/ibn:ibn/{intent},l2-user/synchronize:
    post:
      tags:
      - Intent
      summary: synchronizel2User
      description: Synchronize l2-user
      operationId: synchronizel2User
      parameters:
      - name: intent
        in: path
        description: the intent
        required: true
        style: simple
        schema:
          type: string
          example: intent=INES-1-1-4-3
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /restconf/data/ibn:ibn/{intent},l2-user:
    get:
      tags:
      - Intent
      summary: getl2User
      description: GET l2-user
      operationId: getl2User
      parameters:
      - name: intent
        in: path
        description: the intent
        required: true
        style: simple
        schema:
          type: string
          example: intent=INES-1-1-4-3
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - Intent
      summary: modifyl2User
      description: >-
        This request sample is used to modify intent state.

        The value of required-network-state can be active or suspend or delete
      operationId: modifyl2User
      parameters:
      - name: intent
        in: path
        description: the intent
        required: true
        style: simple
        schema:
          type: string
          example: intent=INES-1-1-4-3
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Modifyl2-userRequest'
              - example:
                  ibn:intent:
                    intent-type: l2-user
                    intent-type-version: 4
                    intent-specific-data:
                      l2-user:l2-user:
                        service-profile: HSI-100M-10M-16MAC
            example:
              ibn:intent:
                intent-type: l2-user
                intent-type-version: 4
                intent-specific-data:
                  l2-user:l2-user:
                    service-profile: HSI-100M-10M-16MAC
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Intent
      summary: deletel2User
      description: This request sample is used to delete an intent.
      operationId: deletel2User
      parameters:
      - name: intent
        in: path
        description: the intent
        required: true
        style: simple
        schema:
          type: string
          example: intent=INES-1-1-4-3
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /restconf/data/ibn:ibn/{intent},l2-user/audit:
    post:
      tags:
      - Intent
      summary: auditl2User
      description: Audit l2-user
      operationId: auditl2User
      parameters:
      - name: intent
        in: path
        description: the intent
        required: true
        style: simple
        schema:
          type: string
          example: intent=INES-1-1-4-3
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
components:
  schemas:
    Getuplink-connectionconfigurationRequest:
      title: Getuplink-connectionconfigurationRequest
      required:
      - ibn:input
      type: object
      properties:
        ibn:input:
          allOf:
          - $ref: '#/components/schemas/IbnInput'
          - example:
              filter:
                intent-type-list:
                  intent-type: uplink-connection
                target: INES-172-31-30-140
                predicate: MATCHES
                required-network-state: active
                order-by: asc.intent-type
                config-required: 'true'
              page-number: '0'
              page-size: '10'
      example:
        ibn:input:
          filter:
            intent-type-list:
              intent-type: uplink-connection
            target: INES-172-31-30-140
            predicate: MATCHES
            required-network-state: active
            order-by: asc.intent-type
            config-required: 'true'
          page-number: '0'
          page-size: '10'
    IbnInput:
      title: IbnInput
      required:
      - filter
      - page-number
      - page-size
      type: object
      properties:
        filter:
          allOf:
          - $ref: '#/components/schemas/Filter'
          - example:
              intent-type-list:
                intent-type: uplink-connection
              target: INES-172-31-30-140
              predicate: MATCHES
              required-network-state: active
              order-by: asc.intent-type
              config-required: 'true'
        page-number:
          type: string
        page-size:
          type: string
      example:
        filter:
          intent-type-list:
            intent-type: uplink-connection
          target: INES-172-31-30-140
          predicate: MATCHES
          required-network-state: active
          order-by: asc.intent-type
          config-required: 'true'
        page-number: '0'
        page-size: '10'
    Filter:
      title: Filter
      required:
      - intent-type-list
      - target
      - predicate
      - required-network-state
      - order-by
      - config-required
      type: object
      properties:
        intent-type-list:
          allOf:
          - $ref: '#/components/schemas/IntentTypeList'
          - example:
              intent-type: uplink-connection
        target:
          type: string
        predicate:
          type: string
        required-network-state:
          type: string
        order-by:
          type: string
        config-required:
          type: string
      example:
        intent-type-list:
          intent-type: uplink-connection
        target: INES-172-31-30-140
        predicate: MATCHES
        required-network-state: active
        order-by: asc.intent-type
        config-required: 'true'
    IntentTypeList:
      title: IntentTypeList
      required:
      - intent-type
      type: object
      properties:
        intent-type:
          type: string
      example:
        intent-type: uplink-connection
    Getl2-infraconfigurationRequest:
      title: Getl2-infraconfigurationRequest
      required:
      - ibn:input
      type: object
      properties:
        ibn:input:
          allOf:
          - $ref: '#/components/schemas/IbnInput'
          - example:
              filter:
                intent-type-list:
                  intent-type: uplink-connection
                target: INES-172-31-30-140
                predicate: MATCHES
                required-network-state: active
                order-by: asc.intent-type
                config-required: 'true'
              page-number: '0'
              page-size: '10'
      example:
        ibn:input:
          filter:
            intent-type-list:
              intent-type: l2-infra
            target: INES-172-31-30-140#HSI_Bronze
            predicate: MATCHES
            required-network-state: active
            order-by: asc.intent-type
            config-required: 'true'
          page-number: '0'
          page-size: '10'
    GetfiberconfigurationonefiberinstanceRequest:
      title: GetfiberconfigurationonefiberinstanceRequest
      required:
      - ibn:input
      type: object
      properties:
        ibn:input:
          allOf:
          - $ref: '#/components/schemas/IbnInput'
          - example:
              filter:
                intent-type-list:
                  intent-type: uplink-connection
                target: INES-172-31-30-140
                predicate: MATCHES
                required-network-state: active
                order-by: asc.intent-type
                config-required: 'true'
              page-number: '0'
              page-size: '10'
      example:
        ibn:input:
          filter:
            intent-type-list:
              intent-type: fiber
            target: INES-1-1-4-3
            predicate: MATCHES
            required-network-state: active
            order-by: asc.intent-type
            config-required: 'true'
          page-number: '0'
          page-size: '10'
    GetfiberconfigurationallfiberinstancesRequest:
      title: GetfiberconfigurationallfiberinstancesRequest
      required:
      - ibn:input
      type: object
      properties:
        ibn:input:
          allOf:
          - $ref: '#/components/schemas/IbnInput3'
          - example:
              filter:
                intent-type-list:
                  intent-type: fiber
              page-number: '0'
              page-size: '10'
      example:
        ibn:input:
          filter:
            intent-type-list:
              intent-type: fiber
          page-number: '0'
          page-size: '10'
    IbnInput3:
      title: IbnInput3
      required:
      - filter
      - page-number
      - page-size
      type: object
      properties:
        filter:
          allOf:
          - $ref: '#/components/schemas/Filter3'
          - example:
              intent-type-list:
                intent-type: fiber
        page-number:
          type: string
        page-size:
          type: string
      example:
        filter:
          intent-type-list:
            intent-type: fiber
        page-number: '0'
        page-size: '10'
    Filter3:
      title: Filter3
      required:
      - intent-type-list
      type: object
      properties:
        intent-type-list:
          allOf:
          - $ref: '#/components/schemas/IntentTypeList'
          - example:
              intent-type: uplink-connection
      example:
        intent-type-list:
          intent-type: fiber
    CreateontRequest:
      title: CreateontRequest
      required:
      - ibn:intent
      type: object
      properties:
        ibn:intent:
          allOf:
          - $ref: '#/components/schemas/IbnIntent'
          - example:
              target: INES-1-1-4-3-a
              intent-type: ont
              intent-type-version: '4'
              required-network-state: active
              intent-specific-data:
                ont:ont:
                  ont-type: G-010G-Q
                  fiber-name: INES-1-1-4-3
                  expected-serial-number: ALCLF846403A
                  onu-service-profile: default
                  uni-service-configuration:
                    uni-id: LAN1
                    service-profile: default
      example:
        ibn:intent:
          target: INES-1-1-4-3-a
          intent-type: ont
          intent-type-version: '4'
          required-network-state: active
          intent-specific-data:
            ont:ont:
              ont-type: G-010G-Q
              fiber-name: INES-1-1-4-3
              expected-serial-number: ALCLF846403A
              onu-service-profile: default
              uni-service-configuration:
                uni-id: LAN1
                service-profile: default
    IbnIntent:
      title: IbnIntent
      required:
      - target
      - intent-type
      - intent-type-version
      - required-network-state
      - intent-specific-data
      type: object
      properties:
        target:
          type: string
        intent-type:
          type: string
        intent-type-version:
          type: string
        required-network-state:
          type: string
        intent-specific-data:
          allOf:
          - $ref: '#/components/schemas/IntentSpecificData'
          - example:
              ont:ont:
                ont-type: G-010G-Q
                fiber-name: INES-1-1-4-3
                expected-serial-number: ALCLF846403A
                onu-service-profile: default
                uni-service-configuration:
                  uni-id: LAN1
                  service-profile: default
      example:
        target: INES-1-1-4-3-a
        intent-type: ont
        intent-type-version: '4'
        required-network-state: active
        intent-specific-data:
          ont:ont:
            ont-type: G-010G-Q
            fiber-name: INES-1-1-4-3
            expected-serial-number: ALCLF846403A
            onu-service-profile: default
            uni-service-configuration:
              uni-id: LAN1
              service-profile: default
    IntentSpecificData:
      title: IntentSpecificData
      required:
      - ont:ont
      type: object
      properties:
        ont:ont:
          allOf:
          - $ref: '#/components/schemas/OntOnt'
          - example:
              ont-type: G-010G-Q
              fiber-name: INES-1-1-4-3
              expected-serial-number: ALCLF846403A
              onu-service-profile: default
              uni-service-configuration:
                uni-id: LAN1
                service-profile: default
      example:
        ont:ont:
          ont-type: G-010G-Q
          fiber-name: INES-1-1-4-3
          expected-serial-number: ALCLF846403A
          onu-service-profile: default
          uni-service-configuration:
            uni-id: LAN1
            service-profile: default
    OntOnt:
      title: OntOnt
      required:
      - ont-type
      - fiber-name
      - expected-serial-number
      - onu-service-profile
      - uni-service-configuration
      type: object
      properties:
        ont-type:
          type: string
        fiber-name:
          type: string
        expected-serial-number:
          type: string
        onu-service-profile:
          type: string
        uni-service-configuration:
          allOf:
          - $ref: '#/components/schemas/UniServiceConfiguration'
          - example:
              uni-id: LAN1
              service-profile: default
      example:
        ont-type: G-010G-Q
        fiber-name: INES-1-1-4-3
        expected-serial-number: ALCLF846403A
        onu-service-profile: default
        uni-service-configuration:
          uni-id: LAN1
          service-profile: default
    UniServiceConfiguration:
      title: UniServiceConfiguration
      required:
      - uni-id
      - service-profile
      type: object
      properties:
        uni-id:
          type: string
        service-profile:
          type: string
      example:
        uni-id: LAN1
        service-profile: default
    GetontconfigurationRequest:
      title: GetontconfigurationRequest
      required:
      - ibn:input
      type: object
      properties:
        ibn:input:
          allOf:
          - $ref: '#/components/schemas/IbnInput4'
          - example:
              filter:
                intent-type-list:
                  intent-type: ont
                target: INES-1-1-4-3-a
                predicate: MATCHES
                order-by: asc.intent-type
                config-required: 'true'
              page-number: '0'
              page-size: '10'
      example:
        ibn:input:
          filter:
            intent-type-list:
              intent-type: ont
            target: INES-1-1-4-3-a
            predicate: MATCHES
            order-by: asc.intent-type
            config-required: 'true'
          page-number: '0'
          page-size: '10'
    IbnInput4:
      title: IbnInput4
      required:
      - filter
      - page-number
      - page-size
      type: object
      properties:
        filter:
          allOf:
          - $ref: '#/components/schemas/Filter4'
          - example:
              intent-type-list:
                intent-type: ont
              target: INES-1-1-4-3-a
              predicate: MATCHES
              order-by: asc.intent-type
              config-required: 'true'
        page-number:
          type: string
        page-size:
          type: string
      example:
        filter:
          intent-type-list:
            intent-type: ont
          target: INES-1-1-4-3-a
          predicate: MATCHES
          order-by: asc.intent-type
          config-required: 'true'
        page-number: '0'
        page-size: '10'
    Filter4:
      title: Filter4
      required:
      - intent-type-list
      - target
      - predicate
      - order-by
      - config-required
      type: object
      properties:
        intent-type-list:
          allOf:
          - $ref: '#/components/schemas/IntentTypeList'
          - example:
              intent-type: uplink-connection
        target:
          type: string
        predicate:
          type: string
        order-by:
          type: string
        config-required:
          type: string
      example:
        intent-type-list:
          intent-type: ont
        target: INES-1-1-4-3-a
        predicate: MATCHES
        order-by: asc.intent-type
        config-required: 'true'
    GetallontsthatcontainstringRequest:
      title: GetallontsthatcontainstringRequest
      required:
      - ibn:input
      type: object
      properties:
        ibn:input:
          allOf:
          - $ref: '#/components/schemas/IbnInput'
          - example:
              filter:
                intent-type-list:
                  intent-type: uplink-connection
                target: INES-172-31-30-140
                predicate: MATCHES
                required-network-state: active
                order-by: asc.intent-type
                config-required: 'true'
              page-number: '0'
              page-size: '10'
      example:
        ibn:input:
          filter:
            intent-type-list:
              intent-type: ont
            target: INES-1-1-4-3
            predicate: CONTAINS
            required-network-state: active
            order-by: asc.intent-type
            config-required: 'true'
          page-number: '0'
          page-size: '10'
    SearchESforanontRequest:
      title: SearchESforanontRequest
      required:
      - ibn:input
      type: object
      properties:
        ibn:input:
          allOf:
          - $ref: '#/components/schemas/IbnInput6'
          - example:
              search-from: ES
              filter:
                intent-type-list:
                  intent-type: ont
                  intent-type-version: '4'
                target: INES-1-1-4-3-a
                predicate: MATCHES
                required-network-state: active
                order-by: asc.intent-type
                config-required: 'true'
              page-number: '0'
              page-size: '10'
      example:
        ibn:input:
          search-from: ES
          filter:
            intent-type-list:
              intent-type: ont
              intent-type-version: '4'
            target: INES-1-1-4-3-a
            predicate: MATCHES
            required-network-state: active
            order-by: asc.intent-type
            config-required: 'true'
          page-number: '0'
          page-size: '10'
    IbnInput6:
      title: IbnInput6
      required:
      - search-from
      - filter
      - page-number
      - page-size
      type: object
      properties:
        search-from:
          type: string
        filter:
          allOf:
          - $ref: '#/components/schemas/Filter6'
          - example:
              intent-type-list:
                intent-type: ont
                intent-type-version: '4'
              target: INES-1-1-4-3-a
              predicate: MATCHES
              required-network-state: active
              order-by: asc.intent-type
              config-required: 'true'
        page-number:
          type: string
        page-size:
          type: string
      example:
        search-from: ES
        filter:
          intent-type-list:
            intent-type: ont
            intent-type-version: '4'
          target: INES-1-1-4-3-a
          predicate: MATCHES
          required-network-state: active
          order-by: asc.intent-type
          config-required: 'true'
        page-number: '0'
        page-size: '10'
    Filter6:
      title: Filter6
      required:
      - intent-type-list
      - target
      - predicate
      - required-network-state
      - order-by
      - config-required
      type: object
      properties:
        intent-type-list:
          allOf:
          - $ref: '#/components/schemas/IntentTypeList6'
          - example:
              intent-type: ont
              intent-type-version: '4'
        target:
          type: string
        predicate:
          type: string
        required-network-state:
          type: string
        order-by:
          type: string
        config-required:
          type: string
      example:
        intent-type-list:
          intent-type: ont
          intent-type-version: '4'
        target: INES-1-1-4-3-a
        predicate: MATCHES
        required-network-state: active
        order-by: asc.intent-type
        config-required: 'true'
    IntentTypeList6:
      title: IntentTypeList6
      required:
      - intent-type
      - intent-type-version
      type: object
      properties:
        intent-type:
          type: string
        intent-type-version:
          type: string
      example:
        intent-type: ont
        intent-type-version: '4'
    Createl2-userRequest:
      title: Createl2-userRequest
      required:
      - ibn:intent
      type: object
      properties:
        ibn:intent:
          allOf:
          - $ref: '#/components/schemas/IbnIntent1'
          - example:
              target: HSI_Bronze#INES-1-1-4-3-a
              intent-type: l2-user
              intent-type-version: '4'
              required-network-state: active
              intent-specific-data:
                l2-user:l2-user:
                  service-profile: HSI-100M-10M
                  user-device-name: INES-1-1-4-3-a
                  q-vlan-id: '30'
                  uni-id: LAN1
      example:
        ibn:intent:
          target: HSI_Bronze#INES-1-1-4-3-a
          intent-type: l2-user
          intent-type-version: '4'
          required-network-state: active
          intent-specific-data:
            l2-user:l2-user:
              service-profile: HSI-100M-10M
              user-device-name: INES-1-1-4-3-a
              q-vlan-id: '30'
              uni-id: LAN1
    IbnIntent1:
      title: IbnIntent1
      required:
      - target
      - intent-type
      - intent-type-version
      - required-network-state
      - intent-specific-data
      type: object
      properties:
        target:
          type: string
        intent-type:
          type: string
        intent-type-version:
          type: string
        required-network-state:
          type: string
        intent-specific-data:
          allOf:
          - $ref: '#/components/schemas/IntentSpecificData1'
          - example:
              l2-user:l2-user:
                service-profile: HSI-100M-10M
                user-device-name: INES-1-1-4-3-a
                q-vlan-id: '30'
                uni-id: LAN1
      example:
        target: HSI_Bronze#INES-1-1-4-3-a
        intent-type: l2-user
        intent-type-version: '4'
        required-network-state: active
        intent-specific-data:
          l2-user:l2-user:
            service-profile: HSI-100M-10M
            user-device-name: INES-1-1-4-3-a
            q-vlan-id: '30'
            uni-id: LAN1
    IntentSpecificData1:
      title: IntentSpecificData1
      required:
      - l2-user:l2-user
      type: object
      properties:
        l2-user:l2-user:
          allOf:
          - $ref: '#/components/schemas/L2UserL2User'
          - example:
              service-profile: HSI-100M-10M
              user-device-name: INES-1-1-4-3-a
              q-vlan-id: '30'
              uni-id: LAN1
      example:
        l2-user:l2-user:
          service-profile: HSI-100M-10M
          user-device-name: INES-1-1-4-3-a
          q-vlan-id: '30'
          uni-id: LAN1
    L2UserL2User:
      title: L2UserL2User
      required:
      - service-profile
      - user-device-name
      - q-vlan-id
      - uni-id
      type: object
      properties:
        service-profile:
          type: string
        user-device-name:
          type: string
        q-vlan-id:
          type: string
        uni-id:
          type: string
      example:
        service-profile: HSI-100M-10M
        user-device-name: INES-1-1-4-3-a
        q-vlan-id: '30'
        uni-id: LAN1
    Getl2-userconfigurationRequest:
      title: Getl2-userconfigurationRequest
      required:
      - ibn:input
      type: object
      properties:
        ibn:input:
          allOf:
          - $ref: '#/components/schemas/IbnInput'
          - example:
              filter:
                intent-type-list:
                  intent-type: uplink-connection
                target: INES-172-31-30-140
                predicate: MATCHES
                required-network-state: active
                order-by: asc.intent-type
                config-required: 'true'
              page-number: '0'
              page-size: '10'
      example:
        ibn:input:
          filter:
            intent-type-list:
              intent-type: l2-user
            target: HSI_Bronze#INES-1-1-4-3-a
            predicate: MATCHES
            required-network-state: active
            order-by: asc.intent-type
            config-required: 'true'
          page-number: '0'
          page-size: '10'
    SearchformisalignedintentsRequest:
      title: SearchformisalignedintentsRequest
      required:
      - ibn:input
      type: object
      properties:
        ibn:input:
          allOf:
          - $ref: '#/components/schemas/IbnInput8'
          - example:
              filter:
                aligned: 'false'
              page-number: '0'
              page-size: '10'
      example:
        ibn:input:
          filter:
            aligned: 'false'
          page-number: '0'
          page-size: '10'
    IbnInput8:
      title: IbnInput8
      required:
      - filter
      - page-number
      - page-size
      type: object
      properties:
        filter:
          allOf:
          - $ref: '#/components/schemas/Filter8'
          - example:
              aligned: 'false'
        page-number:
          type: string
        page-size:
          type: string
      example:
        filter:
          aligned: 'false'
        page-number: '0'
        page-size: '10'
    Filter8:
      title: Filter8
      required:
      - aligned
      type: object
      properties:
        aligned:
          type: string
      example:
        aligned: 'false'
    Modifyl2-userRequest:
      title: Modifyl2-userRequest
      required:
      - ibn:intent
      type: object
      properties:
        ibn:intent:
          allOf:
          - $ref: '#/components/schemas/IbnIntent2'
          - example:
              intent-type: l2-user
              intent-type-version: 4
              intent-specific-data:
                l2-user:l2-user:
                  service-profile: HSI-100M-10M-16MAC
      example:
        ibn:intent:
          intent-type: l2-user
          intent-type-version: 4
          intent-specific-data:
            l2-user:l2-user:
              service-profile: HSI-100M-10M-16MAC
    IbnIntent2:
      title: IbnIntent2
      required:
      - intent-type
      - intent-type-version
      - intent-specific-data
      type: object
      properties:
        intent-type:
          type: string
        intent-type-version:
          type: integer
          format: int32
        intent-specific-data:
          allOf:
          - $ref: '#/components/schemas/IntentSpecificData2'
          - example:
              l2-user:l2-user:
                service-profile: HSI-100M-10M-16MAC
      example:
        intent-type: l2-user
        intent-type-version: 4
        intent-specific-data:
          l2-user:l2-user:
            service-profile: HSI-100M-10M-16MAC
    IntentSpecificData2:
      title: IntentSpecificData2
      required:
      - l2-user:l2-user
      type: object
      properties:
        l2-user:l2-user:
          allOf:
          - $ref: '#/components/schemas/L2UserL2User1'
          - example:
              service-profile: HSI-100M-10M-16MAC
      example:
        l2-user:l2-user:
          service-profile: HSI-100M-10M-16MAC
    L2UserL2User1:
      title: L2UserL2User1
      required:
      - service-profile
      type: object
      properties:
        service-profile:
          type: string
      example:
        service-profile: HSI-100M-10M-16MAC
    LockontRequest:
      title: LockontRequest
      required:
      - ibn:intent
      type: object
      properties:
        ibn:intent:
          allOf:
          - $ref: '#/components/schemas/IbnIntent3'
          - example:
              intent-type-version: 4
              required-network-state: suspend
      example:
        ibn:intent:
          intent-type-version: 4
          required-network-state: suspend
    IbnIntent3:
      title: IbnIntent3
      required:
      - intent-type-version
      - required-network-state
      type: object
      properties:
        intent-type-version:
          type: integer
          format: int32
        required-network-state:
          type: string
      example:
        intent-type-version: 4
        required-network-state: suspend
    UnlockontRequest:
      title: UnlockontRequest
      required:
      - ibn:intent
      type: object
      properties:
        ibn:intent:
          allOf:
          - $ref: '#/components/schemas/IbnIntent3'
          - example:
              intent-type-version: 4
              required-network-state: suspend
      example:
        ibn:intent:
          intent-type-version: 4
          required-network-state: active
  securitySchemes:
    httpBasic:
      type: http
      scheme: basic
security:
- httpBasic: []
tags:
- name: Intent