> ## 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.

# Schema Registry

> Envie, veja e exclua os schemas XSD e os documentos OpenAPI que os workflows do Flowker usam para validar e mapear dados.

A página **Schema Registry** guarda os schemas que os workflows usam para validar e mapear dados. Os workflows validam payloads XML contra schemas XSD. Os documentos OpenAPI descrevem as operações de API externa que os workflows chamam.

## Como acessar a página Schema Registry

***

Para abrir a página **Schema Registry**, clique em **Schema Registry** no menu à esquerda da página **Flowker**.

A página tem duas abas:

* **XSD**: os schemas XSD.
* **APIs Externas**: os documentos OpenAPI.

Para ver os schemas de uma aba, você precisa da permissão `list` no recurso `xsd-schemas` para **XSD** ou no recurso `openapi-schemas` para **APIs Externas**. Para enviar um schema, você precisa de `create` no mesmo recurso. Para excluir um schema, você precisa de `delete`.

## Aba XSD

***

A aba **XSD** lista os seus schemas XSD, com as seguintes colunas:

* **Nome**: o nome do schema.
* **Versão**: a versão do schema.
* **Importações**: o número de schemas que este schema importa.
* **Hash do Conteúdo**: o início do hash do conteúdo do arquivo.
* **Usado por**: o número de configurações de provedor e de workflows que fazem referência ao schema.
* **Criado em**: a data do envio.
* **Ações**: menu de ações.

## Aba APIs Externas

***

A aba **APIs Externas** lista os seus documentos OpenAPI, com as seguintes colunas:

* **Nome**: o nome do documento.
* **Versão**: a versão do documento.
* **Versão OpenAPI**: a versão OpenAPI do documento.
* **Operações**: o número de operações do documento.
* **Usado por**: o número de configurações de provedor e de workflows que fazem referência ao documento.
* **Criado em**: a data do envio.
* **Ações**: menu de ações.

## Como enviar um schema XSD

***

<Steps>
  <Step>
    Na aba **XSD**, clique em **Upload**.
  </Step>

  <Step>
    O formulário **Enviar Schema XSD** abre. Preencha os campos:

    * **Nome**: o nome do schema (por exemplo, `pain.001.001.09`).
    * **Versão**: a versão do schema.
    * **Importações** (opcional): os nomes dos schemas que este schema importa, separados por vírgula.
    * **Arquivo XSD**: um arquivo `.xsd` de no máximo 1 MiB.
  </Step>

  <Step>
    Clique em **Upload**.
  </Step>
</Steps>

## Como enviar um documento OpenAPI

***

<Steps>
  <Step>
    Na aba **APIs Externas**, clique em **Upload**.
  </Step>

  <Step>
    O formulário **Enviar Schema OpenAPI** abre. Preencha os campos:

    * **Nome**: o nome do documento (por exemplo, `orders-api`).
    * **Versão**: a versão do documento.
    * **Arquivo OpenAPI**: um arquivo `.json`, `.yaml` ou `.yml` de no máximo 8 MiB.
  </Step>

  <Step>
    Clique em **Upload**.
  </Step>
</Steps>

Para chamar as operações de um documento enviado a partir de um workflow, veja [Conectar a sua própria API](/pt/products/flowker/connecting-your-own-api).

## Como ver um schema

***

Clique no nome do schema ou selecione **Detalhes** no menu de ações (<Icon icon="ellipsis-vertical" />). O painel **Detalhes do Schema** abre. Você não pode editar um schema nesse painel.

Para um schema XSD, o painel mostra o **Namespace de Destino** e as **Importações**. Para um documento OpenAPI, ele mostra a **Versão OpenAPI** e uma tabela com as operações do documento, com o **Caminho** e o **Método** de cada uma.

A seção **Usado por** lista as configurações de provedor e os workflows que fazem referência ao schema. Cada um mostra o seu status: **Ativo** ou **Desativado**.

## Como excluir um schema

***

<Steps>
  <Step>
    Clique nos três pontos (<Icon icon="ellipsis-vertical" />) na coluna **Ações** e selecione **Excluir**.
  </Step>

  <Step>
    O Console verifica quais configurações de provedor e workflows fazem referência ao schema. A próxima caixa de diálogo depende do resultado:

    * **Nenhuma referência**: uma caixa de diálogo de confirmação abre. Clique em **Confirmar**.
    * **Apenas referências que não estão ativas**: a caixa de diálogo **Excluir o schema mesmo assim?** lista essas referências. Depois de excluir o schema, elas apontam para um schema que não existe. Clique em **Excluir mesmo assim**.
    * **Uma ou mais referências ativas**: a caixa de diálogo **Schema em uso** lista essas referências, e você não pode excluir o schema. Desative as referências ativas ou aponte-as para outro schema e tente de novo.
  </Step>
</Steps>

## Páginas relacionadas

***

<Columns cols={2}>
  <Card title="Adicionar um provedor" icon="plus" horizontal href="/pt/products/flowker/console/adding-a-provider" />

  <Card title="Conectar a sua própria API" icon="plug" horizontal href="/pt/products/flowker/connecting-your-own-api" />
</Columns>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.