> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Validar o esquema de uma conexão

> Valida os identificadores mapeados de fonte de dados, tabela e campo antes do uso de uma conexão.



## OpenAPI

````yaml pt/openapi/v3-current/connections.yaml post /v1/management/connections/validate-schema
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian
    url: https://github.com/LerianStudio/fetcher/discussions
  description: Documentação da API do componente Manager do Fetcher
  license:
    identifier: Elastic-2.0
    name: Elastic License 2.0 (Source Available)
  title: API do Manager do Fetcher
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
tags:
  - description: Ciclo de vida de conexões de banco de dados e operações de esquema.
    name: Connections
  - description: Operações legadas de atribuição de conexões e migração.
    name: Migration
  - description: Operações de criação e consulta de status de jobs de extração de dados.
    name: Fetcher
paths:
  /v1/management/connections/validate-schema:
    post:
      tags:
        - Connections
      summary: Validar o esquema de uma conexão
      description: >-
        Valida os identificadores mapeados de fonte de dados, tabela e campo
        antes do uso de uma conexão.
      operationId: validate-schema
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SchemaValidationRequest'
        description: Mapeamentos de fonte de dados, tabela e campo a serem validados.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaValidationResponse'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Solicitação inválida
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Não autorizado
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Proibido
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Entidade não processável
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro interno do servidor
components:
  schemas:
    SchemaValidationRequest:
      additionalProperties: false
      properties:
        mappedFields:
          additionalProperties:
            additionalProperties:
              items:
                type: string
              type:
                - array
                - 'null'
            type: object
          description: >-
            Mapeia cada nome de configuração da fonte de dados para as tabelas e
            os campos necessários de cada tabela.
          examples:
            - midaz_onboarding:
                accounts:
                  - id
                  - name
          type: object
      required:
        - mappedFields
      type: object
    SchemaValidationResponse:
      additionalProperties: false
      properties:
        errors:
          description: >-
            Falhas de validação, omitidas quando todos os campos solicitados são
            válidos.
          examples:
            - - dataSourceId: midaz_onboarding
                field: external_id
                table: accounts
                type: FIELD_NOT_FOUND
          items:
            $ref: '#/components/schemas/SchemaValidationError'
          type:
            - array
            - 'null'
        message:
          description: Resultado legível da validação do esquema.
          examples:
            - Validação do esquema concluída com sucesso
          type: string
        status:
          description: Resultado da validação do esquema.
          examples:
            - success
          type: string
      required:
        - status
        - message
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina, restrito ao
            serviço emissor (formato: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: Explicação legível específica desta ocorrência do problema.
          examples:
            - A propriedade foo é obrigatória, mas está ausente.
          type: string
        errors:
          description: Lista opcional de detalhes individuais do erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: Referência URI que identifica a ocorrência específica do problema.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: Código de status HTTP
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            Resumo curto e legível do tipo de problema. Esse valor não deve
            mudar entre ocorrências do erro.
          examples:
            - Requisição inválida
          type: string
        type:
          default: about:blank
          description: Referência URI para a documentação legível do erro.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    SchemaValidationError:
      additionalProperties: false
      properties:
        dataSourceId:
          description: Nome da configuração da fonte de dados em que a validação falhou.
          examples:
            - midaz_onboarding
          type: string
        field:
          description: Campo que não pôde ser encontrado, quando aplicável.
          examples:
            - external_id
          type: string
        table:
          description: Tabela ou coleção em que a validação falhou.
          examples:
            - accounts
          type: string
        type:
          description: Tipo de falha de validação legível por máquina.
          examples:
            - FIELD_NOT_FOUND
          type: string
      required:
        - type
        - dataSourceId
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Local em que o erro ocorreu, por exemplo, 'body.items[3].tags' ou
            'path.thing-id'
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: Valor no local indicado
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: Token JWT do tipo bearer emitido pelo provedor de identidade.
      scheme: bearer
      type: http

````