Skip to main content
The Schema Registry page stores the schemas that workflows use to validate and map data. Workflows validate XML payloads against XSD schemas. OpenAPI documents describe the external API operations that workflows call.

​
Accessing the Schema Registry page

To open the Schema Registry page, click Schema Registry in the left-side menu on the Flowker page. The page has two tabs:
  • XSD: the XSD schemas.
  • External APIs: the OpenAPI documents.
To see the schemas in a tab, you need the list permission on the xsd-schemas resource for XSD or on the openapi-schemas resource for External APIs. To upload a schema, you need create on the same resource. To delete a schema, you need delete.

​
XSD tab

The XSD tab lists your XSD schemas, with the following columns:
  • Name: the schema name.
  • Version: the schema version.
  • Imports: the number of schemas that this schema imports.
  • Content Hash: the start of the hash of the file content.
  • Used by: the number of provider configurations and workflows that reference the schema.
  • Created At: the upload date.
  • Actions: action menu.

​
External APIs tab

The External APIs tab lists your OpenAPI documents, with the following columns:
  • Name: the document name.
  • Version: the document version.
  • OpenAPI Version: the OpenAPI version of the document.
  • Operations: the number of operations in the document.
  • Used by: the number of provider configurations and workflows that reference the document.
  • Created At: the upload date.
  • Actions: action menu.

​
Uploading an XSD schema

1
On the XSD tab, click Upload.
2
The Upload XSD Schema form opens. Fill in the fields:
  • Name: the schema name (for example, pain.001.001.09).
  • Version: the schema version.
  • Imports (optional): the names of the schemas that this schema imports, separated by commas.
  • XSD File: a .xsd file no larger than 1 MiB.
3
Click Upload.

​
Uploading an OpenAPI document

1
On the External APIs tab, click Upload.
2
The Upload OpenAPI Schema form opens. Fill in the fields:
  • Name: the document name (for example, orders-api).
  • Version: the document version.
  • OpenAPI File: a .json, .yaml, or .yml file no larger than 8 MiB.
3
Click Upload.
To call the operations of an uploaded document from a workflow, see Connecting your own API.

​
Viewing a schema

Click the schema name, or select Details in the action menu (). The Schema Details panel opens. You cannot edit a schema in this panel. For an XSD schema, the panel shows the Target Namespace and the Imports. For an OpenAPI document, it shows the OpenAPI Version and a table of the document operations, with their Path and Method. The Used by section lists the provider configurations and workflows that reference the schema. Each one shows its status: Active or Disabled.

​
Deleting a schema

1
Click the three dots () on the Actions column and select Delete.
2
The Console checks which provider configurations and workflows reference the schema. The next dialog depends on the result:
  • No reference: a confirmation dialog opens. Click Confirm.
  • Only references that are not active: the Delete schema anyway? dialog lists them. After you delete the schema, they point to a schema that does not exist. Click Delete anyway.
  • One or more active references: the Schema in use dialog lists them, and you cannot delete the schema. Deactivate the active references or point them to another schema, then try again.

Add a provider

Connecting your own API