API

An interactive Swagger UI is served by the application itself at /swagger-ui.html. It requires a signed-in session, and "Authorize" there takes an API key, so requests can be tried out from the browser. The same specification is available as JSON at /v3/api-docs and as YAML at /v3/api-docs.yaml, both of which can be imported into Insomnia, Bruno or Postman. Set the environment variable SZ_API_DOCS_ENABLED=false to turn off Swagger UI and the specification endpoints; the API itself keeps working.

• Catalog - /api/v1/catalog

• Glossary - /api/v1/glossary

• Business rules - /api/v1/businessrules

• Test suites - /api/v1/testsuites

• Test cases - /api/v1/testcases

• Profiling - /api/v1/profiling

• Connections - /api/v1/connections

• Executions - /api/v1/executions

• Users - /api/v1/users

• Import - /api/v1/import