--- false
...
---
swagger: "2.0"
info:
  version: 1.0.0
  title: Api Services Mircor Frontend Ext
  x-ibm-name: api-services-micro-frontend-ext
  description: Extract Api's information from open banking apis to micro front end
    application
  x-bmo-api-type: partner-api
  x-audience: company-internal
  x-bmo-api-provider-id: 26777
  x-api-id: 042d9789-15fb-44d4-ac60-6a9df5405d39
  x-bmoservicedomain-name: operational gateway
  x-api-specification-compliant: true
  x-ibm-summary: ""
basePath: /open-banking/commercial-sb
schemes:
- https
paths:
  /tpp-mf/operational-gateway/get/product/all:
    get:
      x-dataclassification-code: Public
      tags:
      - tpp-mf-operational-api-get-product
      summary: Extract Api's Product information from Commercial portal.
      operationId: extract-api-product-metadata
      description: Extract Api's product data list from Apic.
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        200:
          description: Records retrieves as expected, array of api list returned
          schema:
            $ref: '#/definitions/Product'
          examples:
            example1:
              value:
                page:
                  total: 10
                product:
                - product_name: account-information
                  product_title: Account Information
                  product_version: 1.0.0
                  product_summary: Our Account APIs let you retrieve real-time account
                    and transaction data from all your Online Banking for Business
                    accounts.
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/errorResult'
  /tpp-mf/operational-gateway/get/login/status:
    get:
      x-dataclassification-code: Public
      tags:
      - tpp-mf-operational-api-get-login-info
      summary: Extract User login information from Commercial portal.
      operationId: extract-login-metadata
      description: Extract login data.
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        200:
          description: Records retrieves as expected, array of api list returned
          schema:
            $ref: '#/definitions/UserInfo'
          examples:
            example1:
              value:
                page:
                  total: 10
                UserInfo:
                - info: []
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/errorResult'
  /tpp-mf/operational-gateway/get/api/{PRODUCT-NAME}:
    get:
      x-dataclassification-code: Public
      tags:
      - tpp-mf-operational-api-get-api-info
      summary: Extract Api's api information from Commercial portal.
      operationId: extract-api-metadata
      description: Extract Api's data list from Apic.
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        200:
          description: Records retrieves as expected, array of api list returned
          schema:
            $ref: '#/definitions/Apis'
          examples:
            example1:
              value:
                page:
                  total: 10
                Apis:
                - api-info: []
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/errorResult'
    parameters:
    - name: PRODUCT-NAME
      in: path
      type: string
      required: true
securityDefinitions:
  api-key-1:
    type: apiKey
    description: ""
    in: header
    name: x-api-key
    x-key-type: client_id
security:
- api-key-1: []
definitions:
  errorResult:
    type: object
    required:
    - code
    - status
    properties:
      code:
        type: string
        description: Contains the API response code e.g. 500 etc
        example: "500"
      status:
        type: string
        description: HTTP Status.
        enum:
        - PARTIAL
        - FAILURE
        example: FAILURE
      messages:
        type: string
        description: Short Description of result
  Product:
    title: Api Product List
    description: An array of Api's Product with all meta data attributes.
    allOf:
    - type: object
      properties:
        product:
          type: array
          items:
            $ref: '#/definitions/ProductWithAttributes'
  ProductWithAttributes:
    type: object
    description: An instance of an product with full details.
    allOf:
    - type: object
      properties:
        product_name:
          description: Product Name
          type: string
        product_title:
          description: Product Title
          type: string
        product_version:
          description: Product version information
          type: string
        product_summary:
          description: Product summery information
          type: string
  Apis:
    type: object
    description: An instance of an api with full details.
  UserInfo:
    type: object
    description: An instance of an user for login details.
  PaginatedArray:
    type: object
    description: To be used as a mixin using "allOf"
    properties:
      page:
        $ref: '#/definitions/PageMetadata'
  PageMetadata:
    type: object
    properties:
      total:
        type: integer
        description: Total number of apis
x-ibm-configuration:
  categories:
  - techunit--smartcore--sd--utility
  cors:
    enabled: true
  type: rest
  phase: realized
  enforced: true
  testable: true
  servers:
  - url: https://sandbox-open-api.bmo.com/open-banking/commercial-sb
    type:
    - production
    - development
consumes:
- application/json
produces:
- application/json
host: sandbox-open-api.bmo.com
...
