openapi: 3.2.0
info:
  title: Boomi Data Integration River Source API
  description: '# Boomi Data Integration API documentation


    Welcome to the Boomi Data Integration API Documentation.'
  contact:
    name: Boomi Data Integration Documentation
    url: https://community.boomi.com/s/support
    email: support@boomi.com
  version: 1.0.0
  x-logo:
    url: https://rivery.io/wp-content/uploads/2021/08/logo.png
servers:
- url: https://api.rivery.io
  description: US
- url: https://api.eu-west-1.rivery.io
  description: EU
tags:
- name: River Source
paths:
  /v1/river_source/metadata:
    get:
      summary: Get Source Metadata
      description: This endpoint gets all source metadata.
      operationId: get_source_metadata
      security:
      - HTTPBearer: []
      parameters:
      - name: source_name
        in: query
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/SourceTypeEnum'
          description: The source name
          examples:
          - shopify
          title: Source Name
        description: The source name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourcedMetadataModelResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - River Source
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    SourcedMetadataModelResponse:
      properties:
        title:
          type: string
          title: Title
          description: The datasource title.
          examples:
          - my title
        description:
          type: string
          title: Description
          description: The datasource description.
          examples:
          - report description
        properties:
          type: object
          title: Properties
          description: The datasource fields and metadata.
        required:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Required
          description: A list of required datasource fields
          examples:
          - - id
      type: object
      required:
      - title
      - description
      - properties
      title: SourcedMetadataModelResponse
      description: The response for the get source metadata.
    SourceTypeEnum:
      type: string
      enum:
      - mysql
      - postgresql
      - oracle
      - mongodb
      - mssql
      - mariadb
      - vertica
      - elasticsearch
      - netsuite_analytics
      - shopify
      - shopify_graphql
      - facebook_ads
      - tiktok
      - blueprint
      - bigquery
      - snowflake
      - redshift
      - boomi_for_sap
      - google_sheets
      - s3
      - salesforce
      - hubspot
      - greenhouse
      - coupa
      - sapconcur
      - successfactors
      - datahub
      - native_connector
      title: SourceTypeEnum
      description: 'The source type enum provide all the source type options.

        Values must match data_source_types.api_name in MongoDB.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
externalDocs:
  description: Find out more about Data Integration
  url: https://help.boomi.com/docs/Atomsphere/Data_Integration/Data_Integration_Overview