MCP Server for OpenMetadata

{ "openapi" : "3.0.1", "info" : { "title" : "OpenMetadata Apis", "description" : "---\ntitle: APIs\nslug: /main-concepts/metadata-standard/apis\n---\n\n# APIs\n\nOpenMetadata supports REST APIs for getting data and in and out of the metadata service. APIs are built using general\nbest practices of REST API design. We take a schema-first approach by defining Types and Entities in JSON Schema. We\nimplement APIs based on these schemas.\n\n## Overview\n\n### URI\n\nFollowing REST API conventions are followed for Resource URIs:\n- Operations for an entity are available through the Resource URI as a collection `.../api/<version>/entities`. \n- Plural of the entity name is used as the collection name - example `.../api/v1/users`.\n- Trailing forward slash is not used in the endpoint URI. Example use `.../api/v1/databases` instead of `.../api/v1/databases/`.\n- Resource URI for an entity instance by the entity id is `.../api/v1/entities/{id}`. \n- Resource URI for an entity instance by name is `.../api/v1/entities/name/{name}`.\n\n### Resource Representation\n\n- The REST API calls return a response with JSON `Content-Type` and `Content-Length` that includes the length of the response.\n- All responses include the Resource ID field even though the id was provided in the request to simplify the consumption \n of the response at the client.\n- Entity names and field names use `camelCase` per Javascript naming convention.\n- All resources include an attribute `href` with Resource URI. All relationship fields of an entity will also \n include `href` links to the related resource for easy access.\n- Unknown fields sent by the client in API requests are not ignored to ensure the data sent by the client is not dropped \n at the server without the user being aware of it.\n\n## API Organization\n\nYou can find the swagger documentation [here](/swagger.html). In a nutshell:\n\n**Data Asset APIs** - support operations related to data asset entities.\n- `.../api/v1/databases`\n- `...api/v1/tables`\n- `.../api/v1/metrics`\n- `.../api/v1/dashboards`\n- `.../api/v1/reports`\n- `.../api/v1/pipelines`\n- `.../api/v1/topics`\n\n**Service APIs** - support operations related to services from which metadata is collected:\n- `.../api/v1/services` is the collection of all service resources.\n- `.../api/v1/services/databaseService` - APIs related to database services. This includes Transactional databases - MySQL, Postgres, MSSQL, Oracle, and Data Warehouses - Apache Hive BigQuery, Redshift, and Snowflake.\n- `.../api/v1/services/dashboardService` - APIs related to Dashboard Services. This includes Looker, Superset, and Tableau.\n- `.../api/v1/services/messagingService` - APIs related to Messaging Services. This includes Apache Kafka, Redpanda, - Kinesis, and others.\n\n**Teams & Users APIs**\n- `.../api/v1/teams` - APIs related to team entities\n- `.../api/v1/users` - APIs related to user entities\n\n**Search & Suggest APIs** - support search and suggest APIs:\n- `.../api/v1/search` - collection for search and suggest APIs\n- `.../api/v1/search/query` - search entities using query text\n- `.../api/v1/search/suggest` - get suggested entities used for auto-completion\n\n**Other APIs**\n- `.../api/v1/tags` for APIs related to Classification and Tag entities\n- `../api/v1/feeds` for APIs related to Threads and Posts entities\n- `.../api/v1/usage` for reporting usage information of entities", "contact" : { "name" : "OpenMetadata", "url" : "https://open-metadata.org", "email" : "openmetadata-dev@googlegroups.com" }, "license" : { "name" : "Apache 2.0", "url" : "https://www.apache.org/licenses/LICENSE-2.0" }, "version" : "1.6.4" }, "servers" : [ { "url" : "/api", "description" : "Current Host" }, { "url" : "http://localhost:8585/api", "description" : "Endpoint URL" } ], "security" : [ { "BearerAuth" : [ ] } ], "tags" : [ { "name" : "API Collections", "description" : "A `API Collection` is an optional way of grouping API Endpoints that belong to a API Service." }, { "name" : "API Endpoint", "description" : "A `API Endpoint` is a specific endpoint of an API that is part of an API Collection.." }, { "name" : "Apps", "description" : "Apps marketplace holds to application available for Open-metadata" }, { "name" : "Bots", "description" : "A `Bot` automates tasks, such as ingesting metadata, and running data quality It performs this task as a special user in the system." }, { "name" : "Charts", "description" : "A `Chart` are computed from data presents data visually and can be part of `Dashboards`." }, { "name" : "Dashboards", "description" : "Dashboards are computed from data and visually present data, metrics, and KPIs. They are typically updated in real-time and allow interactive data exploration." }, { "name" : "Databases", "description" : "A `Database` also referred to as `Database Catalog` is a collection of schemas." }, { "name" : "Database Schemas", "description" : "A `Database Schema` is collection of tables, views, stored procedures, and other database objects." }, { "name" : "Stored Procedures", "description" : "A `StoredProcedure` entity that contains the set of code statements with an assigned name ." }, { "name" : "Tables", "description" : "`Table` organizes data in rows and columns and is defined in a `Database Schema`." }, { "name" : "Dashboard Data Models", "description" : "`Data Models` are the schemas used to build dashboards, charts, or other data assets." }, { "name" : "Document Store", "description" : "A `Document` is an generic entity in OpenMetadata." }, { "name" : "Domains", "description" : "A `Data Product` or `Data as a Product` is a logical unit that contains all components to process and store domain data for analytical or data-intensive use cases made available to data consumers." }, { "name" : "Test Case Incident Manager", "description" : "APIs to test case incident status from incident manager." }, { "name" : "Test Cases", "description" : "Test case is a test definition to capture data quality tests against tables, columns, and other data assets." }, { "name" : "Test Case Results", "description" : "Test case results are the results of running a test case on a dataset. This resource provides APIs to manage test case results." }, { "name" : "Test Definitions", "description" : "`Test Definition` is a definition of a type of test using which test cases are created that run against data to capture data quality." }, { "name" : "Test Suites", "description" : "`TestSuite` is a set of test cases grouped together to capture data quality." }, { "name" : "Events", "description" : "The `Events` are changes to metadata and are sent when entities are created, modified, or updated. External systems can subscribe to events using event subscription API over Webhooks, Slack, or Microsoft Teams." }, { "name" : "Feeds", "description" : "Feeds API supports `Activity Feeds` and `Conversation Threads`." }, { "name" : "Suggestions", "description" : "Suggestions API supports ability to add suggestion for descriptions or tag labels for Entities." }, { "name" : "Glossaries", "description" : "A `Glossary` is collection of hierarchical `GlossaryTerms`." }, { "name" : "Workflow Definitions", "description" : "A `Workflow Definition` is a configured workflow setup for a given governance task." }, { "name" : "Workflow Instances", "description" : "A Workflow Instance is a specific instance of a Workflow Definition." }, { "name" : "Workflow Instance States", "description" : "A Workflow Instance State is a specific state of a Workflow Instance." }, { "name" : "Lineage", "description" : "The `Lineage` for a given data asset, has information of the input datasets used and the ETL pipeline that created it." }, { "name" : "Metrics", "description" : "`Metrics` are measurements computed from data such as `Monthly Active Users`. Some of the metrics that measures used to determine performance against an objective are called KPIs or Key Performance Indicators, such as `User Retention`." }, { "name" : "ML Models", "description" : "`Machine Learning Models` are algorithms trained on data to find patterns or make predictions." }, { "name" : "Permissions", "description" : "APIs related to getting access permission for a User." }, { "name" : "Pipelines", "description" : "A `Pipeline` enables the flow of data from source to destination through a series of processing steps. ETL is a type of pipeline where the series of steps Extract, Transform and Load the data." }, { "name" : "Policies", "description" : "A `Policy` defines control that needs to be applied across different Data Entities." }, { "name" : "Queries", "description" : "A `Query` entity represents a SQL query associated with data assets it is run against." }, { "name" : "Reports (beta)", "description" : "`Reports` are static information computed from data periodically that includes data in text, table, and visual form." }, { "name" : "Search", "description" : "APIs related to search and suggest." }, { "name" : "SearchIndex", "description" : "A `SearchIndex` is a index mapping for indexing documents in a `Search Service`." }, { "name" : "API Services", "description" : "APIs related `API Service` entities, such as REST or MicroService." }, { "name" : "Database Services", "description" : "`Database Service` is a service such as MySQL, BigQuery, Redshift, Postgres, or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used for database service." }, { "name" : "Ingestion Pipelines", "description" : "APIs related pipelines/workflows created by the system to ingest metadata." }, { "name" : "Metadata Services", "description" : "APIs related to creating and managing other Metadata Services that OpenMetadata integrates with such as `Apache Atlas`, `Amundsen`, etc." }, { "name" : "Search Services", "description" : "APIs related `Search Service` entities, such as ElasticSearch, OpenSearch." }, { "name" : "Object Store Services", "description" : "APIs related `Object Store Service` entities, such as S3, GCS or AZURE." }, { "name" : "Containers", "description" : "A Container is an abstraction for any path(including the top level eg. bucket in S3) storing data in an Object store such as S3, GCP, Azure. It maps a tree-like structure, where each Container can have a parent and a list of sub-folders, and it can be structured - where it contains structured data, or unstructured where no schema for its data is defined." }, { "name" : "Classifications", "description" : "These APIs are related to `Classification` and `Tags`. A `Classification` entity contains hierarchical terms called `Tags` used for categorizing and classifying data assets and other entities." }, { "name" : "Personas", "description" : "A `Persona` is to represent job function a user does. OpenMetadata uses Persona to define customizable experience in the UI." }, { "name" : "Roles", "description" : "A `Role` is a collection of `Policies` that provides access control. A user or a team can be assigned one or multiple roles that provide privileges to a user and members of a team to perform the job function." }, { "name" : "Teams", "description" : "A `Team` is a group of zero or more users and/or other teams. Teams can own zero or more data assets. Hierarchical teams are supported `Organization` -> `BusinessUnit` -> `Division` -> `Department`." }, { "name" : "Users", "description" : "A `User` represents a user of OpenMetadata. A user can be part of 0 or more teams. A special type of user called Bot is used for automation. A user can be an owner of zero or more data assets. A user can also follow zero or more data assets." }, { "name" : "Topics", "description" : "A `Topic` is a feed or an event stream in a `Messaging Service` into which publishers publish messages and consumed by consumers." }, { "name" : "Metadata", "description" : "These APIs are for adding new `Types` to OpenMetadata and use those `Types` to extend the metadata of an entity with custom properties." }, { "name" : "Usage", "description" : "APIs related usage of data assets." }, { "name" : "System", "description" : "APIs related to System configuration and settings." } ], "paths" : { "/v1/apiCollections" : { "get" : { "tags" : [ "API Collections" ], "summary" : "List API Collections", "description" : "Get a list of API Collections, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listAPICollections", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,apiEndpoints,tags,extension,domain,sourceHash" } }, { "name" : "service", "in" : "query", "description" : "Filter APICollection by service name", "schema" : { "type" : "string", "example" : "Users API" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number APICollections returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of API Collections before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of API Collections after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of API Collections", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APICollectionList" } } } } } }, "put" : { "tags" : [ "API Collections" ], "summary" : "Create or update API Collection", "description" : "Create a API Collection, if it does not exist or update an existing API Collection.", "operationId" : "createOrUpdateAPICollection", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateAPICollection" } } } }, "responses" : { "200" : { "description" : "The updated API Collection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APICollection" } } } } } }, "post" : { "tags" : [ "API Collections" ], "summary" : "Create a APICollection", "description" : "Create a APICollection under an existing `service`.", "operationId" : "createAPICollection", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateAPICollection" } } } }, "responses" : { "200" : { "description" : "The API Collection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APICollection" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/apiCollections/name/{fqn}" : { "get" : { "tags" : [ "API Collections" ], "summary" : "Get a APICollection by fully qualified name", "description" : "Get a APICollection by `fullyQualifiedName`.", "operationId" : "getAPICollectionByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the APICollection", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,apiEndpoints,tags,extension,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The APICollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APICollection" } } } }, "404" : { "description" : "APICollection for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "API Collections" ], "summary" : "Delete a API Collection by fully qualified name", "description" : "Delete a API Collection by `fullyQualifiedName`. API Collection can only be deleted if it has no API Endpoints.", "operationId" : "deleteAPICollectionByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the APICollection", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "APIColletion for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "API Collections" ], "summary" : "Update a APICollection by name.", "description" : "Update an existing APICollection using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchAPICollection", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the API Collection", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/apiCollections/restore" : { "put" : { "tags" : [ "API Collections" ], "summary" : "Restore a soft deleted API Collection.", "description" : "Restore a soft deleted API Collection.", "operationId" : "restore", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the API Collection. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APICollection" } } } } } } }, "/v1/apiCollections/{id}" : { "get" : { "tags" : [ "API Collections" ], "summary" : "Get a API Collection by Id", "description" : "Get a API Collection by `Id`.", "operationId" : "getAPICollectionByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the APICollection", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,apiEndpoints,tags,extension,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The API Collection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APICollection" } } } }, "404" : { "description" : "APICollection for instance {id} is not found" } } }, "delete" : { "tags" : [ "API Collections" ], "summary" : "Delete a API Collection by Id", "description" : "Delete a API Collection by `Id`. API Collection can only be deleted if it has no tables.", "operationId" : "deleteAPICollection", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the APICollection", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "API Collection for instance {id} is not found" } } }, "patch" : { "tags" : [ "API Collections" ], "summary" : "Update a API Collection by Id", "description" : "Update an existing API Collection using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchAPICollection_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the API Collection", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/apiCollections/{id}/versions" : { "get" : { "tags" : [ "API Collections" ], "summary" : "List API Collection versions", "description" : "Get a list of all the versions of a API Collection identified by `Id`", "operationId" : "listAllAPICollectionVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the API Collection", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of API Collection versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/apiCollections/{id}/versions/{version}" : { "get" : { "tags" : [ "API Collections" ], "summary" : "Get a version of the APICollection", "description" : "Get a version of the APICollection by given `Id`", "operationId" : "getSpecificAPICollectionVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the APICollection", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "APICollection version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "APICollection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APICollection" } } } }, "404" : { "description" : "APICollection for instance {id} and version {version} is not found" } } } }, "/v1/apiCollections/{id}/vote" : { "put" : { "tags" : [ "API Collections" ], "summary" : "Update Vote for a API Collection", "description" : "Update vote for a API Collection", "operationId" : "updateVoteForAPICollection", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "API Collection for instance {id} is not found" } } } }, "/v1/apiEndpoints" : { "get" : { "tags" : [ "API Endpoint" ], "summary" : "List API Endpoints", "description" : "Get a list of API Endpoints, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listAPIEndpoints", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,tags,extension,domain,dataProducts,sourceHash" } }, { "name" : "service", "in" : "query", "description" : "Filter APIEndpoints by service name", "schema" : { "type" : "string", "example" : "OpenMetadata API Service" } }, { "name" : "apiCollection", "in" : "query", "description" : "Filter APIEndpoints by apiCollection name", "schema" : { "type" : "string", "example" : "UsersAPI" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number APIEndpoints returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of APIEndpoints before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of APIEndpoints after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of API Endpoints", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APIEndpointList" } } } } } }, "put" : { "tags" : [ "API Endpoint" ], "summary" : "Update API Endpoint", "description" : "Create a API Endpoint, it it does not exist or update an existing API Endpoint.", "operationId" : "createOrUpdateAPIEndpoint", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateAPIEndpoint" } } } }, "responses" : { "200" : { "description" : "The updated api endpoint ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APIEndpoint" } } } } } }, "post" : { "tags" : [ "API Endpoint" ], "summary" : "Create a API Endpoint", "description" : "Create a API Endpoint under an existing `service`.", "operationId" : "createAPIEndpoint", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateAPIEndpoint" } } } }, "responses" : { "200" : { "description" : "The API Endpoint", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APIEndpoint" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/apiEndpoints/name/{fqn}" : { "get" : { "tags" : [ "API Endpoint" ], "summary" : "Get a Endpoint by fully qualified name.", "description" : "Get a Endpoint by fully qualified name.", "operationId" : "getEndpointByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the Endpoint", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,tags,extension,domain,dataProducts,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The APIEndpoint", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APIEndpoint" } } } }, "404" : { "description" : "Endpoint for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "API Endpoint" ], "summary" : "Delete a APIEndpoint by fully qualified name", "description" : "Delete a APIEndpoint by `fullyQualifiedName`.", "operationId" : "deleteAPIEndpointByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the APIEndpoint", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "APIEndpoint for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "API Endpoint" ], "summary" : "Update a APIEndpoint using name.", "description" : "Update an existing APIEndpoint using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchAPIEndpoint", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the APIEndpoint", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/apiEndpoints/restore" : { "put" : { "tags" : [ "API Endpoint" ], "summary" : "Restore a soft deleted APIEndpoint", "description" : "Restore a soft deleted APIEndpoint.", "operationId" : "restore_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the APIEndpoint. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APIEndpoint" } } } } } } }, "/v1/apiEndpoints/{id}" : { "get" : { "tags" : [ "API Endpoint" ], "summary" : "Get a APIEndpoint by id", "description" : "Get a APIEndpoint by `id`.", "operationId" : "getEndpointById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the APIEndpoint", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,tags,extension,domain,dataProducts,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The APIEndpoint", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APIEndpoint" } } } }, "404" : { "description" : "APIEndpoint for instance {id} is not found" } } }, "delete" : { "tags" : [ "API Endpoint" ], "summary" : "Delete a APIEndpoint by id", "description" : "Delete a APIEndpoint by `id`.", "operationId" : "deleteAPIEndpoint", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the APIEndpoint", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "APIEndpoint for instance {id} is not found" } } }, "patch" : { "tags" : [ "API Endpoint" ], "summary" : "Update a APIEndpoint", "description" : "Update an existing APIEndpoint using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchAPIEndpoint_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the APIEndpoint", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/apiEndpoints/{id}/followers" : { "put" : { "tags" : [ "API Endpoint" ], "summary" : "Add a follower", "description" : "Add a user identified by `userId` as followed of this APiEndpoint.", "operationId" : "addFollower", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the APIEndpoint", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "Id of the user to be added as follower", "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "uuid" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "APIEndpoint for instance {id} is not found" } } } }, "/v1/apiEndpoints/{id}/followers/{userId}" : { "delete" : { "tags" : [ "API Endpoint" ], "summary" : "Remove a follower", "description" : "Remove the user identified `userId` as a follower of the APIEndpoint.", "operationId" : "deleteFollower", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the APIEndpoint", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed as follower", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } } } } }, "/v1/apiEndpoints/{id}/versions" : { "get" : { "tags" : [ "API Endpoint" ], "summary" : "List API Endpoint versions", "description" : "Get a list of all the versions of a APIEndpoint identified by `id`", "operationId" : "listAllAPIEndpointVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the APIEndpoint", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of APIEndpoint versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/apiEndpoints/{id}/versions/{version}" : { "get" : { "tags" : [ "API Endpoint" ], "summary" : "Get a version of the APIEndpoint", "description" : "Get a version of the APIEndpoint by given `id`", "operationId" : "getSpecificEndpointVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the APIEndpoint", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "APIEndpoint version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "APIEndpoint Version", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APIEndpoint" } } } }, "404" : { "description" : "APIEndpoint for instance {id} and version {version} is not found" } } } }, "/v1/apiEndpoints/{id}/vote" : { "put" : { "tags" : [ "API Endpoint" ], "summary" : "Update Vote for a APIEndpoint", "description" : "Update vote for a APIEndpoint", "operationId" : "updateVoteForAPIEndpoint", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/apps" : { "get" : { "tags" : [ "Apps" ], "summary" : "List installed application", "description" : "Get a list of applications. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listInstalledApplications", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number of installed applications returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of tests before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of tests after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of Installed Applications", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppList" } } } } } }, "put" : { "tags" : [ "Apps" ], "summary" : "Create Or Update App", "description" : "Create or Update App, it it does not exist or update an existing KPI.", "operationId" : "createOrUpdateApp_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateApp" } } } }, "responses" : { "200" : { "description" : "The updated Application Objective ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/App" } } } } } }, "post" : { "tags" : [ "Apps" ], "summary" : "Create a Application", "description" : "Create a application", "operationId" : "createApplication_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateApp" } } } }, "responses" : { "200" : { "description" : "The Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/App" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/apps/configure/{name}" : { "post" : { "tags" : [ "Apps" ], "summary" : "Configure an Application", "description" : "Schedule a application to be run on demand.", "operationId" : "configureApplication", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The Application", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "length" : { "type" : "integer", "format" : "int32" }, "location" : { "type" : "string", "format" : "uri" }, "language" : { "type" : "object", "properties" : { "language" : { "type" : "string" }, "displayName" : { "type" : "string" }, "country" : { "type" : "string" }, "variant" : { "type" : "string" }, "script" : { "type" : "string" }, "unicodeLocaleAttributes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "unicodeLocaleKeys" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "displayLanguage" : { "type" : "string" }, "displayScript" : { "type" : "string" }, "displayCountry" : { "type" : "string" }, "displayVariant" : { "type" : "string" }, "extensionKeys" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "iso3Language" : { "type" : "string" }, "iso3Country" : { "type" : "string" } } }, "date" : { "type" : "string", "format" : "date-time" }, "lastModified" : { "type" : "string", "format" : "date-time" }, "status" : { "type" : "integer", "format" : "int32" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "object" } } }, "entity" : { "type" : "object" }, "mediaType" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "subtype" : { "type" : "string" }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "wildcardType" : { "type" : "boolean" }, "wildcardSubtype" : { "type" : "boolean" } } }, "links" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "params" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "uri" : { "type" : "string", "format" : "uri" }, "uriBuilder" : { "type" : "object" }, "rel" : { "type" : "string" }, "rels" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string" } } } }, "statusInfo" : { "type" : "object", "properties" : { "family" : { "type" : "string", "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] }, "reasonPhrase" : { "type" : "string" }, "statusCode" : { "type" : "integer", "format" : "int32" } } }, "allowedMethods" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "cookies" : { "type" : "object", "additionalProperties" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "value" : { "type" : "string" }, "version" : { "type" : "integer", "format" : "int32" }, "path" : { "type" : "string" }, "domain" : { "type" : "string" }, "comment" : { "type" : "string" }, "maxAge" : { "type" : "integer", "format" : "int32" }, "expiry" : { "type" : "string", "format" : "date-time" }, "secure" : { "type" : "boolean" }, "httpOnly" : { "type" : "boolean" } } } }, "entityTag" : { "type" : "object", "properties" : { "value" : { "type" : "string" }, "weak" : { "type" : "boolean" } } }, "stringHeaders" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "headers" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "object" } } } } } } } }, "404" : { "description" : "Application for instance {id} is not found" } } } }, "/v1/apps/deploy/{name}" : { "post" : { "tags" : [ "Apps" ], "summary" : "Deploy App to Quartz or Ingestion", "description" : "Deploy App to Quartz or Ingestion.", "operationId" : "deployApplicationToQuartzOrIngestion", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Application trigger status code", "content" : { "application/json" : { } } }, "404" : { "description" : "Application for instance {id} is not found" } } } }, "/v1/apps/marketplace" : { "get" : { "tags" : [ "Apps" ], "summary" : "List application", "description" : "Get a list of applications. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listApplications", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tags" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number of installed applications returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of tests before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of tests after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of KPIs", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppMarketPlaceDefinitionList" } } } } } }, "put" : { "tags" : [ "Apps" ], "summary" : "Create Or Update App", "description" : "Create or Update App, it it does not exist or update an existing KPI.", "operationId" : "createOrUpdateApp", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateAppMarketPlaceDefinitionReq" } } } }, "responses" : { "200" : { "description" : "The updated Application Objective ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/App" } } } } } }, "post" : { "tags" : [ "Apps" ], "summary" : "Create a Application", "description" : "Create a application", "operationId" : "createApplication", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateAppMarketPlaceDefinitionReq" } } } }, "responses" : { "200" : { "description" : "The Application", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppMarketPlaceDefinition" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/apps/marketplace/name/{fqn}" : { "patch" : { "tags" : [ "Apps" ], "summary" : "Updates an App by name.", "description" : "Update an existing App using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchApplication", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/apps/marketplace/name/{name}" : { "get" : { "tags" : [ "Apps" ], "summary" : "Get a App by name", "description" : "Get a App by `name`.", "operationId" : "getAppByName", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tags" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The App", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppMarketPlaceDefinition" } } } }, "404" : { "description" : "App for instance {name} is not found" } } }, "delete" : { "tags" : [ "Apps" ], "summary" : "Delete a App by name", "description" : "Delete a App by `name`.", "operationId" : "deleteAppByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "App for instance {name} is not found" } } } }, "/v1/apps/marketplace/restore" : { "put" : { "tags" : [ "Apps" ], "summary" : "Restore a soft deleted KPI", "description" : "Restore a soft deleted App.", "operationId" : "restore_2", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the App. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppMarketPlaceDefinition" } } } } } } }, "/v1/apps/marketplace/{id}" : { "get" : { "tags" : [ "Apps" ], "summary" : "Get a app by Id", "description" : "Get a app by `Id`.", "operationId" : "get", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the App", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tags" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The App", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppMarketPlaceDefinition" } } } }, "404" : { "description" : "App for instance {id} is not found" } } }, "delete" : { "tags" : [ "Apps" ], "summary" : "Delete a App by Id", "description" : "Delete a App by `Id`.", "operationId" : "deleteApp", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the App", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "App for instance {id} is not found" } } }, "patch" : { "tags" : [ "Apps" ], "summary" : "Updates a App", "description" : "Update an existing App using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchApplication_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the App", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/apps/marketplace/{id}/versions" : { "get" : { "tags" : [ "Apps" ], "summary" : "List Installed Application versions", "description" : "Get a list of all the versions of a application identified by `id`", "operationId" : "listAllInstalledApplications", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the app", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of installed application versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/apps/marketplace/{id}/versions/{version}" : { "get" : { "tags" : [ "Apps" ], "summary" : "Get a version of the App", "description" : "Get a version of the App by given `id`", "operationId" : "getSpecificAppVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the App", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "KPI version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "App", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/App" } } } }, "404" : { "description" : "App for instance {id} and version {version} is not found" } } } }, "/v1/apps/name/{fqn}" : { "patch" : { "tags" : [ "Apps" ], "summary" : "Updates a App by name.", "description" : "Update an existing App using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchApplication_2", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/apps/name/{name}" : { "get" : { "tags" : [ "Apps" ], "summary" : "Get a App by name", "description" : "Get a App by `name`.", "operationId" : "getAppByName_1", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The App", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/App" } } } }, "404" : { "description" : "App for instance {name} is not found" } } }, "delete" : { "tags" : [ "Apps" ], "summary" : "Delete a App by name", "description" : "Delete a App by `name`.", "operationId" : "uninstallAppByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "description" : "System entity {name} of type SystemApp can not be deleted." }, "404" : { "description" : "App for instance {name} is not found" } } } }, "/v1/apps/name/{name}/extension" : { "get" : { "tags" : [ "Apps" ], "summary" : "List App Extension data", "description" : "Get a list of applications Extension data. Use cursor-based pagination to limit the number entries in the list using `offset` query params.", "operationId" : "listAppExtension", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Limit records. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "offset", "in" : "query", "description" : "Offset records. (0 to 1000000, default = 0)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "startTs", "in" : "query", "description" : "Filter pipeline status after the given start timestamp", "schema" : { "type" : "number" } }, { "name" : "extensionType", "in" : "query", "description" : "Get the extension type", "schema" : { "type" : "string" } }, { "name" : "byName", "in" : "query", "description" : "List extensions by name instead of id", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "List of Installed Applications Runs", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppExtension" } } } } } } }, "/v1/apps/name/{name}/logs" : { "get" : { "tags" : [ "Apps" ], "summary" : "Retrieve all logs from last ingestion pipeline run for the application", "description" : "Get all logs from last ingestion pipeline run by `Id`.", "operationId" : "getLastLogs", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns log chunk after this cursor", "schema" : { "type" : "string", "default" : "" } } ], "responses" : { "200" : { "description" : "JSON object with the task instance name of the ingestion on each key and log in the value", "content" : { "application/json" : { } } }, "404" : { "description" : "Logs for instance {id} is not found" } } } }, "/v1/apps/name/{name}/runs/latest" : { "get" : { "tags" : [ "Apps" ], "summary" : "Get Latest App Run Record", "description" : "Get a latest applications Run Record.", "operationId" : "latestAppRunRecord", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns log chunk after this cursor", "schema" : { "type" : "string", "default" : "" } } ], "responses" : { "200" : { "description" : "List of Installed Applications Runs", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppRunRecord" } } } } } } }, "/v1/apps/name/{name}/status" : { "get" : { "tags" : [ "Apps" ], "summary" : "List App Run Records", "description" : "Get a list of applications Run Record. Use cursor-based pagination to limit the number entries in the list using `offset` query params.", "operationId" : "listAppRunRecords", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Limit records. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "offset", "in" : "query", "description" : "Offset records. (0 to 1000000, default = 0)", "schema" : { "maximum" : 1000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "startTs", "in" : "query", "description" : "Filter pipeline status after the given start timestamp", "schema" : { "type" : "number" } }, { "name" : "endTs", "in" : "query", "description" : "Filter pipeline status before the given end timestamp", "schema" : { "type" : "number" } } ], "responses" : { "200" : { "description" : "List of Installed Applications Runs", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppRunList" } } } } } } }, "/v1/apps/restore" : { "put" : { "tags" : [ "Apps" ], "summary" : "Restore a soft deleted KPI", "description" : "Restore a soft deleted App.", "operationId" : "restore_3", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the App. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/App" } } } } } } }, "/v1/apps/schedule/{name}" : { "post" : { "tags" : [ "Apps" ], "summary" : "Schedule an Application", "description" : "Schedule a application to be run on demand.", "operationId" : "scheduleApplication", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The Application", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "length" : { "type" : "integer", "format" : "int32" }, "location" : { "type" : "string", "format" : "uri" }, "language" : { "type" : "object", "properties" : { "language" : { "type" : "string" }, "displayName" : { "type" : "string" }, "country" : { "type" : "string" }, "variant" : { "type" : "string" }, "script" : { "type" : "string" }, "unicodeLocaleAttributes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "unicodeLocaleKeys" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "displayLanguage" : { "type" : "string" }, "displayScript" : { "type" : "string" }, "displayCountry" : { "type" : "string" }, "displayVariant" : { "type" : "string" }, "extensionKeys" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "iso3Language" : { "type" : "string" }, "iso3Country" : { "type" : "string" } } }, "date" : { "type" : "string", "format" : "date-time" }, "lastModified" : { "type" : "string", "format" : "date-time" }, "status" : { "type" : "integer", "format" : "int32" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "object" } } }, "entity" : { "type" : "object" }, "mediaType" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "subtype" : { "type" : "string" }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "wildcardType" : { "type" : "boolean" }, "wildcardSubtype" : { "type" : "boolean" } } }, "links" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "params" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "uri" : { "type" : "string", "format" : "uri" }, "uriBuilder" : { "type" : "object" }, "rel" : { "type" : "string" }, "rels" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string" } } } }, "statusInfo" : { "type" : "object", "properties" : { "family" : { "type" : "string", "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] }, "reasonPhrase" : { "type" : "string" }, "statusCode" : { "type" : "integer", "format" : "int32" } } }, "allowedMethods" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "cookies" : { "type" : "object", "additionalProperties" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "value" : { "type" : "string" }, "version" : { "type" : "integer", "format" : "int32" }, "path" : { "type" : "string" }, "domain" : { "type" : "string" }, "comment" : { "type" : "string" }, "maxAge" : { "type" : "integer", "format" : "int32" }, "expiry" : { "type" : "string", "format" : "date-time" }, "secure" : { "type" : "boolean" }, "httpOnly" : { "type" : "boolean" } } } }, "entityTag" : { "type" : "object", "properties" : { "value" : { "type" : "string" }, "weak" : { "type" : "boolean" } } }, "stringHeaders" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "headers" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "object" } } } } } } } }, "404" : { "description" : "Application for instance {id} is not found" } } } }, "/v1/apps/stop/{name}" : { "post" : { "tags" : [ "Apps" ], "summary" : "Stop a Application run", "description" : "Stop a application run by name.", "operationId" : "stopApplicationRun", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Application stopped status code", "content" : { "application/json" : { } } }, "404" : { "description" : "Application for instance {id} is not found" } } } }, "/v1/apps/trigger/{name}" : { "post" : { "tags" : [ "Apps" ], "summary" : "Trigger an Application run", "description" : "Trigger a Application run by name.", "operationId" : "triggerApplicationRun", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the App", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Application trigger status code", "content" : { "application/json" : { } } }, "404" : { "description" : "Application for instance {id} is not found" } } } }, "/v1/apps/{id}" : { "get" : { "tags" : [ "Apps" ], "summary" : "Get a app by Id", "description" : "Get a app by `Id`.", "operationId" : "get_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the App", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The App", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/App" } } } }, "404" : { "description" : "App for instance {id} is not found" } } }, "delete" : { "tags" : [ "Apps" ], "summary" : "Delete a App by Id", "description" : "Delete a App by `Id`.", "operationId" : "uninstallAppByName_1", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the App", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "description" : "System entity {name} of type SystemApp can not be deleted." }, "404" : { "description" : "App for instance {id} is not found" } } }, "patch" : { "tags" : [ "Apps" ], "summary" : "Updates a App", "description" : "Update an existing App using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchApplication_3", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the App", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/apps/{id}/versions" : { "get" : { "tags" : [ "Apps" ], "summary" : "List Installed Application versions", "description" : "Get a list of all the versions of a application identified by `id`", "operationId" : "listAllInstalledApplications_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the app", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of installed application versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/apps/{id}/versions/{version}" : { "get" : { "tags" : [ "Apps" ], "summary" : "Get a version of the App", "description" : "Get a version of the App by given `id`", "operationId" : "getSpecificAppVersion_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the App", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "App version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "App", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/App" } } } }, "404" : { "description" : "App for instance {id} and version {version} is not found" } } } }, "/v1/bots" : { "get" : { "tags" : [ "Bots" ], "summary" : "List bots", "description" : "Get a list of Bot.", "operationId" : "listBots", "parameters" : [ { "name" : "limit", "in" : "query", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of Bot before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of Bot after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of Bot", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BotList" } } } } } }, "put" : { "tags" : [ "Bots" ], "summary" : "Create or update a bot", "description" : "Create a bot, if it does not exist. If a bot already exists, update the bot.", "operationId" : "createOrUpdateBot", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateBot" } } } }, "responses" : { "200" : { "description" : "The bot", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Bot" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Bots" ], "summary" : "Create a bot", "description" : "Create a new bot.", "operationId" : "createBot", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateBot" } } } }, "responses" : { "200" : { "description" : "The bot ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Bot" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/bots/name/{fqn}" : { "patch" : { "tags" : [ "Bots" ], "summary" : "Update a bot by name.", "description" : "Update an existing bot using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchBot", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the bot", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/bots/name/{name}" : { "get" : { "tags" : [ "Bots" ], "summary" : "Get a bot by name", "description" : "Get a bot by `name`.", "operationId" : "getBotByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the bot", "required" : true, "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "bot", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Bot" } } } }, "404" : { "description" : "Bot for instance {name} is not found" } } }, "delete" : { "tags" : [ "Bots" ], "summary" : "Delete a bot by name", "description" : "Delete a bot by `name`.", "operationId" : "deleteBotByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the bot", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Bot for instance {name} is not found" } } } }, "/v1/bots/restore" : { "put" : { "tags" : [ "Bots" ], "summary" : "Restore a soft deleted bot", "description" : "Restore a soft deleted bot.", "operationId" : "restore_4", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Bot ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Bot" } } } } } } }, "/v1/bots/{id}" : { "get" : { "tags" : [ "Bots" ], "summary" : "Get a bot by Id", "description" : "Get a bot by `Id`.", "operationId" : "getBotByID", "parameters" : [ { "name" : "include", "in" : "query", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } }, { "name" : "id", "in" : "path", "description" : "Id of the bot", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "The bot", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Bot" } } } }, "404" : { "description" : "Bot for instance {id} is not found" } } }, "delete" : { "tags" : [ "Bots" ], "summary" : "Delete a bot by Id", "description" : "Delete a bot by `Id`.", "operationId" : "deleteBot", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the bot", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Bot for instance {id} is not found" } } }, "patch" : { "tags" : [ "Bots" ], "summary" : "Update a bot", "description" : "Update an existing bot using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchBot_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the bot", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/bots/{id}/versions" : { "get" : { "tags" : [ "Bots" ], "summary" : "List bot versions", "description" : "Get a list of all the versions of a bot identified by `Id`", "operationId" : "listAllBotVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the bot", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of bot versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/bots/{id}/versions/{version}" : { "get" : { "tags" : [ "Bots" ], "summary" : "Get a version of the bot", "description" : "Get a version of the bot by given `Id`", "operationId" : "listSpecificBotVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the bot", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "bot version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "bot", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Bot" } } } }, "404" : { "description" : "Bot for instance {id} and version {version} is not found" } } } }, "/v1/charts" : { "get" : { "tags" : [ "Charts" ], "summary" : "List charts", "description" : "Get a list of charts, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listCharts", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,tags,domain,dataProducts,sourceHash,dashboards" } }, { "name" : "service", "in" : "query", "description" : "Filter charts by service name", "schema" : { "type" : "string", "example" : "superset" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number charts returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of charts before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of charts after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of charts", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChartList" } } } } } }, "put" : { "tags" : [ "Charts" ], "summary" : "Create or update chart", "description" : "Create a chart, it it does not exist or update an existing chart.", "operationId" : "createOrUpdateChart", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateChart" } } } }, "responses" : { "200" : { "description" : "The updated chart ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Chart" } } } } } }, "post" : { "tags" : [ "Charts" ], "summary" : "Create a chart", "description" : "Create a chart under an existing `service`.", "operationId" : "createChart", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateChart" } } } }, "responses" : { "200" : { "description" : "The chart", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Chart" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/charts/name/{fqn}" : { "get" : { "tags" : [ "Charts" ], "summary" : "Get a chart by fully qualified name", "description" : "Get a chart by `fullyQualifiedName`.", "operationId" : "getChartByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the chart", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,tags,domain,dataProducts,sourceHash,dashboards" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The chart", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Chart" } } } }, "404" : { "description" : "Chart for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Charts" ], "summary" : "Delete a chart by fully qualified name", "description" : "Delete a chart by `fullyQualifiedName`.", "operationId" : "deleteChartByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the chart", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Chart for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Charts" ], "summary" : "Update a chart by name.", "description" : "Update an existing chart using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchChart", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the chart", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/charts/restore" : { "put" : { "tags" : [ "Charts" ], "summary" : "Restore a soft deleted chart", "description" : "Restore a soft deleted chart.", "operationId" : "restore_5", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Chart ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Chart" } } } } } } }, "/v1/charts/{id}" : { "get" : { "tags" : [ "Charts" ], "summary" : "Get a chart by Id", "description" : "Get a chart by `Id`.", "operationId" : "getChartByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the chart", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,tags,domain,dataProducts,sourceHash,dashboards" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The chart", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Chart" } } } }, "404" : { "description" : "Chart for instance {id} is not found" } } }, "delete" : { "tags" : [ "Charts" ], "summary" : "Delete a chart by Id", "description" : "Delete a chart by `Id`.", "operationId" : "deleteChart", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the chart", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Chart for instance {id} is not found" } } }, "patch" : { "tags" : [ "Charts" ], "summary" : "Update a chart", "description" : "Update an existing chart using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchChart_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the chart", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/charts/{id}/followers" : { "put" : { "tags" : [ "Charts" ], "summary" : "Add a follower", "description" : "Add a user identified by `userId` as followed of this chart", "operationId" : "addFollowerToChart", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the chart", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "Id of the user to be added as follower", "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "uuid" } } } }, "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Chart for instance {id} is not found" } } } }, "/v1/charts/{id}/followers/{userId}" : { "delete" : { "tags" : [ "Charts" ], "summary" : "Remove a follower", "description" : "Remove the user identified `userId` as a follower of the chart.", "operationId" : "deleteFollowerFromChart", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the chart", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed as follower", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/charts/{id}/versions" : { "get" : { "tags" : [ "Charts" ], "summary" : "List chart versions", "description" : "Get a list of all the versions of a chart identified by `id`", "operationId" : "listAllChartVersions", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the chart", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of chart versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/charts/{id}/versions/{version}" : { "get" : { "tags" : [ "Charts" ], "summary" : "Get a version of the chart", "description" : "Get a version of the chart by given `Id`", "operationId" : "getSpecificChartVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the chart", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Chart version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "chart", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Chart" } } } }, "404" : { "description" : "Chart for instance {id} and version {version} is not found" } } } }, "/v1/charts/{id}/vote" : { "put" : { "tags" : [ "Charts" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/classifications" : { "get" : { "tags" : [ "Classifications" ], "summary" : "List classifications", "description" : "Get a list of classifications.", "operationId" : "listClassifications", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "usageCount,termCount" } }, { "name" : "disabled", "in" : "query", "description" : "Filter Disabled Classifications", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number classifications returned. (1 to 1000000, default = 10) ", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of classifications before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of classifications after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ClassificationList" } } } } } }, "put" : { "tags" : [ "Classifications" ], "summary" : "Update a classification", "description" : "Update an existing category identify by category name", "operationId" : "createOrUpdateClassification", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateClassification" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "post" : { "tags" : [ "Classifications" ], "summary" : "Create a classification", "description" : "Create a new classification. The request can include the children tags to be created along with the classification.", "operationId" : "createClassification", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateClassification" } } } }, "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Classification" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/classifications/name/{fqn}" : { "patch" : { "tags" : [ "Classifications" ], "summary" : "Update a classification using name.", "description" : "Update an existing classification using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchClassification", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the classification", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/classifications/name/{name}" : { "get" : { "tags" : [ "Classifications" ], "summary" : "Get a classification by name", "description" : "Get a classification identified by name. The response includes classification information along with the entire hierarchy of all the children tags.", "operationId" : "getClassificationByName", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the classification", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "usageCount,termCount" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Classification" } } } }, "404" : { "description" : "Classification for instance {name} is not found" } } }, "delete" : { "tags" : [ "Classifications" ], "summary" : "Delete classification by name", "description" : "Delete a classification by `name` and all the tags under it.", "operationId" : "deleteClassificationByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the classification", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "classification for instance {name} is not found" } } } }, "/v1/classifications/restore" : { "put" : { "tags" : [ "Classifications" ], "summary" : "Restore a soft deleted classification", "description" : "Restore a soft deleted classification.", "operationId" : "restoreClassification", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Table ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Classification" } } } } } } }, "/v1/classifications/{id}" : { "get" : { "tags" : [ "Classifications" ], "summary" : "Get a classification by id", "description" : "Get a classification by `id`", "operationId" : "getClassificationByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the classification", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "usageCount,termCount" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "classification", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Classification" } } } }, "404" : { "description" : "Classification for instance {id} is not found" } } }, "delete" : { "tags" : [ "Classifications" ], "summary" : "Delete classification by id", "description" : "Delete a classification and all the tags under it.", "operationId" : "deleteClassification", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the classification", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "patch" : { "tags" : [ "Classifications" ], "summary" : "Update a classification", "description" : "Update an existing classification using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchClassification_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the classification", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/classifications/{id}/versions" : { "get" : { "tags" : [ "Classifications" ], "summary" : "List classification versions", "description" : "Get a list of all the versions of a classification identified by `id`", "operationId" : "listAllClassificationVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the classification", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of classification versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/classifications/{id}/versions/{version}" : { "get" : { "tags" : [ "Classifications" ], "summary" : "Get a version of the classification", "description" : "Get a version of the classification by given `id`", "operationId" : "getSpecificClassificationVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the classification", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "classification version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "glossaries", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Classification" } } } }, "404" : { "description" : "Classification for instance {id} and version {version} is not found" } } } }, "/v1/containers" : { "get" : { "tags" : [ "Containers" ], "summary" : "List Containers", "description" : "Get a list of containers, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listContainers", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "parent,children,dataModel,owners,tags,followers,extension,domain,sourceHash" } }, { "name" : "service", "in" : "query", "description" : "Filter Containers by Object Store Service name", "schema" : { "type" : "string", "example" : "s3West" } }, { "name" : "root", "in" : "query", "description" : "Filter by Containers at the root level. E.g., without parent", "schema" : { "type" : "boolean", "example" : true, "default" : false } }, { "name" : "limit", "in" : "query", "description" : "Limit the number containers returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of containers before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of containers after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of containers", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContainerList" } } } } } }, "put" : { "tags" : [ "Containers" ], "summary" : "Create or update a Container", "description" : "Create a new Container, if it does not exist or update an existing container.", "operationId" : "createOrUpdateContainer", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateContainer" } } } }, "responses" : { "200" : { "description" : "The Container", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Container" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Containers" ], "summary" : "Create a Container", "description" : "Create a new Container.", "operationId" : "createContainer", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateContainer" } } } }, "responses" : { "200" : { "description" : "Container", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Container" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/containers/name/{fqn}" : { "get" : { "tags" : [ "Containers" ], "summary" : "Get an Container by name", "description" : "Get an Container by fully qualified name.", "operationId" : "getContainerByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "parent,children,dataModel,owners,tags,followers,extension,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The container", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Container" } } } }, "404" : { "description" : "Container for instance {id} is not found" } } }, "delete" : { "tags" : [ "Containers" ], "summary" : "Delete a Container by fully qualified name", "description" : "Delete a Container by `fullyQualifiedName`.", "operationId" : "deleteContainerByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Name of the Container", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "container for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Containers" ], "summary" : "Update a Container using name.", "description" : "Update an existing Container using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchContainer", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the Container", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/containers/restore" : { "put" : { "tags" : [ "Containers" ], "summary" : "Restore a soft deleted Container.", "description" : "Restore a soft deleted Container.", "operationId" : "restore_34", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Container ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Container" } } } } } } }, "/v1/containers/{id}" : { "get" : { "tags" : [ "Containers" ], "summary" : "Get an Object Store Container", "description" : "Get an Object Store container by `id`.", "operationId" : "getContainerByID", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "parent,children,dataModel,owners,tags,followers,extension,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The container", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Container" } } } }, "404" : { "description" : "Container for instance {id} is not found" } } }, "delete" : { "tags" : [ "Containers" ], "summary" : "Delete a Container", "description" : "Delete a Container by `id`.", "operationId" : "deleteContainer", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Container Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "container for instance {id} is not found" } } }, "patch" : { "tags" : [ "Containers" ], "summary" : "Update a Container", "description" : "Update an existing Container using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchContainer_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Container", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/containers/{id}/followers" : { "put" : { "tags" : [ "Containers" ], "summary" : "Add a follower", "description" : "Add a user identified by `userId` as follower of this container", "operationId" : "addFollower_7", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the container", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "Id of the user to be added as follower", "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "uuid" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "container for instance {id} is not found" } } } }, "/v1/containers/{id}/followers/{userId}" : { "delete" : { "tags" : [ "Containers" ], "summary" : "Remove a follower", "description" : "Remove the user identified `userId` as a follower of the container.", "operationId" : "deleteFollower_8", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the container", "required" : true, "schema" : { "type" : "string" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed as follower", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } } } } }, "/v1/containers/{id}/versions" : { "get" : { "tags" : [ "Containers" ], "summary" : "List Container versions", "description" : "Get a list of all the versions of a container identified by `id`", "operationId" : "listAllContainerVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Container Id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of Container versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/containers/{id}/versions/{version}" : { "get" : { "tags" : [ "Containers" ], "summary" : "Get a version of the Container", "description" : "Get a version of the Container by given `id`", "operationId" : "getSpecificContainerVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Container Id", "required" : true, "schema" : { "type" : "string" } }, { "name" : "version", "in" : "path", "description" : "Container version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "Container", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Container" } } } }, "404" : { "description" : "Container for instance {id} and version {version} is not found" } } } }, "/v1/containers/{id}/vote" : { "put" : { "tags" : [ "Containers" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_14", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/dashboard/datamodels" : { "get" : { "tags" : [ "Dashboard Data Models" ], "summary" : "List Dashboard Data Models", "description" : "Get a list of dashboard datamodels, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listDashboardDataModels", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tags,followers,domain,sourceHash,extension" } }, { "name" : "service", "in" : "query", "description" : "Filter dashboardDataModel by service name", "schema" : { "type" : "string", "example" : "superset" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number dashboardDataModel returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of dashboardDataModel before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of dashboardDataModel after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of dashboard datamodels", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardDataModelList" } } } } } }, "put" : { "tags" : [ "Dashboard Data Models" ], "summary" : "Create or update dashboard datamodel", "description" : "Create a dashboard datamodel, it it does not exist or update an existing dashboard datamodel.", "operationId" : "createOrUpdateDataModel", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDashboardDataModel" } } } }, "responses" : { "200" : { "description" : "The updated dashboard datamodel", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardDataModel" } } } } } }, "post" : { "tags" : [ "Dashboard Data Models" ], "summary" : "Create a dashboard datamodel", "description" : "Create a dashboard datamodel under an existing `service`.", "operationId" : "createDataModel", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDashboardDataModel" } } } }, "responses" : { "200" : { "description" : "The dashboard datamodel", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardDataModel" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/dashboard/datamodels/name/{fqn}" : { "get" : { "tags" : [ "Dashboard Data Models" ], "summary" : "Get a dashboard datamodel by fully qualified name", "description" : "Get a dashboard datamodel by `fullyQualifiedName`.", "operationId" : "getDataModelByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the dashboard datamodel", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tags,followers,domain,sourceHash,extension" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The dashboard datamodel", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardDataModel" } } } }, "404" : { "description" : "DataModel for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Dashboard Data Models" ], "summary" : "Delete a data model by fully qualified name.", "description" : "Delete a data model by `fullyQualifiedName`.", "operationId" : "deleteDataModelByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the data model", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "DataModel for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Dashboard Data Models" ], "summary" : "Update a dashboard datamodel by name.", "description" : "Update an existing dashboard datamodel using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDataModel", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the dashboard datamodel", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dashboard/datamodels/restore" : { "put" : { "tags" : [ "Dashboard Data Models" ], "summary" : "Restore a soft deleted data model.", "description" : "Restore a soft deleted data model.", "operationId" : "restore_11", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the data model", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardDataModel" } } } } } } }, "/v1/dashboard/datamodels/{id}" : { "get" : { "tags" : [ "Dashboard Data Models" ], "summary" : "Get a dashboard datamodel by Id", "description" : "Get a dashboard datamodel by `id`.", "operationId" : "getDataModelByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard datamodel", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tags,followers,domain,sourceHash,extension" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The dashboard datamodel", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardDataModel" } } } }, "404" : { "description" : "DataModel for instance {id} is not found" } } }, "delete" : { "tags" : [ "Dashboard Data Models" ], "summary" : "Delete a data model by `id`.", "description" : "Delete a dashboard datamodel by `id`.", "operationId" : "deleteDataModel", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the data model", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "DataModel for instance {id} is not found" } } }, "patch" : { "tags" : [ "Dashboard Data Models" ], "summary" : "Update a dashboard datamodel", "description" : "Update an existing dashboard datamodel using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDataModel_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard datamodel", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dashboard/datamodels/{id}/followers" : { "put" : { "tags" : [ "Dashboard Data Models" ], "summary" : "Add a follower", "description" : "Add a user identified by `userId` as followed of this data model", "operationId" : "addFollowerToDataModel", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the data model", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "Id of the user to be added as follower", "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "uuid" } } } }, "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "DataModel for instance {id} is not found" } } } }, "/v1/dashboard/datamodels/{id}/followers/{userId}" : { "delete" : { "tags" : [ "Dashboard Data Models" ], "summary" : "Remove a follower", "description" : "Remove the user identified `userId` as a follower of the data model.", "operationId" : "deleteFollowerFromDataModel", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the data model", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed as follower", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dashboard/datamodels/{id}/versions" : { "get" : { "tags" : [ "Dashboard Data Models" ], "summary" : "List dashboard datamodel versions", "description" : "Get a list of all the versions of a dashboard datamodel identified by `id`", "operationId" : "listAllDataModelVersions", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard datamodel", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of dashboard datamodel versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/dashboard/datamodels/{id}/versions/{version}" : { "get" : { "tags" : [ "Dashboard Data Models" ], "summary" : "Get a version of the dashboard datamodel", "description" : "Get a version of the dashboard datamodel by given `id`", "operationId" : "getSpecificDataModelVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard datamodel", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "DataModel version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "dashboard datamodel", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardDataModel" } } } }, "404" : { "description" : "DataModel for instance {id} and version {version} is not found" } } } }, "/v1/dashboard/datamodels/{id}/vote" : { "put" : { "tags" : [ "Dashboard Data Models" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_6", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/dashboards" : { "get" : { "tags" : [ "Dashboards" ], "summary" : "List dashboards", "description" : "Get a list of dashboards, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listDashboards", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,charts,followers,tags,usageSummary,extension,dataModels,domain,dataProducts,sourceHash" } }, { "name" : "service", "in" : "query", "description" : "Filter dashboards by service name", "schema" : { "type" : "string", "example" : "superset" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number dashboards returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of dashboards before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of dashboards after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of dashboards", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardList" } } } } } }, "put" : { "tags" : [ "Dashboards" ], "summary" : "Create or update a dashboard", "description" : "Create a new dashboard, if it does not exist or update an existing dashboard.", "operationId" : "createOrUpdateDashboard", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDashboard" } } } }, "responses" : { "200" : { "description" : "The dashboard", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Dashboard" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Dashboards" ], "summary" : "Create a dashboard", "description" : "Create a new dashboard.", "operationId" : "createDashboard", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDashboard" } } } }, "responses" : { "200" : { "description" : "The dashboard", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Dashboard" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/dashboards/name/{fqn}" : { "get" : { "tags" : [ "Dashboards" ], "summary" : "Get a dashboard by fully qualified name", "description" : "Get a dashboard by fully qualified name.", "operationId" : "getDashboardByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the dashboard", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,charts,followers,tags,usageSummary,extension,dataModels,domain,dataProducts,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The dashboard", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Dashboard" } } } }, "404" : { "description" : "Dashboard for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Dashboards" ], "summary" : "Delete a dashboard by fully qualified name", "description" : "Delete a dashboard by `fullyQualifiedName`.", "operationId" : "deleteDashboardByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the dashboard", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Dashboard for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Dashboards" ], "summary" : "Update a dashboard by name.", "description" : "Update an existing dashboard using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDashboard", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the dashboard", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dashboards/restore" : { "put" : { "tags" : [ "Dashboards" ], "summary" : "Restore a soft deleted dashboard", "description" : "Restore a soft deleted dashboard.", "operationId" : "restore_6", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Dashboard.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Dashboard" } } } } } } }, "/v1/dashboards/{id}" : { "get" : { "tags" : [ "Dashboards" ], "summary" : "Get a dashboard by Id", "description" : "Get a dashboard by `Id`.", "operationId" : "getDashboardByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,charts,followers,tags,usageSummary,extension,dataModels,domain,dataProducts,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The dashboard", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Dashboard" } } } }, "404" : { "description" : "Dashboard for instance {id} is not found" } } }, "delete" : { "tags" : [ "Dashboards" ], "summary" : "Delete a dashboard by Id", "description" : "Delete a dashboard by `Id`.", "operationId" : "deleteDashboard", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the dashboard", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Dashboard for instance {id} is not found" } } }, "patch" : { "tags" : [ "Dashboards" ], "summary" : "Update a dashboard", "description" : "Update an existing dashboard using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDashboard_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dashboards/{id}/followers" : { "put" : { "tags" : [ "Dashboards" ], "summary" : "Add a follower", "description" : "Add a user identified by `userId` as follower of this dashboard", "operationId" : "addFollowerToDashboard", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "Id of the user to be added as follower", "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "uuid" } } } }, "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Dashboard for instance {id} is not found" } } } }, "/v1/dashboards/{id}/followers/{userId}" : { "delete" : { "tags" : [ "Dashboards" ], "summary" : "Remove a follower", "description" : "Remove the user identified `userId` as a follower of the dashboard.", "operationId" : "removeFollowerFromDashboard", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed as follower", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dashboards/{id}/versions" : { "get" : { "tags" : [ "Dashboards" ], "summary" : "List dashboard versions", "description" : "Get a list of all the versions of a dashboard identified by `Id`", "operationId" : "listAllDashboardVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of dashboard versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/dashboards/{id}/versions/{version}" : { "get" : { "tags" : [ "Dashboards" ], "summary" : "Get a version of the dashboard", "description" : "Get a version of the dashboard by given `id`", "operationId" : "getSpecificDashboardVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Dashboard version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "dashboard", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Dashboard" } } } }, "404" : { "description" : "Dashboard for instance {id} and version {version} is not found" } } } }, "/v1/dashboards/{id}/vote" : { "put" : { "tags" : [ "Dashboards" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/dataProducts" : { "get" : { "tags" : [ "Domains" ], "summary" : "List dataProducts", "description" : "Get a list of DataProducts.", "operationId" : "listDataProducts", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "domain,owners,experts,assets,extension" } }, { "name" : "domain", "in" : "query", "description" : "Filter data products by domain name", "schema" : { "type" : "string", "example" : "marketing" } }, { "name" : "limit", "in" : "query", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of DataProduct before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of DataProduct after this cursor", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of DataProducts", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DataProductList" } } } } } }, "put" : { "tags" : [ "Domains" ], "summary" : "Create or update a dataProduct", "description" : "Create a dataProduct. if it does not exist. If a dataProduct already exists, update the dataProduct.", "operationId" : "createOrUpdateDataProduct", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDataProduct" } } } }, "responses" : { "200" : { "description" : "The dataProduct", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DataProduct" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Domains" ], "summary" : "Create a dataProduct", "description" : "Create a new dataProduct.", "operationId" : "createDataProduct", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDataProduct" } } } }, "responses" : { "200" : { "description" : "The dataProduct ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DataProduct" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/dataProducts/name/{fqn}" : { "patch" : { "tags" : [ "Domains" ], "summary" : "Update a dataProduct by name.", "description" : "Update an existing dataProduct using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDataProduct", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the dataProduct", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dataProducts/name/{name}" : { "get" : { "tags" : [ "Domains" ], "summary" : "Get a dataProduct by name", "description" : "Get a dataProduct by `name`.", "operationId" : "getDataProductByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the dataProduct", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "domain,owners,experts,assets,extension" } } ], "responses" : { "200" : { "description" : "dataProduct", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DataProduct" } } } }, "404" : { "description" : "DataProduct for instance {name} is not found" } } }, "delete" : { "tags" : [ "Domains" ], "summary" : "Delete a dataProduct by name", "description" : "Delete a dataProduct by `name`.", "operationId" : "deleteDataProductByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the dataProduct", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "DataProduct for instance {name} is not found" } } } }, "/v1/dataProducts/{id}" : { "get" : { "tags" : [ "Domains" ], "summary" : "Get a dataProduct by Id", "description" : "Get a dataProduct by `Id`.", "operationId" : "getDataProductByID", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "domain,owners,experts,assets,extension" } }, { "name" : "id", "in" : "path", "description" : "Id of the dataProduct", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "The dataProduct", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DataProduct" } } } }, "404" : { "description" : "DataProduct for instance {id} is not found" } } }, "delete" : { "tags" : [ "Domains" ], "summary" : "Delete a dataProduct by Id", "description" : "Delete a dataProduct by `Id`.", "operationId" : "deleteDataProduct", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dataProduct", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "DataProduct for instance {id} is not found" } } }, "patch" : { "tags" : [ "Domains" ], "summary" : "Update a dataProduct", "description" : "Update an existing dataProduct using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDataProduct_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dataProduct", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dataProducts/{id}/versions" : { "get" : { "tags" : [ "Domains" ], "summary" : "List dataProduct versions", "description" : "Get a list of all the versions of a dataProduct identified by `Id`", "operationId" : "listAllDataProductVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dataProduct", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of dataProduct versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/dataProducts/{id}/versions/{version}" : { "get" : { "tags" : [ "Domains" ], "summary" : "Get a version of the dataProduct", "description" : "Get a version of the dataProduct by given `Id`", "operationId" : "listSpecificDataProductVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dataProduct", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "DataProduct version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "dataProduct", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DataProduct" } } } }, "404" : { "description" : "DataProduct for instance {id} and version {version} is not found" } } } }, "/v1/dataProducts/{name}/assets/add" : { "put" : { "tags" : [ "Domains" ], "summary" : "Bulk Add Assets", "description" : "Bulk Add Assets", "operationId" : "bulkAddAssets", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Data product", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkAssets" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkOperationResult" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/dataProducts/{name}/assets/remove" : { "put" : { "tags" : [ "Domains" ], "summary" : "Bulk Remove Assets", "description" : "Bulk Remove Assets", "operationId" : "bulkRemoveAssets", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Data Product", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkAssets" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/dataQuality/testCases" : { "get" : { "tags" : [ "Test Cases" ], "summary" : "List test cases", "description" : "Get a list of test. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.Use the `testSuite` field to get the Basic Test Suite linked to this test case or use the `testSuites` field to list test suites (Basic and Logical) linked.", "operationId" : "listTestCases", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,testSuite,testDefinition,testSuites,incidentId,domain,tags" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number tests returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of tests before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of tests after this cursor", "schema" : { "type" : "string" } }, { "name" : "entityLink", "in" : "query", "description" : "Return list of tests by entity link", "schema" : { "type" : "string", "example" : "<E#/{entityType}/{entityFQN}/{fieldName}>" } }, { "name" : "testSuiteId", "in" : "query", "description" : "Returns list of tests filtered by the testSuite id", "schema" : { "type" : "string" } }, { "name" : "includeAllTests", "in" : "query", "description" : "Include all the tests at the entity level", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } }, { "name" : "testCaseStatus", "in" : "query", "description" : "Filter test case by status", "schema" : { "type" : "string", "enum" : [ "Success", "Failed", "Aborted", "Queued" ] } }, { "name" : "testCaseType", "in" : "query", "description" : "Filter for test case type (e.g. column, table, all", "schema" : { "type" : "string", "default" : "all", "enum" : [ "column", "table", "all" ] } } ], "responses" : { "200" : { "description" : "List of test definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCaseList" } } } } } }, "put" : { "tags" : [ "Test Cases" ], "summary" : "Update test case", "description" : "Create a TestCase, it it does not exist or update an existing TestCase.", "operationId" : "createOrUpdateTest", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTestCase" } } } }, "responses" : { "200" : { "description" : "The updated testCase.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCase" } } } } } }, "post" : { "tags" : [ "Test Cases" ], "summary" : "Create a test case", "description" : "Create a test case", "operationId" : "createTestCase", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTestCase" } } } }, "responses" : { "200" : { "description" : "The test", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCase" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/dataQuality/testCases/logicalTestCases" : { "put" : { "tags" : [ "Test Cases" ], "summary" : "Add test cases to a logical test suite", "description" : "Add test cases to a logical test suite.", "operationId" : "addTestCasesToLogicalTestSuite", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateLogicalTestCases" } } } }, "responses" : { "200" : { "description" : "Successfully added test cases to the logical test suite.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSuite" } } } } } } }, "/v1/dataQuality/testCases/logicalTestCases/{testSuiteId}/{id}" : { "delete" : { "tags" : [ "Test Cases" ], "summary" : "Delete a logical test case by Id from a test suite", "description" : "Delete a logical test case by `Id` a test suite.", "operationId" : "deleteLogicalTestCase", "parameters" : [ { "name" : "testSuiteId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Logical test case for instance {id} is not found" } } } }, "/v1/dataQuality/testCases/name/{fqn}" : { "get" : { "tags" : [ "Test Cases" ], "summary" : "Get a test case by fully qualified name", "description" : "Get a test case by `fullyQualifiedName`.", "operationId" : "getTestCaseByName", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the test case", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,testSuite,testDefinition,testSuites,incidentId,domain,tags" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The TestCase", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCase" } } } }, "404" : { "description" : "Test for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Test Cases" ], "summary" : "Delete a test case by fully qualified name", "description" : "Delete a testCase by `fullyQualifiedName`.", "operationId" : "deleteTestCaseByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the test case", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "TestCase for instance {fqn} is not found" } } } }, "/v1/dataQuality/testCases/restore" : { "put" : { "tags" : [ "Test Cases" ], "summary" : "Restore a soft deleted test case", "description" : "Restore a soft deleted test case.", "operationId" : "restore_12", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Chart ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCase" } } } } } } }, "/v1/dataQuality/testCases/search/list" : { "get" : { "tags" : [ "Test Cases" ], "summary" : "List test cases using search service", "description" : "Get a list of test cases using the search service. Use `fields` parameter to get only necessary fields. Use offset/limit pagination to limit the number entries in the list using `limit` and `offset` query params.Use the `testSuite` field to get the Basic Test Suite linked to this test case or use the `testSuites` field to list test suites (Basic and Logical) linked.", "operationId" : "listTestCasesFromSearchService", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,testSuite,testDefinition,testSuites,incidentId,domain,tags" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number tests returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "offset", "in" : "query", "description" : "Returns list of tests after this offset", "schema" : { "type" : "string", "default" : "0" } }, { "name" : "entityLink", "in" : "query", "description" : "Return list of tests by entity link", "schema" : { "type" : "string", "example" : "<E#/{entityType}/{entityFQN}/{fieldName}>" } }, { "name" : "testSuiteId", "in" : "query", "description" : "Returns list of tests filtered by a testSuite id", "schema" : { "type" : "string" } }, { "name" : "includeAllTests", "in" : "query", "description" : "Include all the tests at the entity level", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } }, { "name" : "testCaseStatus", "in" : "query", "description" : "Filter test case by status", "schema" : { "type" : "string", "enum" : [ "Success", "Failed", "Aborted", "Queued" ] } }, { "name" : "testCaseType", "in" : "query", "description" : "Filter for test case type (e.g. column, table, all)", "schema" : { "type" : "string", "default" : "all", "enum" : [ "column", "table", "all" ] } }, { "name" : "testPlatforms", "in" : "query", "description" : "Filter for test case by source (e.g. OpenMetadata, dbt, etc.)", "schema" : { "type" : "string" } }, { "name" : "dataQualityDimension", "in" : "query", "description" : "Filter for test case by data quality dimension (e.g. OpenMetadata, dbt, etc.)", "schema" : { "type" : "string" } }, { "name" : "startTimestamp", "in" : "query", "description" : "Parameter used to filter (inclusive) the test cases by the last execution timestamp (in milliseconds). Must be used in conjunction with `endTimestamp`", "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "endTimestamp", "in" : "query", "description" : "Parameter used to filter (inclusive) the test cases by the last execution timestamp (in milliseconds). Must be used in conjunction with `startTimestamp`", "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "sortField", "in" : "query", "description" : "Field used to sort the test cases listing", "schema" : { "type" : "string" } }, { "name" : "sortNestedPath", "in" : "query", "description" : "Set this field if your mapping is nested and you want to sort on a nested field", "schema" : { "type" : "string" } }, { "name" : "sortNestedMode", "in" : "query", "description" : "Set this field if your mapping is nested and you want to sort on a nested field", "schema" : { "type" : "string", "example" : "min,max,avg,sum,median" } }, { "name" : "sortType", "in" : "query", "description" : "Sort type", "schema" : { "type" : "string", "default" : "desc", "enum" : [ "asc", "desc" ] } }, { "name" : "includeFields", "in" : "query", "description" : "Return only required fields in the response", "schema" : { "type" : "string" } }, { "name" : "domain", "in" : "query", "description" : "domain filter to use in list", "schema" : { "type" : "string" } }, { "name" : "owner", "in" : "query", "description" : "owner filter to use in list", "schema" : { "type" : "string" } }, { "name" : "tags", "in" : "query", "description" : "tags filter to use in list", "schema" : { "type" : "string" } }, { "name" : "tier", "in" : "query", "description" : "tier filter to use in list", "schema" : { "type" : "string" } }, { "name" : "serviceName", "in" : "query", "description" : "service filter to use in list", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "description" : "search query term to use in list", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of test cases", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCaseList" } } } } } } }, "/v1/dataQuality/testCases/testCaseIncidentStatus" : { "get" : { "tags" : [ "Test Case Incident Manager" ], "summary" : "List the test case failure statuses", "description" : "Get a list of all the test case failure statuses, optionally filtered by `startTs` and `endTs` of the status creation, status, assignee, and test case id. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.", "operationId" : "getTestCaseResolutionStatus", "parameters" : [ { "name" : "testCaseId", "in" : "query", "description" : "Test Case ID", "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number tests returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "offset", "in" : "query", "description" : "Returns list of tests at the offset", "schema" : { "type" : "string" } }, { "name" : "startTs", "in" : "query", "description" : "Filter test case statuses after the given start timestamp", "schema" : { "type" : "number" } }, { "name" : "endTs", "in" : "query", "description" : "Filter test case statuses before the given end timestamp", "schema" : { "type" : "number" } }, { "name" : "testCaseResolutionStatusType", "in" : "query", "description" : "Filter test case statuses by status", "schema" : { "type" : "string", "enum" : [ "New", "Ack", "Assigned", "Resolved" ] } }, { "name" : "latest", "in" : "query", "description" : "Only list the latest statuses", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "assignee", "in" : "query", "description" : "Filter test case statuses by assignee", "schema" : { "type" : "string" } }, { "name" : "testCaseFQN", "in" : "query", "description" : "Test case fully qualified name", "schema" : { "type" : "string" } }, { "name" : "originEntityFQN", "in" : "query", "description" : "Origin entity for which the incident was opened for", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of test case statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCaseResolutionStatusResultList" } } } } } }, "post" : { "tags" : [ "Test Case Incident Manager" ], "summary" : "Create a new test case failure status", "description" : "Create a new test case failure status", "operationId" : "createTestCaseResolutionStatus", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTestCaseResolutionStatus" } } } }, "responses" : { "200" : { "description" : "The created test case failure status", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTestCaseResolutionStatus" } } } } } } }, "/v1/dataQuality/testCases/testCaseIncidentStatus/stateId/{stateId}" : { "get" : { "tags" : [ "Test Case Incident Manager" ], "summary" : "Get test case failure statuses for a sequence id", "description" : "Get a test case failure statuses for a sequence id", "operationId" : "getTestCaseResolutionStatusesForAStateId", "parameters" : [ { "name" : "stateId", "in" : "path", "description" : "Sequence ID", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "The test case failure status", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCaseResolutionStatus" } } } } } } }, "/v1/dataQuality/testCases/testCaseIncidentStatus/{id}" : { "get" : { "tags" : [ "Test Case Incident Manager" ], "summary" : "Get test case failure status by id", "description" : "Get a test case failure status by id", "operationId" : "getTestCaseResolutionStatusById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Test Case Failure Status ID", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "The test case failure status", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCaseResolutionStatus" } } } } } }, "patch" : { "tags" : [ "Test Case Incident Manager" ], "summary" : "Update an existing test case failure status", "description" : "Update an existing test case failure status", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "updateTestCaseResolutionStatus", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test case result status", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations. Only `updateAt` and `updatedBy` fields can be patched.", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dataQuality/testCases/testCaseResults/search/latest" : { "get" : { "tags" : [ "Test Case Results" ], "summary" : "Latest test case results using search service", "description" : "Get latest test case results from the search service. Use `testCaseFQN` to filter the results by test case fully qualified name. Use `testCaseStatus` to filter the results by test case status. Use `fields` to get only necessary fields. ", "operationId" : "latestTestCaseResultsFromSearchService", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "testCase,testDefinition" } }, { "name" : "testCaseStatus", "in" : "query", "description" : "Status of the test case -- one of Success, Failed, Aborted, Queued", "schema" : { "type" : "string", "enum" : [ "Success", "Failed", "Aborted", "Queued" ] } }, { "name" : "testCaseFQN", "in" : "query", "description" : "FullyQualifiedName of the test case", "schema" : { "type" : "string" } }, { "name" : "testSuiteId", "in" : "query", "description" : "FullyQualifiedName of the test case", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "description" : "search query term to use in list", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of test case results", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCaseResultList" } } } } } } }, "/v1/dataQuality/testCases/testCaseResults/search/list" : { "get" : { "tags" : [ "Test Case Results" ], "summary" : "List test case results using search service", "description" : "List test case results from the search service. Use `startTimestamp` and `endTimestamp` to filter the results by timestamp. Use `testCaseFQN` to filter the results by test case fully qualified name. Use `testCaseStatus` to filter the results by test case status. Use `fields` to get only necessary fields. ", "operationId" : "listTestCaseResultsFromSearchService", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "testCase,testDefinition" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number tests case results returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "offset", "in" : "query", "description" : "Returns list of tests after this offset", "schema" : { "type" : "string", "default" : "0" } }, { "name" : "startTimestamp", "in" : "query", "description" : "Start timestamp to list test case from", "schema" : { "type" : "number" } }, { "name" : "endTimestamp", "in" : "query", "description" : "End timestamp to list test case from", "schema" : { "type" : "number" } }, { "name" : "testCaseStatus", "in" : "query", "description" : "Status of the test case -- one of Success, Failed, Aborted, Queued", "schema" : { "type" : "string", "enum" : [ "Success", "Failed", "Aborted", "Queued" ] } }, { "name" : "testCaseFQN", "in" : "query", "description" : "FullyQualifiedName of the test case", "schema" : { "type" : "string" } }, { "name" : "testSuiteId", "in" : "query", "description" : "Test Suite Id the test case belongs to", "schema" : { "type" : "string" } }, { "name" : "entityFQN", "in" : "query", "description" : "Entity FQN the test case belongs to", "schema" : { "type" : "string" } }, { "name" : "latest", "in" : "query", "description" : "Get the latest test case result for each test case -- requires `testSuiteId`. Offset and limit are ignored", "schema" : { "type" : "boolean", "example" : false, "default" : false, "enum" : [ true, false ] } }, { "name" : "testCaseType", "in" : "query", "description" : "Filter for test case result by type (e.g. column, table, all)", "schema" : { "type" : "string", "example" : "all", "default" : "all", "enum" : [ "column", "table", "all" ] } }, { "name" : "dataQualityDimension", "in" : "query", "description" : "Filter for test case by data quality dimension (e.g. OpenMetadata, dbt, etc.)", "schema" : { "type" : "string", "enum" : [ "Completeness", "Accuracy", "Consistency", "Validity", "Uniqueness", "Integrity", "SQL" ] } }, { "name" : "q", "in" : "query", "description" : "search query term to use in list", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of test case results", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCaseResultList" } } } } } } }, "/v1/dataQuality/testCases/testCaseResults/{fqn}" : { "get" : { "tags" : [ "Test Case Results" ], "summary" : "List of test case results for a given test case", "description" : "Get a list of all the test case results for the given testCase FQN, optionally filtered by `startTimestamp` and `endTimestamp`. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listTestCaseResults_1", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the test case", "required" : true, "schema" : { "type" : "string" } }, { "name" : "startTs", "in" : "query", "description" : "Filter testCase results after the given start timestamp", "schema" : { "type" : "number" } }, { "name" : "endTs", "in" : "query", "description" : "Filter testCase results before the given end timestamp", "schema" : { "type" : "number" } } ], "responses" : { "200" : { "description" : "List of testCase results", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCaseResultList" } } } } } }, "post" : { "tags" : [ "Test Case Results" ], "summary" : "Add test case result data to a testCase", "description" : "Add test case result data to the testCase.", "operationId" : "addTestCaseResult_1", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the test case", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTestCaseResult" } } } }, "responses" : { "200" : { "description" : "Successfully created the TestCase. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCaseResult" } } } } } } }, "/v1/dataQuality/testCases/testCaseResults/{fqn}/{timestamp}" : { "delete" : { "tags" : [ "Test Case Results" ], "summary" : "Delete test case result", "description" : "Delete testCase result for a testCase.", "operationId" : "DeleteTestCaseResult_1", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the test case", "required" : true, "schema" : { "type" : "string" } }, { "name" : "timestamp", "in" : "path", "description" : "Timestamp of the testCase result", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Successfully deleted the TestCaseResult", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCase" } } } } } }, "patch" : { "tags" : [ "Test Case Results" ], "summary" : "Update a test case result", "description" : "Update an existing test case using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchTestCaseResult_1", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "fqn of the test case", "required" : true, "schema" : { "type" : "string" } }, { "name" : "timestamp", "in" : "path", "description" : "Timestamp of the testCase result", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dataQuality/testCases/{fqn}/testCaseResult" : { "get" : { "tags" : [ "Test Cases" ], "summary" : "List of test case results", "description" : "Get a list of all the test case results for the given testCase id, optionally filtered by `startTs` and `endTs` of the profile. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listTestCaseResults", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the test case", "required" : true, "schema" : { "type" : "string" } }, { "name" : "startTs", "in" : "query", "description" : "Filter testCase results after the given start timestamp", "schema" : { "type" : "number" } }, { "name" : "endTs", "in" : "query", "description" : "Filter testCase results before the given end timestamp", "schema" : { "type" : "number" } } ], "responses" : { "200" : { "description" : "List of testCase results", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCaseResultList" } } } } } }, "put" : { "tags" : [ "Test Cases" ], "summary" : "Add test case result data", "description" : "Add test case result data to the testCase.", "operationId" : "addTestCaseResult", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the test case", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCaseResult" } } } }, "responses" : { "200" : { "description" : "Successfully updated the TestCase. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCase" } } } } } } }, "/v1/dataQuality/testCases/{fqn}/testCaseResult/{timestamp}" : { "delete" : { "tags" : [ "Test Cases" ], "summary" : "Delete test case result", "description" : "Delete testCase result for a testCase.", "operationId" : "DeleteTestCaseResult", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the test case", "required" : true, "schema" : { "type" : "string" } }, { "name" : "timestamp", "in" : "path", "description" : "Timestamp of the testCase result", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Successfully deleted the TestCaseResult", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCase" } } } } } }, "patch" : { "tags" : [ "Test Cases" ], "summary" : "Update a test case result", "description" : "Update an existing test case using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchTestCaseResult", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "fqn of the test case", "required" : true, "schema" : { "type" : "string" } }, { "name" : "timestamp", "in" : "path", "description" : "Timestamp of the testCase result", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dataQuality/testCases/{id}" : { "get" : { "tags" : [ "Test Cases" ], "summary" : "Get a test case by Id", "description" : "Get a TestCase by `Id`.", "operationId" : "get_3", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test case", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,testSuite,testDefinition,testSuites,incidentId,domain,tags" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The TestCases", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCase" } } } }, "404" : { "description" : "Test for instance {id} is not found" } } }, "delete" : { "tags" : [ "Test Cases" ], "summary" : "Delete a test case by Id", "description" : "Delete a test case by `Id`.", "operationId" : "deleteTestCase", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the test case", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Test case for instance {id} is not found" } } }, "patch" : { "tags" : [ "Test Cases" ], "summary" : "Update a test case", "description" : "Update an existing test using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchTest", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test case", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dataQuality/testCases/{id}/failedRowsSample" : { "get" : { "tags" : [ "Test Cases" ], "summary" : "Get failed rows sample data", "description" : "Get a sample of failed rows for this test case.", "operationId" : "getFailedRowsSample", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Successfully retrieved the test case with failed rows sample data.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TableData" } } } } } }, "put" : { "tags" : [ "Test Cases" ], "summary" : "Add failed rows sample data", "description" : "Add a sample of failed rows for this test case.", "operationId" : "addFailedRowsSample", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test case", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "validate", "in" : "query", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TableData" } } } }, "responses" : { "200" : { "description" : "Successfully update the test case with failed rows sample data.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCase" } } } }, "400" : { "description" : "Failed rows can only be added to a failed test case." } } }, "delete" : { "tags" : [ "Test Cases" ], "summary" : "Delete failed rows sample data", "description" : "Delete a sample of failed rows for this test case.", "operationId" : "deleteFailedRowsSample", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Failed rows sample data for test case {id} is not found." } } } }, "/v1/dataQuality/testCases/{id}/inspectionQuery" : { "put" : { "tags" : [ "Test Cases" ], "summary" : "Add inspection query data", "description" : "Add an inspection query for this test case.", "operationId" : "addInspectionQuery", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test case", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Successfully update the test case with an inspection query.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCase" } } } } } } }, "/v1/dataQuality/testCases/{id}/versions" : { "get" : { "tags" : [ "Test Cases" ], "summary" : "List test case versions", "description" : "Get a list of all the versions of a testCases identified by `Id`", "operationId" : "listAllTestCaseVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test case", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of test versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/dataQuality/testCases/{id}/versions/{version}" : { "get" : { "tags" : [ "Test Cases" ], "summary" : "Get a version of the test case", "description" : "Get a version of the test case by given `Id`", "operationId" : "getSpecificTestCaseVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test case", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Test version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "Test", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestCase" } } } }, "404" : { "description" : "Test for instance {id} and version {version} is not found" } } } }, "/v1/dataQuality/testDefinitions" : { "get" : { "tags" : [ "Test Definitions" ], "summary" : "List test definitions", "description" : "Get a list of test definitions, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listTestDefinitions", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number test definitions returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of test definitions before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of test definitions after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } }, { "name" : "entityType", "in" : "query", "description" : "Filter by entityType.", "schema" : { "type" : "string", "enum" : [ "TABLE", "COLUMN" ] } }, { "name" : "testPlatform", "in" : "query", "description" : "Filter by a test platform", "schema" : { "type" : "string", "enum" : [ "OpenMetadata", "GreatExpectations", "DBT", "Deequ", "Soda", "Other" ] } }, { "name" : "supportedDataType", "in" : "query", "description" : "Filter tests definition by supported data type", "schema" : { "type" : "string", "enum" : [ "NUMBER", "TINYINT", "SMALLINT", "INT", "BIGINT", "BYTEINT", "BYTES", "FLOAT", "DOUBLE", "DECIMAL", "NUMERIC", "TIMESTAMP", "TIMESTAMPZ", "TIME", "DATE", "DATETIME", "INTERVAL", "STRING", "MEDIUMTEXT", "TEXT", "CHAR", "LONG", "VARCHAR", "BOOLEAN", "BINARY", "VARBINARY", "ARRAY", "BLOB", "LONGBLOB", "MEDIUMBLOB", "MAP", "STRUCT", "UNION", "SET", "GEOGRAPHY", "ENUM", "JSON", "UUID", "VARIANT", "GEOMETRY", "BYTEA", "AGGREGATEFUNCTION", "ERROR", "FIXED", "RECORD", "NULL", "SUPER", "HLLSKETCH", "PG_LSN", "PG_SNAPSHOT", "TSQUERY", "TXID_SNAPSHOT", "XML", "MACADDR", "TSVECTOR", "UNKNOWN", "CIDR", "INET", "CLOB", "ROWID", "LOWCARDINALITY", "YEAR", "POINT", "POLYGON", "TUPLE", "SPATIAL", "TABLE", "NTEXT", "IMAGE", "IPV4", "IPV6", "DATETIMERANGE", "HLL", "LARGEINT", "QUANTILE_STATE", "AGG_STATE", "BITMAP", "UINT", "BIT", "MONEY" ] } } ], "responses" : { "200" : { "description" : "List of test definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestDefinitionList" } } } } } }, "put" : { "tags" : [ "Test Definitions" ], "summary" : "Update test definition", "description" : "Create a test definition, if it does not exist, or update an existing test definition.", "operationId" : "createOrUpdateTestDefinition", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTestDefinition" } } } }, "responses" : { "200" : { "description" : "The updated test definition ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestDefinition" } } } } } }, "post" : { "tags" : [ "Test Definitions" ], "summary" : "Create a test definition", "description" : "Create a Test definition.", "operationId" : "createTestDefinition", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTestDefinition" } } } }, "responses" : { "200" : { "description" : "The test definition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestDefinition" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/dataQuality/testDefinitions/name/{name}" : { "get" : { "tags" : [ "Test Definitions" ], "summary" : "Get a test definition by name", "description" : "Get a test definition by `name`.", "operationId" : "getTestDefinitionByName", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the test definition", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The test definition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestDefinition" } } } }, "404" : { "description" : "Test Definition for instance {name} is not found" } } }, "delete" : { "tags" : [ "Test Definitions" ], "summary" : "Delete a test definition", "description" : "Delete a test definition by `name`.", "operationId" : "deleteTestDefinitionByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the test definition", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Test definition for instance {name} is not found" } } } }, "/v1/dataQuality/testDefinitions/restore" : { "put" : { "tags" : [ "Test Definitions" ], "summary" : "Restore a soft deleted test definition", "description" : "Restore a soft deleted TestDefinition.", "operationId" : "restore_13", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the TestDefinition. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestDefinition" } } } } } } }, "/v1/dataQuality/testDefinitions/{id}" : { "get" : { "tags" : [ "Test Definitions" ], "summary" : "Get a test definition by Id", "description" : "Get a Test Definition by `Id`.", "operationId" : "get_4", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test definition", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The Test definition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestDefinition" } } } }, "404" : { "description" : "Test Definition for instance {id} is not found" } } }, "delete" : { "tags" : [ "Test Definitions" ], "summary" : "Delete a test definition", "description" : "Delete a test definition by `id`.", "operationId" : "deleteTestDefinition", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the test definition", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Test definition for instance {id} is not found" } } }, "patch" : { "tags" : [ "Test Definitions" ], "summary" : "Update a test definition", "description" : "Update an existing Test Definition using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchTestDefinition", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test definition", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dataQuality/testDefinitions/{id}/versions" : { "get" : { "tags" : [ "Test Definitions" ], "summary" : "List test definition versions", "description" : "Get a list of all the versions of a test definition identified by `Id`", "operationId" : "listAllTestDefinitionVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test definition", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of test definition versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/dataQuality/testDefinitions/{id}/versions/{version}" : { "get" : { "tags" : [ "Test Definitions" ], "summary" : "Get a version of the test definition", "description" : "Get a version of the test definition by given `Id`", "operationId" : "getSpecificTestDefinitionVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test definition", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Test Definition version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "TestDefinition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestDefinition" } } } }, "404" : { "description" : "Test Definition for instance {id} and version {version} is not found" } } } }, "/v1/dataQuality/testSuites" : { "get" : { "tags" : [ "Test Suites" ], "summary" : "List test suites", "description" : "Get a list of test suites. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listTestSuites", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tests,summary" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number test definitions returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "testSuiteType", "in" : "query", "description" : "Returns executable or logical test suites. If omitted, returns all test suites.", "schema" : { "type" : "string", "example" : "basic" } }, { "name" : "includeEmptyTestSuites", "in" : "query", "description" : "Include empty test suite in the response.", "schema" : { "type" : "boolean", "example" : true, "default" : true } }, { "name" : "before", "in" : "query", "description" : "Returns list of test definitions before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of test definitions after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of test definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSuiteList" } } } } } }, "put" : { "tags" : [ "Test Suites" ], "summary" : "Update logical test suite", "description" : "Create a logical TestSuite, if it does not exist or update an existing test suite.", "operationId" : "createOrUpdateLogicalTestSuite", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTestSuite" } } } }, "responses" : { "200" : { "description" : "The updated test definition ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSuite" } } } } } }, "post" : { "tags" : [ "Test Suites" ], "summary" : "Create a logical test suite", "description" : "Create a logical test suite.", "operationId" : "createLogicalTestSuite", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTestSuite" } } } }, "responses" : { "200" : { "description" : "The test suite", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSuite" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/dataQuality/testSuites/basic" : { "put" : { "tags" : [ "Test Suites" ], "summary" : "Create or Update Basic test suite", "description" : "Create a Basic TestSuite if it does not exist or update an existing one.", "operationId" : "createOrUpdateBasicTestSuite", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTestSuite" } } } }, "responses" : { "200" : { "description" : "The updated test definition ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSuite" } } } } } }, "post" : { "tags" : [ "Test Suites" ], "summary" : "Create a basic test suite", "description" : "Create a basic test suite.", "operationId" : "createBasicTestSuite", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTestSuite" } } } }, "responses" : { "200" : { "description" : "Basic test suite", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSuite" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/dataQuality/testSuites/basic/name/{name}" : { "delete" : { "tags" : [ "Test Suites" ], "summary" : "Delete a test suite", "description" : "Delete a test suite by `name`.", "operationId" : "deleteTestSuiteByName", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the test suite", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Test suite for instance {name} is not found" } } } }, "/v1/dataQuality/testSuites/basic/{id}" : { "delete" : { "tags" : [ "Test Suites" ], "summary" : "Delete a test suite", "description" : "Delete a test suite by `Id`.", "operationId" : "deleteTestSuite", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the test suite", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Test suite for instance {id} is not found" } } } }, "/v1/dataQuality/testSuites/dataQualityReport" : { "get" : { "tags" : [ "Test Suites" ], "summary" : "Get Data Quality Report", "description" : "Use the search service to perform data quality aggregation. You can use the `q` parameter to filter the results.\nthe `aggregationQuery` is of the form `bucketName=<bucketName>:aggType=<aggType>:field=<field>`. You can sperate aggregation\nquery with a comma `,` to perform nested aggregations.\nFor example, `bucketName=table:aggType=terms:field=databaseName,bucketName=<bucketName>:aggType=<aggType>:field=<field>`\n", "operationId" : "getDataQualityReport", "parameters" : [ { "name" : "q", "in" : "query", "description" : "Search query to filter the aggregation results", "schema" : { "type" : "string" } }, { "name" : "aggregationQuery", "in" : "query", "description" : "Aggregation query to perform aggregation on the search results", "schema" : { "type" : "string" } }, { "name" : "index", "in" : "query", "description" : "Index to perform the aggregation against", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Data Quality Report Results", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DataQualityReport" } } } } } } }, "/v1/dataQuality/testSuites/executable" : { "put" : { "tags" : [ "Test Suites" ], "summary" : "Create or Update Executable test suite", "description" : "Create an Executable TestSuite if it does not exist or update an existing one.", "operationId" : "createOrUpdateExecutableTestSuite", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTestSuite" } } } }, "responses" : { "200" : { "description" : "The updated test definition ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSuite" } } } } } }, "post" : { "tags" : [ "Test Suites" ], "summary" : "Create an executable test suite", "description" : "Create an executable test suite.", "operationId" : "createExecutableTestSuite", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTestSuite" } } } }, "responses" : { "200" : { "description" : "Executable test suite", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSuite" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/dataQuality/testSuites/executable/name/{name}" : { "delete" : { "tags" : [ "Test Suites" ], "summary" : "Delete a test suite", "description" : "Delete a test suite by `name`.", "operationId" : "deleteTestSuiteByName_1", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the test suite", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Test suite for instance {name} is not found" } } } }, "/v1/dataQuality/testSuites/executable/{id}" : { "delete" : { "tags" : [ "Test Suites" ], "summary" : "Delete a test suite", "description" : "Delete a test suite by `Id`.", "operationId" : "deleteTestSuite_1", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the test suite", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Test suite for instance {id} is not found" } } } }, "/v1/dataQuality/testSuites/executionSummary" : { "get" : { "tags" : [ "Test Suites" ], "summary" : "Get the execution summary of test suites", "description" : "Get the execution summary of test suites.", "operationId" : "getExecutionSummaryOfTestSuites", "parameters" : [ { "name" : "testSuiteId", "in" : "query", "description" : "get summary for a specific test suite", "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Tests Execution Summary", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSummary" } } } } } } }, "/v1/dataQuality/testSuites/name/{name}" : { "get" : { "tags" : [ "Test Suites" ], "summary" : "Get a test suite by name", "description" : "Get a test suite by name.", "operationId" : "getTestSuiteByName", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the test suite", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tests,summary" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The test suite", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSuite" } } } }, "404" : { "description" : "Test Suite for instance {name} is not found" } } }, "delete" : { "tags" : [ "Test Suites" ], "summary" : "Delete a logical test suite", "description" : "Delete a logical test suite by `name`.", "operationId" : "deleteLogicalTestSuite", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the logical entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "FQN of the logical test suite", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Logical Test suite for instance {name} is not found" } } } }, "/v1/dataQuality/testSuites/restore" : { "put" : { "tags" : [ "Test Suites" ], "summary" : "Restore a soft deleted test suite", "description" : "Restore a soft deleted test suite.", "operationId" : "restore_14", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the TestSuite.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSuite" } } } } } } }, "/v1/dataQuality/testSuites/search/list" : { "get" : { "tags" : [ "Test Suites" ], "summary" : "List test suite using search service", "description" : "Get a list of test suite using the search service. Use `fields` parameter to get only necessary fields. Use offset/limit pagination to limit the number entries in the list using `limit` and `offset` query params.Use the `tests` field to get the test cases linked to the test suite and/or use the `summary` field to get a summary of test case executions.", "operationId" : "listTestSuiteFromSearchService", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tests,summary" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number test suite returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "offset", "in" : "query", "description" : "Returns list of test suite after this offset (default = 0)", "schema" : { "type" : "string", "default" : "0" } }, { "name" : "testSuiteType", "in" : "query", "description" : "Returns executable or logical test suites. If omitted, returns all test suites.", "schema" : { "type" : "string", "example" : "executable" } }, { "name" : "includeEmptyTestSuites", "in" : "query", "description" : "Include empty test suite in the response.", "schema" : { "type" : "boolean", "example" : true, "default" : true } }, { "name" : "domain", "in" : "query", "description" : "Filter a test suite by domain.", "schema" : { "type" : "string" } }, { "name" : "fullyQualifiedName", "in" : "query", "description" : "Filter a test suite by fully qualified name.", "schema" : { "type" : "string" } }, { "name" : "owner", "in" : "query", "description" : "Filter test suites by owner.", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } }, { "name" : "sortField", "in" : "query", "description" : "Field used to sort the test cases listing", "schema" : { "type" : "string" } }, { "name" : "sortNestedPath", "in" : "query", "description" : "Set this field if your mapping is nested and you want to sort on a nested field", "schema" : { "type" : "string" } }, { "name" : "sortNestedMode", "in" : "query", "description" : "Set this field if your mapping is nested and you want to sort on a nested field", "schema" : { "type" : "string", "example" : "min,max,avg,sum,median" } }, { "name" : "sortType", "in" : "query", "description" : "Sort type", "schema" : { "type" : "string", "default" : "desc", "enum" : [ "asc", "desc" ] } }, { "name" : "q", "in" : "query", "description" : "search query term to use in list", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of test suites", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSuiteList" } } } } } } }, "/v1/dataQuality/testSuites/{id}" : { "get" : { "tags" : [ "Test Suites" ], "summary" : "Get a test suite by Id", "description" : "Get a Test Suite by `Id`.", "operationId" : "get_5", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test suite", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tests,summary" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The Test suite", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSuite" } } } }, "404" : { "description" : "Test Suite for instance {id} is not found" } } }, "delete" : { "tags" : [ "Test Suites" ], "summary" : "Delete a logical test suite", "description" : "Delete a logical test suite by `id`.", "operationId" : "deleteLogicalTestSuite_1", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the logical entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the logical test suite", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Logical test suite for instance {id} is not found" } } }, "patch" : { "tags" : [ "Test Suites" ], "summary" : "Update a test suite", "description" : "Update an existing testSuite using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchTestSuite", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test suite", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/dataQuality/testSuites/{id}/versions" : { "get" : { "tags" : [ "Test Suites" ], "summary" : "List test suite versions", "description" : "Get a list of all the versions of a test suite identified by `id`", "operationId" : "listAllTestSuiteVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test suite", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of test suite versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/dataQuality/testSuites/{id}/versions/{version}" : { "get" : { "tags" : [ "Test Suites" ], "summary" : "Get a version of the test suite", "description" : "Get a version of the test suite by given `id`", "operationId" : "getSpecificTestSuiteVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the test suite", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Test Suite version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "TestSuite", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestSuite" } } } }, "404" : { "description" : "Test Suite for instance {id} and version {version} is not found" } } } }, "/v1/databaseSchemas" : { "get" : { "tags" : [ "Database Schemas" ], "summary" : "List database schemas", "description" : "Get a list of database schemas, optionally filtered by `database` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listDBSchemas", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tables,usageSummary,tags,extension,domain,sourceHash" } }, { "name" : "database", "in" : "query", "description" : "Filter schemas by database name", "schema" : { "type" : "string", "example" : "customerDatabase" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number schemas returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of schemas before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of schemas after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of database schema", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseSchemaList" } } } } } }, "put" : { "tags" : [ "Database Schemas" ], "summary" : "Create or update schema", "description" : "Create a database schema, if it does not exist or update an existing database schema.", "operationId" : "createOrUpdateDBSchema", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDatabaseSchema" } } } }, "responses" : { "200" : { "description" : "The updated schema ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseSchema" } } } } } }, "post" : { "tags" : [ "Database Schemas" ], "summary" : "Create a schema", "description" : "Create a schema under an existing `service`.", "operationId" : "createDBSchema", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDatabaseSchema" } } } }, "responses" : { "200" : { "description" : "The database schema", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseSchema" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/databaseSchemas/entityRelationship" : { "get" : { "tags" : [ "Database Schemas" ], "summary" : "Search Schema Entity Relationship", "operationId" : "searchSchemaEntityRelationship", "parameters" : [ { "name" : "fqn", "in" : "query", "description" : "fqn", "schema" : { "type" : "string" } }, { "name" : "upstreamDepth", "in" : "query", "description" : "upstreamDepth", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "downstreamDepth", "in" : "query", "description" : "downstreamDepth", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "query_filter", "in" : "query", "description" : "Elasticsearch query that will be combined with the query_string query generator from the `query` argument", "schema" : { "type" : "string" } }, { "name" : "includeDeleted", "in" : "query", "description" : "Filter documents by deleted param. By default deleted is false", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "search response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchResponse" } } } } } } }, "/v1/databaseSchemas/name/{fqn}" : { "get" : { "tags" : [ "Database Schemas" ], "summary" : "Get a schema by fully qualified name", "description" : "Get a database schema by fully qualified name.", "operationId" : "getDBSchemaByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the database schema", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tables,usageSummary,tags,extension,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The schema", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseSchema" } } } }, "404" : { "description" : "Database schema for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Database Schemas" ], "summary" : "Delete a schema by fully qualified name", "description" : "Delete a schema by `fullyQualifiedName`. Schema can only be deleted if it has no tables.", "operationId" : "deleteDBSchemaByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Name of the DBSchema", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Schema for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Database Schemas" ], "summary" : "Update a database schema by name.", "description" : "Update an existing database schema using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDBSchema", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Database schema name", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/databaseSchemas/name/{name}/export" : { "get" : { "tags" : [ "Database Schemas" ], "summary" : "Export database schema in CSV format", "operationId" : "exportDatabaseSchema", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Database schema", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with tables from the database schema", "content" : { "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/v1/databaseSchemas/name/{name}/exportAsync" : { "get" : { "tags" : [ "Database Schemas" ], "summary" : "Export database schema in CSV format", "operationId" : "exportDatabaseSchema_1", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Database schema", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with tables from the database schema", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CSVExportResponse" } } } } } } }, "/v1/databaseSchemas/name/{name}/import" : { "put" : { "tags" : [ "Database Schemas" ], "summary" : "Import tables from CSV to update database schema (no creation allowed)", "operationId" : "importDatabaseSchema", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Database schema", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry-run when true is used for validating the CSV without really importing it. (default=true)", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Import result", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/databaseSchemas/name/{name}/importAsync" : { "put" : { "tags" : [ "Database Schemas" ], "summary" : "Import tables from CSV to update database schema asynchronously (no creation allowed)", "operationId" : "importDatabaseSchemaAsync", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Database schema", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry-run when true is used for validating the CSV without really importing it. (default=true)", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Import initiated successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/databaseSchemas/restore" : { "put" : { "tags" : [ "Database Schemas" ], "summary" : "Restore a soft deleted database schema.", "description" : "Restore a soft deleted database schema.", "operationId" : "restore_8", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the DatabaseSchema ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseSchema" } } } } } } }, "/v1/databaseSchemas/{id}" : { "get" : { "tags" : [ "Database Schemas" ], "summary" : "Get a schema by Id", "description" : "Get a database schema by `Id`.", "operationId" : "getDBSchemaByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Database schema Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tables,usageSummary,tags,extension,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The schema", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseSchema" } } } }, "404" : { "description" : "Schema for instance {id} is not found" } } }, "delete" : { "tags" : [ "Database Schemas" ], "summary" : "Delete a schema by Id", "description" : "Delete a schema by `Id`. Schema can only be deleted if it has no tables.", "operationId" : "deleteDBSchema", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Database schema Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Schema for instance {id} is not found" } } }, "patch" : { "tags" : [ "Database Schemas" ], "summary" : "Update a database schema", "description" : "Update an existing database schema using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDBSchema_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Database schema Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/databaseSchemas/{id}/databaseSchemaProfilerConfig" : { "get" : { "tags" : [ "Database Schemas" ], "summary" : "Get databaseSchema profile config", "description" : "Get databaseSchema profile config to the table.", "operationId" : "getDataProfilerConfig_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the databaseSchema", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Successfully updated the DatabaseSchema ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseSchema" } } } } } }, "put" : { "tags" : [ "Database Schemas" ], "summary" : "Add databaseSchema profile config", "description" : "Add databaseSchema profile config to the table.", "operationId" : "addDataProfilerConfig_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the databaseSchema", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseSchemaProfilerConfig" } } } }, "responses" : { "200" : { "description" : "Successfully updated the DatabaseSchema ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseSchema" } } } } } }, "delete" : { "tags" : [ "Database Schemas" ], "summary" : "Delete database profiler config", "description" : "delete database profile config to the database.", "operationId" : "delete DataProfilerConfig_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Successfully deleted the Database profiler config", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseSchema" } } } } } } }, "/v1/databaseSchemas/{id}/versions" : { "get" : { "tags" : [ "Database Schemas" ], "summary" : "List schema versions", "description" : "Get a list of all the versions of a schema identified by `Id`", "operationId" : "listAllDBSchemaVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Database schema Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of schema versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/databaseSchemas/{id}/versions/{version}" : { "get" : { "tags" : [ "Database Schemas" ], "summary" : "Get a version of the schema", "description" : "Get a version of the database schema by given `Id`", "operationId" : "getSpecificDBSchemaVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Database schema Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Database schema version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "database schema", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseSchema" } } } }, "404" : { "description" : "Database schema for instance {id} and version {version} is not found" } } } }, "/v1/databaseSchemas/{id}/vote" : { "put" : { "tags" : [ "Database Schemas" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_3", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/databases" : { "get" : { "tags" : [ "Databases" ], "summary" : "List databases", "description" : "Get a list of databases, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listDatabases", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,databaseSchemas,usageSummary,location,tags,extension,domain,sourceHash" } }, { "name" : "service", "in" : "query", "description" : "Filter databases by service name", "schema" : { "type" : "string", "example" : "snowflakeWestCoast" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number tables returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of tables before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of tables after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of databases", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseList" } } } } } }, "put" : { "tags" : [ "Databases" ], "summary" : "Create or update database", "description" : "Create a database, if it does not exist or update an existing database.", "operationId" : "createOrUpdateDatabase", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDatabase" } } } }, "responses" : { "200" : { "description" : "The updated database ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Database" } } } } } }, "post" : { "tags" : [ "Databases" ], "summary" : "Create a database", "description" : "Create a database under an existing `service`.", "operationId" : "createDatabase", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDatabase" } } } }, "responses" : { "200" : { "description" : "The database", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Database" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/databases/name/{fqn}" : { "get" : { "tags" : [ "Databases" ], "summary" : "Get a database by fully qualified name", "description" : "Get a database by `fullyQualifiedName`.", "operationId" : "getDatabaseByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the database", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,databaseSchemas,usageSummary,location,tags,extension,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The database", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Database" } } } }, "404" : { "description" : "Database for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Databases" ], "summary" : "Delete a database by fully qualified name", "description" : "Delete a database by `fullyQualifiedName`. Databases can only be deleted if it has no tables.", "operationId" : "deleteDatabaseByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the database", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Database for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Databases" ], "summary" : "Update a database by name.", "description" : "Update an existing database using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDatabase", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the database", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/databases/name/{name}/export" : { "get" : { "tags" : [ "Databases" ], "summary" : "Export database in CSV format", "operationId" : "exportDatabase", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Database", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with database schemas", "content" : { "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/v1/databases/name/{name}/exportAsync" : { "get" : { "tags" : [ "Databases" ], "summary" : "Export database in CSV format", "operationId" : "exportDatabase_1", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Database", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with database schemas", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CSVExportResponse" } } } } } } }, "/v1/databases/name/{name}/import" : { "put" : { "tags" : [ "Databases" ], "summary" : "Import database schemas from CSV to update database schemas (no creation allowed)", "operationId" : "importDatabase", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Database", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry-run when true is used for validating the CSV without really importing it. (default=true)", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Import result", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/databases/name/{name}/importAsync" : { "put" : { "tags" : [ "Databases" ], "summary" : "Import database schemas from CSV asynchronously", "description" : "Import database schemas from CSV to update database schemas asynchronously (no creation allowed).", "operationId" : "importDatabaseAsync", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Database", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry-run when true is used for validating the CSV without really importing it. (default=true)", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Import initiated successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/databases/restore" : { "put" : { "tags" : [ "Databases" ], "summary" : "Restore a soft deleted Database.", "description" : "Restore a soft deleted Database.", "operationId" : "restore_7", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Database. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Database" } } } } } } }, "/v1/databases/{id}" : { "get" : { "tags" : [ "Databases" ], "summary" : "Get a database by Id", "description" : "Get a database by `Id`.", "operationId" : "getDatabaseByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the database", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,databaseSchemas,usageSummary,location,tags,extension,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The database", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Database" } } } }, "404" : { "description" : "Database for instance {id} is not found" } } }, "delete" : { "tags" : [ "Databases" ], "summary" : "Delete a database by Id", "description" : "Delete a database by `Id`. Database can only be deleted if it has no tables.", "operationId" : "deleteDatabase", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the database", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Database for instance {id} is not found" } } }, "patch" : { "tags" : [ "Databases" ], "summary" : "Update a database", "description" : "Update an existing database using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDatabase_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the database", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/databases/{id}/databaseProfilerConfig" : { "get" : { "tags" : [ "Databases" ], "summary" : "Get database profile config", "description" : "Get database profile config to the database.", "operationId" : "getDataProfilerConfig", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the database", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Successfully updated the Database ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Database" } } } } } }, "put" : { "tags" : [ "Databases" ], "summary" : "Add database profile config", "description" : "Add database profile config to the database.", "operationId" : "addDataProfilerConfig", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the database", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseProfilerConfig" } } } }, "responses" : { "200" : { "description" : "Successfully updated the Database ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Database" } } } } } }, "delete" : { "tags" : [ "Databases" ], "summary" : "Delete database profiler config", "description" : "delete database profile config to the database.", "operationId" : "delete DataProfilerConfig", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Successfully deleted the Database profiler config", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Database" } } } } } } }, "/v1/databases/{id}/versions" : { "get" : { "tags" : [ "Databases" ], "summary" : "List database versions", "description" : "Get a list of all the versions of a database identified by `Id`", "operationId" : "listAllDatabaseVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the database", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of database versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/databases/{id}/versions/{version}" : { "get" : { "tags" : [ "Databases" ], "summary" : "Get a version of the database", "description" : "Get a version of the database by given `Id`", "operationId" : "getSpecificDatabaseVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the database", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Database version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "database", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Database" } } } }, "404" : { "description" : "Database for instance {id} and version {version} is not found" } } } }, "/v1/databases/{id}/vote" : { "put" : { "tags" : [ "Databases" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_2", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/docStore" : { "get" : { "tags" : [ "Document Store" ], "summary" : "List Documents", "description" : "Get a list of Documents. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listDocuments", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Limit the number of personas returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "entityType", "in" : "query", "description" : "Filter docs by entityType", "schema" : { "type" : "string", "example" : "KnowledgePanel" } }, { "name" : "fqnPrefix", "in" : "query", "description" : "Filter docs by fqnPrefix", "schema" : { "type" : "string", "example" : "fqnPrefix" } }, { "name" : "before", "in" : "query", "description" : "Returns list of personas before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of personas after this cursor", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of personas", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DocumentList" } } } } } }, "put" : { "tags" : [ "Document Store" ], "summary" : "Update Document", "description" : "Create or Update a Document.", "operationId" : "createOrUpdateDocument", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDocument" } } } }, "responses" : { "200" : { "description" : "The Document.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Document" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Document Store" ], "summary" : "Create a Document", "description" : "Create a new Document.", "operationId" : "createDocument", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDocument" } } } }, "responses" : { "200" : { "description" : "The Knowledge Panel.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Document" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/docStore/name/{fqn}" : { "patch" : { "tags" : [ "Document Store" ], "summary" : "Update a Document by name.", "description" : "Update an existing Document with JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDocument", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the Document", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/docStore/name/{name}" : { "get" : { "tags" : [ "Document Store" ], "summary" : "Get a Document by name", "description" : "Get a Document by `name`.", "operationId" : "getDocumentByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Document", "required" : true, "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The Document", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Document" } } } }, "404" : { "description" : "Document for instance {name} is not found" } } }, "delete" : { "tags" : [ "Document Store" ], "summary" : "Delete a Document by name", "description" : "Delete a Document by given `name`.", "operationId" : "deleteDocumentByName", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Document", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Knowledge Panel for instance {name} is not found" } } } }, "/v1/docStore/resetEmailTemplate" : { "post" : { "tags" : [ "Document Store" ], "summary" : "Reset seed data of EmailTemplate type", "description" : "Deletes seed data of the EmailTemplate type from the document store and reinitializes it from resources.", "operationId" : "resetEmailTemplate", "responses" : { "200" : { "description" : "Seed Data init successfully", "content" : { "application/json" : { "schema" : { "type" : "string" } } } }, "400" : { "description" : "Seed Data init failed", "content" : { "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/v1/docStore/validateTemplate/{templateName}" : { "put" : { "tags" : [ "Document Store" ], "summary" : "Validate Email Template", "description" : "Validates is the give content is a valid Email Template.", "operationId" : "validateEmailTemplate", "parameters" : [ { "name" : "templateName", "in" : "path", "description" : "Template name for the email template to be validated", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailTemplate" } } } }, "responses" : { "200" : { "description" : "The Template Validation Response.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TemplateValidationResponse" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/docStore/{id}" : { "get" : { "tags" : [ "Document Store" ], "summary" : "Get a Document by id", "description" : "Get a Document by `id`.", "operationId" : "get_2", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Document", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The Document", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Document" } } } }, "404" : { "description" : "Document for instance {id} is not found" } } }, "delete" : { "tags" : [ "Document Store" ], "summary" : "Delete a Document by id", "description" : "Delete a Document by given `id`.", "operationId" : "deleteDocument", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Document", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Document for instance {id} is not found" } } }, "patch" : { "tags" : [ "Document Store" ], "summary" : "Update a Document.", "description" : "Update an existing Document with JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDocument_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Document", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/docStore/{id}/versions" : { "get" : { "tags" : [ "Document Store" ], "summary" : "List Document versions", "description" : "Get a list of all the versions of a Document identified by `id`", "operationId" : "listAllDocumentVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Document", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of persona versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/docStore/{id}/versions/{version}" : { "get" : { "tags" : [ "Document Store" ], "summary" : "Get a version of the Document", "description" : "Get a version of the Document by given `id`", "operationId" : "getSpecificDocumentVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Document", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Document version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "KnowledgePanel", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Document" } } } }, "404" : { "description" : "Document for instance {id} and version {version} is not found" } } } }, "/v1/domains" : { "get" : { "tags" : [ "Domains" ], "summary" : "List domains", "description" : "Get a list of Domains.", "operationId" : "listDomains", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "children,owners,experts" } }, { "name" : "limit", "in" : "query", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of Domain before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of Domain after this cursor", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of Domains", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DomainList" } } } } } }, "put" : { "tags" : [ "Domains" ], "summary" : "Create or update a domain", "description" : "Create a domain. if it does not exist. If a domain already exists, update the domain.", "operationId" : "createOrUpdateDomain", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDomain" } } } }, "responses" : { "200" : { "description" : "The domain", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Domain" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Domains" ], "summary" : "Create a domain", "description" : "Create a new domain.", "operationId" : "createDomain", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDomain" } } } }, "responses" : { "200" : { "description" : "The domain ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Domain" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/domains/hierarchy" : { "get" : { "tags" : [ "Domains" ], "summary" : "List domains in hierarchical order", "description" : "Get a list of Domains in hierarchical order.", "operationId" : "listDomainsHierarchy", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "children,owners,experts" } }, { "name" : "limit", "in" : "query", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } } ], "responses" : { "200" : { "description" : "List of Domains in hierarchical order", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHierarchyList" } } } } } } }, "/v1/domains/name/{fqn}" : { "patch" : { "tags" : [ "Domains" ], "summary" : "Update a domain by name.", "description" : "Update an existing domain using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDomain", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the domain", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/domains/name/{name}" : { "get" : { "tags" : [ "Domains" ], "summary" : "Get a domain by name", "description" : "Get a domain by `name`.", "operationId" : "getDomainByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the domain", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "children,owners,experts" } } ], "responses" : { "200" : { "description" : "domain", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Domain" } } } }, "404" : { "description" : "Domain for instance {name} is not found" } } }, "delete" : { "tags" : [ "Domains" ], "summary" : "Delete a domain by name", "description" : "Delete a domain by `name`.", "operationId" : "deleteDomainByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the domain", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Domain for instance {name} is not found" } } } }, "/v1/domains/{id}" : { "get" : { "tags" : [ "Domains" ], "summary" : "Get a domain by Id", "description" : "Get a domain by `Id`.", "operationId" : "getDomainByID", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "children,owners,experts" } }, { "name" : "id", "in" : "path", "description" : "Id of the domain", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "The domain", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Domain" } } } }, "404" : { "description" : "Domain for instance {id} is not found" } } }, "delete" : { "tags" : [ "Domains" ], "summary" : "Delete a domain by Id", "description" : "Delete a domain by `Id`.", "operationId" : "deleteDomain", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the domain", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Domain for instance {id} is not found" } } }, "patch" : { "tags" : [ "Domains" ], "summary" : "Update a domain", "description" : "Update an existing domain using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDomain_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the domain", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/domains/{id}/versions" : { "get" : { "tags" : [ "Domains" ], "summary" : "List domain versions", "description" : "Get a list of all the versions of a domain identified by `Id`", "operationId" : "listAllDomainVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the domain", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of domain versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/domains/{id}/versions/{version}" : { "get" : { "tags" : [ "Domains" ], "summary" : "Get a version of the domain", "description" : "Get a version of the domain by given `Id`", "operationId" : "listSpecificDomainVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the domain", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Domain version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "domain", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Domain" } } } }, "404" : { "description" : "Domain for instance {id} and version {version} is not found" } } } }, "/v1/domains/{name}/assets/add" : { "put" : { "tags" : [ "Domains" ], "summary" : "Bulk Add Assets", "description" : "Bulk Add Assets", "operationId" : "bulkAddAssets_1", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the domain", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkAssets" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkOperationResult" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/domains/{name}/assets/remove" : { "put" : { "tags" : [ "Domains" ], "summary" : "Bulk Remove Assets", "description" : "Bulk Remove Assets", "operationId" : "bulkRemoveAssets_1", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the domain", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkAssets" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/events" : { "get" : { "tags" : [ "Events" ], "summary" : "Get change events", "description" : "Get a list of change events matching event types, entity type, from a given date", "operationId" : "listChangeEvents", "parameters" : [ { "name" : "entityCreated", "in" : "query", "description" : "List of comma separated entities requested for `entityCreated` event. When set to `*` all entities will be returned", "schema" : { "type" : "string", "example" : "table,dashboard,..." } }, { "name" : "entityUpdated", "in" : "query", "description" : "List of comma separated entities requested for `entityUpdated` event. When set to `*` all entities will be returned", "schema" : { "type" : "string", "example" : "table,dashboard,..." } }, { "name" : "entityRestored", "in" : "query", "description" : "List of comma separated entities requested for `entityRestored` event. When set to `*` all entities will be returned", "schema" : { "type" : "string", "example" : "table,dashboard,..." } }, { "name" : "entityDeleted", "in" : "query", "description" : "List of comma separated entities requested for `entityCreated` event. When set to `*` all entities will be returned", "schema" : { "type" : "string", "example" : "table,dashboard,..." } }, { "name" : "timestamp", "in" : "query", "description" : "Events starting from this unix timestamp in milliseconds", "required" : true, "schema" : { "type" : "integer", "format" : "int64", "example" : 1426349294842 } } ], "responses" : { "200" : { "description" : "Entity events", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventList" } } } }, "404" : { "description" : "Entity for instance {id} is not found" } } } }, "/v1/events/subscriptions" : { "get" : { "tags" : [ "Events" ], "summary" : "List all available Event Subscriptions", "description" : "Get a list of All available Event Subscriptions", "operationId" : "listEventSubscriptions", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,filteringRules" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number event subscriptions returned. (1 to 1000000, default = 10) ", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "alertType", "in" : "query", "description" : "alertType filter. Notification / Observability", "schema" : { "type" : "string" } }, { "name" : "before", "in" : "query", "description" : "Returns list of event subscriptions before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of event subscriptions after this cursor", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of Event Subscriptions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventSubscriptionList" } } } } } }, "put" : { "tags" : [ "Events" ], "summary" : "Updated an existing or create a new Event Subscription", "description" : "Updated an existing or create a new Event Subscription", "operationId" : "createOrUpdateEventSubscription", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateEventSubscription" } } } }, "responses" : { "200" : { "description" : "create Event Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateEventSubscription" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Events" ], "summary" : "Create a new Event Subscription", "description" : "Create a new Event Subscription", "operationId" : "createEventSubscription", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateEventSubscription" } } } }, "responses" : { "200" : { "description" : "Event Subscription Created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateEventSubscription" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/events/subscriptions/id/{eventSubscriptionId}/destinations" : { "get" : { "tags" : [ "Events" ], "summary" : "Get the destinations for a specific Event Subscription", "description" : "Retrieve the status of all destinations associated with the given Event Subscription ID", "operationId" : "getAllDestinationForEventSubscription", "parameters" : [ { "name" : "eventSubscriptionId", "in" : "path", "description" : "ID of the Event Subscription", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Returns the destinations for the Event Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionDestination" } } } }, "404" : { "description" : "Event Subscription for instance {eventSubscriptionId} is not found" } } } }, "/v1/events/subscriptions/id/{id}/failedEvents" : { "get" : { "tags" : [ "Events" ], "summary" : "Get failed events for a subscription by id", "description" : "Retrieve failed events for a given subscription id.", "operationId" : "getFailedEventsBySubscriptionId", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Event Subscription", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of failed events to retrieve", "schema" : { "minimum" : 0, "type" : "integer", "format" : "int64", "default" : 15 } }, { "name" : "paginationOffset", "in" : "query", "description" : "Offset for pagination (starting point for records)", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "name" : "source", "in" : "query", "description" : "Source of the failed events", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Failed events retrieved successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "Event subscription not found" }, "500" : { "description" : "Internal server error" } } } }, "/v1/events/subscriptions/id/{id}/listEvents" : { "get" : { "tags" : [ "Events" ], "summary" : "Retrieve events based on various filters", "description" : "Retrieve failed, successfully sent, or unprocessed change events, identified by alert ID, with an optional limit. If status is not provided, retrieves data from all statuses in ascending timestamp.", "operationId" : "getEvents", "parameters" : [ { "name" : "status", "in" : "query", "description" : "Status of events to retrieve (failed, successful)", "schema" : { "type" : "string", "enum" : [ "failed", "successful" ] } }, { "name" : "id", "in" : "path", "description" : "ID of the alert or destination", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of events to retrieve", "schema" : { "minimum" : 0, "type" : "integer", "format" : "int64", "default" : 15 } }, { "name" : "paginationOffset", "in" : "query", "description" : "Offset for pagination (starting point for records)", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } } ], "responses" : { "200" : { "description" : "Events retrieved successfully" }, "404" : { "description" : "Entity not found" }, "400" : { "description" : "Invalid request parameters" }, "500" : { "description" : "Internal server error" } } } }, "/v1/events/subscriptions/id/{id}/listSuccessfullySentChangeEvents" : { "get" : { "tags" : [ "Events" ], "summary" : "Get successfully sent change events for an alert", "description" : "Retrieve successfully sent change events for a specific alert, identified by its ID, with an optional limit.", "operationId" : "getSuccessfullySentChangeEventsForAlert", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of the alert to retrieve change events for", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of change events to retrieve", "schema" : { "minimum" : 0, "type" : "integer", "format" : "int64", "default" : 15 } }, { "name" : "paginationOffset", "in" : "query", "description" : "Offset for pagination (starting point for records)", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } } ], "responses" : { "200" : { "description" : "Successfully sent change events retrieved successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "Alert not found" }, "500" : { "description" : "Internal server error" } } } }, "/v1/events/subscriptions/id/{subscriptionId}/diagnosticInfo" : { "get" : { "tags" : [ "Events" ], "summary" : "Get event subscription diagnostic info", "description" : "Retrieve diagnostic information for a given event subscription ID, including current and latest offsets, unprocessed events count, and more.", "operationId" : "getEventSubscriptionDiagnosticInfoById", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of unprocessed events returned", "schema" : { "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 15 } }, { "name" : "paginationOffset", "in" : "query", "description" : "Offset for pagination (starting point for records)", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "name" : "subscriptionId", "in" : "path", "description" : "UUID of the Event Subscription", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "listCountOnly", "in" : "query", "description" : "Return only count if true", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "Event subscription diagnostic info retrieved successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventSubscriptionDiagnosticInfo" } } } }, "404" : { "description" : "Event subscription not found" }, "500" : { "description" : "Internal server error" } } } }, "/v1/events/subscriptions/id/{subscriptionId}/eventsRecord" : { "get" : { "tags" : [ "Events" ], "summary" : "Get event subscription events record", "description" : "Retrieve the total count, pending count, failed count, and successful count of events for a given event subscription ID.", "operationId" : "getEventSubscriptionEventsRecordById", "parameters" : [ { "name" : "subscriptionId", "in" : "path", "description" : "UUID of the Event Subscription", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Event subscription events record retrieved successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventsRecord" } } } }, "404" : { "description" : "Event subscription not found" }, "500" : { "description" : "Internal server error" } } } }, "/v1/events/subscriptions/listAllFailedEvents" : { "get" : { "tags" : [ "Events" ], "summary" : "Get all failed events", "description" : "Retrieve all failed events, optionally filtered by source, and apply a limit.", "operationId" : "getAllFailedEvents", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of failed events to retrieve", "schema" : { "minimum" : 0, "type" : "integer", "format" : "int64", "default" : 15 } }, { "name" : "paginationOffset", "in" : "query", "description" : "Offset for pagination (starting point for records)", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "name" : "source", "in" : "query", "description" : "Source of the failed events", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Failed events retrieved successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "500" : { "description" : "Internal server error" } } } }, "/v1/events/subscriptions/name/{eventSubscriptionName}" : { "get" : { "tags" : [ "Events" ], "summary" : "Get an Event Subscription by name", "description" : "Get an Event Subscription by name.", "operationId" : "getEventSubscriptionByName", "parameters" : [ { "name" : "eventSubscriptionName", "in" : "path", "description" : "Name of the Event Subscription", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,filteringRules" } } ], "responses" : { "200" : { "description" : "Event Subscription with request name is returned", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventSubscription" } } } }, "404" : { "description" : "Event Subscription for instance {eventSubscriptionName} is not found" } } } }, "/v1/events/subscriptions/name/{eventSubscriptionName}/destinations" : { "get" : { "tags" : [ "Events" ], "summary" : "Get the destinations for a specific Event Subscription by its name", "description" : "Retrieve the status of all destinations associated with the given Event Subscription's fully qualified name (FQN)", "operationId" : "getAllDestinationForEventSubscriptionByName", "parameters" : [ { "name" : "eventSubscriptionName", "in" : "path", "description" : "Name of the Event Subscription", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Returns the destinations for the Event Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionDestination" } } } }, "404" : { "description" : "Event Subscription with the name {fqn} is not found" } } } }, "/v1/events/subscriptions/name/{eventSubscriptionName}/failedEvents" : { "get" : { "tags" : [ "Events" ], "summary" : "Get failed events for a subscription by name", "description" : "Retrieve failed events for a given subscription name.", "operationId" : "getFailedEventsBySubscriptionName", "parameters" : [ { "name" : "eventSubscriptionName", "in" : "path", "description" : "Name of the Event Subscription", "required" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of failed events to retrieve", "schema" : { "minimum" : 0, "type" : "integer", "format" : "int64", "default" : 15 } }, { "name" : "paginationOffset", "in" : "query", "description" : "Offset for pagination (starting point for records)", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "name" : "source", "in" : "query", "description" : "Source of the failed events", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Failed events retrieved successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "Event subscription not found" }, "500" : { "description" : "Internal server error" } } } }, "/v1/events/subscriptions/name/{eventSubscriptionName}/listSuccessfullySentChangeEvents" : { "get" : { "tags" : [ "Events" ], "summary" : "Get successfully sent change events for an alert by name", "description" : "Retrieve successfully sent change events for a specific alert, identified by its name, with an optional limit.", "operationId" : "getSuccessfullySentChangeEventsForAlertByName", "parameters" : [ { "name" : "eventSubscriptionName", "in" : "path", "description" : "Name of the alert to retrieve change events for", "required" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of change events to retrieve", "schema" : { "minimum" : 0, "type" : "integer", "format" : "int64", "default" : 15 } }, { "name" : "paginationOffset", "in" : "query", "description" : "Offset for pagination (starting point for records)", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } } ], "responses" : { "200" : { "description" : "Successfully sent change events retrieved successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "Alert not found" }, "500" : { "description" : "Internal server error" } } } }, "/v1/events/subscriptions/name/{eventSubscriptionName}/status/{destinationId}" : { "get" : { "tags" : [ "Events" ], "summary" : "Get Event Subscription status", "description" : "Get a event Subscription status by given Name", "operationId" : "getEventSubscriptionStatus", "parameters" : [ { "name" : "eventSubscriptionName", "in" : "path", "description" : "Name of the Event Subscription", "required" : true, "schema" : { "type" : "string" } }, { "name" : "destinationId", "in" : "path", "description" : "Destination Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Return the current status of the Event Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionStatus" } } } }, "404" : { "description" : "Entity for instance {id} is not found" } } } }, "/v1/events/subscriptions/name/{eventSubscriptionName}/syncOffset" : { "put" : { "tags" : [ "Events" ], "summary" : "Sync Offset for a specific Event Subscription by its name", "description" : "Sync Offset for a specific Event Subscription by its name", "operationId" : "syncOffsetForEventSubscriptionByName", "parameters" : [ { "name" : "eventSubscriptionName", "in" : "path", "description" : "Name of the Event Subscription", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Returns the destinations for the Event Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionDestination" } } } }, "404" : { "description" : "Event Subscription with the name {fqn} is not found" } } } }, "/v1/events/subscriptions/name/{fqn}" : { "patch" : { "tags" : [ "Events" ], "summary" : "Update an Event Subscriptions by name.", "description" : "Update an existing Event Subscriptions using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchEventSubscription", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the event Subscription", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/events/subscriptions/name/{name}" : { "delete" : { "tags" : [ "Events" ], "summary" : "Delete an Event Subscription by name", "description" : "Delete an Event Subscription by given `name`.", "operationId" : "deleteEventSubscriptionByName", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Event Subscription", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Entity for instance {name} is not found" } } } }, "/v1/events/subscriptions/name/{subscriptionName}/diagnosticInfo" : { "get" : { "tags" : [ "Events" ], "summary" : "Get event subscription diagnostic info by name", "description" : "Retrieve diagnostic information for a given event subscription name, including current and latest offsets, unprocessed events count, and more.", "operationId" : "getEventSubscriptionDiagnosticInfoByName", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Maximum number of unprocessed events returned", "schema" : { "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 15 } }, { "name" : "paginationOffset", "in" : "query", "description" : "Offset for pagination (starting point for records)", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "name" : "subscriptionName", "in" : "path", "description" : "Name of the Event Subscription", "required" : true, "schema" : { "type" : "string" } }, { "name" : "listCountOnly", "in" : "query", "description" : "Return only count if true", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "Event subscription diagnostic info retrieved successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventSubscriptionDiagnosticInfo" } } } }, "404" : { "description" : "Event subscription not found" }, "500" : { "description" : "Internal server error" } } } }, "/v1/events/subscriptions/name/{subscriptionName}/eventsRecord" : { "get" : { "tags" : [ "Events" ], "summary" : "Get event subscription events record by name", "description" : "Retrieve the total count, pending count, failed count, and successful count of events for a given event subscription name.", "operationId" : "getEventSubscriptionEventsRecordByName", "parameters" : [ { "name" : "subscriptionName", "in" : "path", "description" : "Name of the Event Subscription", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Event subscription events record retrieved successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventsRecord" } } } }, "404" : { "description" : "Event subscription not found" }, "500" : { "description" : "Internal server error" } } } }, "/v1/events/subscriptions/testDestination" : { "post" : { "tags" : [ "Events" ], "summary" : "Send a test message alert to external destinations.", "description" : "Send a test message alert to external destinations of the alert.", "operationId" : "testDestination", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventSubscriptionDestinationTestRequest" } } } }, "responses" : { "200" : { "description" : "Test message sent successfully", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "length" : { "type" : "integer", "format" : "int32" }, "location" : { "type" : "string", "format" : "uri" }, "language" : { "type" : "object", "properties" : { "language" : { "type" : "string" }, "displayName" : { "type" : "string" }, "country" : { "type" : "string" }, "variant" : { "type" : "string" }, "script" : { "type" : "string" }, "unicodeLocaleAttributes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "unicodeLocaleKeys" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "displayLanguage" : { "type" : "string" }, "displayScript" : { "type" : "string" }, "displayCountry" : { "type" : "string" }, "displayVariant" : { "type" : "string" }, "extensionKeys" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "iso3Language" : { "type" : "string" }, "iso3Country" : { "type" : "string" } } }, "date" : { "type" : "string", "format" : "date-time" }, "lastModified" : { "type" : "string", "format" : "date-time" }, "status" : { "type" : "integer", "format" : "int32" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "object" } } }, "entity" : { "type" : "object" }, "mediaType" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "subtype" : { "type" : "string" }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "wildcardType" : { "type" : "boolean" }, "wildcardSubtype" : { "type" : "boolean" } } }, "links" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "params" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "uri" : { "type" : "string", "format" : "uri" }, "uriBuilder" : { "type" : "object" }, "rel" : { "type" : "string" }, "rels" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string" } } } }, "statusInfo" : { "type" : "object", "properties" : { "family" : { "type" : "string", "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] }, "reasonPhrase" : { "type" : "string" }, "statusCode" : { "type" : "integer", "format" : "int32" } } }, "allowedMethods" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "cookies" : { "type" : "object", "additionalProperties" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "value" : { "type" : "string" }, "version" : { "type" : "integer", "format" : "int32" }, "path" : { "type" : "string" }, "domain" : { "type" : "string" }, "comment" : { "type" : "string" }, "maxAge" : { "type" : "integer", "format" : "int32" }, "expiry" : { "type" : "string", "format" : "date-time" }, "secure" : { "type" : "boolean" }, "httpOnly" : { "type" : "boolean" } } } }, "entityTag" : { "type" : "object", "properties" : { "value" : { "type" : "string" }, "weak" : { "type" : "boolean" } } }, "stringHeaders" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "headers" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "object" } } } } } } } } } } }, "/v1/events/subscriptions/validation/condition/{expression}" : { "get" : { "tags" : [ "Events" ], "summary" : "Validate a given condition", "description" : "Validate a given condition expression used in filtering rules.", "operationId" : "validateCondition", "parameters" : [ { "name" : "expression", "in" : "path", "description" : "Expression to validate", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No value is returned" }, "400" : { "description" : "Invalid expression" } } } }, "/v1/events/subscriptions/{alertType}/resources" : { "get" : { "tags" : [ "Events" ], "summary" : "Get list of Event Subscriptions Resources used in filtering Event Subscription", "description" : "Get list of EventSubscription functions used in filtering conditions in Event Subscription", "operationId" : "listEventSubscriptionResources", "parameters" : [ { "name" : "alertType", "in" : "path", "description" : "AlertType", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResultListFilterResourceDescriptor" } } } } } } }, "/v1/events/subscriptions/{eventSubscriptionId}/status/{destinationId}" : { "get" : { "tags" : [ "Events" ], "summary" : "Get Event Subscription status by Id", "description" : "Get a event Subscription status by given Name", "operationId" : "getEventSubscriptionStatusById", "parameters" : [ { "name" : "eventSubscriptionId", "in" : "path", "description" : "Name of the Event Subscription", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "destinationId", "in" : "path", "description" : "Destination Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Return the current status of the Event Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionStatus" } } } }, "404" : { "description" : "Entity for instance {id} is not found" } } } }, "/v1/events/subscriptions/{id}" : { "get" : { "tags" : [ "Events" ], "summary" : "Get a event Subscription by ID", "description" : "Get a event Subscription by given Id", "operationId" : "getEventSubscriptionByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Event Subscription", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,filteringRules" } } ], "responses" : { "200" : { "description" : "Entity events", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventSubscription" } } } }, "404" : { "description" : "Entity for instance {id} is not found" } } }, "delete" : { "tags" : [ "Events" ], "summary" : "Delete an Event Subscription by Id", "description" : "Delete an Event Subscription", "operationId" : "deleteEventSubscription", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Event Subscription", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Entity events", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventSubscription" } } } }, "404" : { "description" : "Entity for instance {id} is not found" } } }, "patch" : { "tags" : [ "Events" ], "summary" : "Update an Event Subscriptions", "description" : "Update an existing Event Subscriptions using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchEventSubscription_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the event Subscription", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/events/subscriptions/{id}/processedEvents" : { "get" : { "tags" : [ "Events" ], "summary" : "Check If the Publisher Processed All Events", "description" : "Return a boolean 'true' or 'false' to indicate if the publisher processed all events", "operationId" : "checkIfThePublisherProcessedALlEvents", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Event Subscription", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of Event Subscription versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/events/subscriptions/{id}/versions" : { "get" : { "tags" : [ "Events" ], "summary" : "List Event Subscription versions", "description" : "Get a list of all the versions of an Event Subscription identified by `Id`", "operationId" : "listAllEventSubscriptionVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Event Subscription", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of Event Subscription versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/events/subscriptions/{id}/versions/{version}" : { "get" : { "tags" : [ "Events" ], "summary" : "Get a version of the Event Subscription", "description" : "Get a version of the Event Subscription by given `Id`", "operationId" : "getSpecificEventSubscriptionVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Event Subscription", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Event Subscription version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "Get specific version of Event Subscription", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventSubscription" } } } }, "404" : { "description" : "Event Subscription for instance {id} and version {version} is not found" } } } }, "/v1/feed" : { "get" : { "tags" : [ "Feeds" ], "summary" : "List threads", "description" : "Get a list of threads, optionally filtered by `entityLink`.", "operationId" : "listThreads", "parameters" : [ { "name" : "limitPosts", "in" : "query", "description" : "Limit the number of posts sorted by chronological order (1 to 1000000, default = 3)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int64", "default" : 3 } }, { "name" : "limit", "in" : "query", "description" : "Limit the number of threads returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of threads before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of threads after this cursor", "schema" : { "type" : "string" } }, { "name" : "entityLink", "in" : "query", "description" : "Filter threads by entity link of entity about which this thread is created", "schema" : { "type" : "string", "example" : "<E#/{entityType}/{entityFQN}/{fieldName}>" } }, { "name" : "userId", "in" : "query", "description" : "Filter threads by user id. This filter requires a 'filterType' query param. The default filter type is 'OWNER'. This filter cannot be combined with the entityLink filter.", "schema" : { "type" : "string" } }, { "name" : "filterType", "in" : "query", "description" : "Filter type definition for the user filter. It can take one of 'OWNER', 'FOLLOWS', 'MENTIONS'. This must be used with the 'user' query param", "schema" : { "type" : "string", "enum" : [ "OWNER", "MENTIONS", "FOLLOWS", "ASSIGNED_TO", "ASSIGNED_BY", "OWNER_OR_FOLLOWS" ] } }, { "name" : "resolved", "in" : "query", "description" : "Filter threads by whether they are resolved or not. By default resolved is false", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "type", "in" : "query", "description" : "The type of thread to filter the results. It can take one of 'Conversation', 'Task', 'Announcement'", "schema" : { "type" : "string", "enum" : [ "Conversation", "Task", "Announcement", "Chatbot" ] } }, { "name" : "taskStatus", "in" : "query", "description" : "The status of tasks to filter the results. It can take one of 'Open', 'Closed'. This filter will take effect only when type is set to Task", "schema" : { "type" : "string", "enum" : [ "Open", "Closed" ] } }, { "name" : "activeAnnouncement", "in" : "query", "description" : "Whether to filter results by announcements that are currently active. This filter will take effect only when type is set to Announcement", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "List of threads", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ThreadList" } } } } } }, "post" : { "tags" : [ "Feeds" ], "summary" : "Create a thread", "description" : "Create a new thread. A thread is created about a data asset when a user posts the first post.", "operationId" : "createThread", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateThread" } } } }, "responses" : { "200" : { "description" : "The thread", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Thread" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/feed/count" : { "get" : { "tags" : [ "Feeds" ], "summary" : "Count of threads", "description" : "Get a count of threads, optionally filtered by `entityLink` for each of the entities.", "operationId" : "countThreads", "parameters" : [ { "name" : "entityLink", "in" : "query", "description" : "Filter threads by entity link", "schema" : { "type" : "string", "example" : "<E#/{entityType}/{entityFQN}/{fieldName}>" } } ], "responses" : { "200" : { "description" : "Count of threads", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ThreadCountList" } } } } } } }, "/v1/feed/tasks/{id}" : { "get" : { "tags" : [ "Feeds" ], "summary" : "Get a task thread by task Id", "description" : "Get a task thread by `task Id`.", "operationId" : "getTaskByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the task thread", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The task thread", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Thread" } } } }, "404" : { "description" : "Task for instance {id} is not found" } } } }, "/v1/feed/tasks/{id}/close" : { "put" : { "tags" : [ "Feeds" ], "summary" : "Close a task", "description" : "Close a task without making any changes to the entity.", "operationId" : "closeTask", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the task thread", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CloseTask" } } } }, "responses" : { "200" : { "description" : "The task thread.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Thread" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/feed/tasks/{id}/resolve" : { "put" : { "tags" : [ "Feeds" ], "summary" : "Resolve a task", "description" : "Resolve a task.", "operationId" : "resolveTask", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the task thread", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResolveTask" } } } }, "responses" : { "200" : { "description" : "The task thread", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Thread" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/feed/{id}" : { "get" : { "tags" : [ "Feeds" ], "summary" : "Get a thread by Id", "description" : "Get a thread by `Id`.", "operationId" : "getThreadByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Thread", "required" : true, "schema" : { "type" : "string" } }, { "name" : "entityType", "in" : "path", "description" : "Type of the Entity", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The thread", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Thread" } } } }, "404" : { "description" : "Thread for instance {id} is not found" } } }, "patch" : { "tags" : [ "Feeds" ], "summary" : "Update a thread by `Id`.", "description" : "Update an existing thread using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchThread", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the thread", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/feed/{id}/posts" : { "get" : { "tags" : [ "Feeds" ], "summary" : "Get all the posts of a thread", "description" : "Get all the posts of an existing thread.", "operationId" : "getAllPostOfThread", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the thread", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The posts of the given thread.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PostList" } } } } } }, "post" : { "tags" : [ "Feeds" ], "summary" : "Add post to a thread", "description" : "Add a post to an existing thread.", "operationId" : "addPostToThread", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the thread", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreatePost" } } } }, "responses" : { "200" : { "description" : "The post", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Thread" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/feed/{threadId}" : { "delete" : { "tags" : [ "Feeds" ], "summary" : "Delete a thread by Id", "description" : "Delete an existing thread and all its relationships.", "operationId" : "deleteThread", "parameters" : [ { "name" : "threadId", "in" : "path", "description" : "ThreadId of the thread to be deleted", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "thread with {threadId} is not found" }, "400" : { "description" : "Bad request" } } } }, "/v1/feed/{threadId}/posts/{postId}" : { "delete" : { "tags" : [ "Feeds" ], "summary" : "Delete a post from its thread", "description" : "Delete a post from an existing thread.", "operationId" : "deletePostFromThread", "parameters" : [ { "name" : "threadId", "in" : "path", "description" : "ThreadId of the post to be deleted", "required" : true, "schema" : { "type" : "string" } }, { "name" : "postId", "in" : "path", "description" : "PostId of the post to be deleted", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "post with {postId} is not found" }, "400" : { "description" : "Bad request" } } }, "patch" : { "tags" : [ "Feeds" ], "summary" : "Update post of a thread by `Id`.", "description" : "Update a post of an existing thread using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchPostOfThread", "parameters" : [ { "name" : "threadId", "in" : "path", "description" : "Id of the thread", "required" : true, "schema" : { "type" : "string" } }, { "name" : "postId", "in" : "path", "description" : "Id of the post", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "400" : { "description" : "Bad request" }, "404" : { "description" : "post with {postId} is not found" } } } }, "/v1/glossaries" : { "get" : { "tags" : [ "Glossaries" ], "summary" : "List glossaries", "description" : "Get a list of glossaries. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listGlossaries", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tags,reviewers,usageCount,termCount,domain,extension" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number glossaries returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of glossaries before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of glossaries after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of glossaries", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GlossaryList" } } } } } }, "put" : { "tags" : [ "Glossaries" ], "summary" : "Create or update a glossary", "description" : "Create a new glossary, if it does not exist or update an existing glossary.", "operationId" : "createOrUpdateGlossary", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateGlossary" } } } }, "responses" : { "200" : { "description" : "The glossary", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Glossary" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Glossaries" ], "summary" : "Create a glossary", "description" : "Create a new glossary.", "operationId" : "createGlossary", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateGlossary" } } } }, "responses" : { "200" : { "description" : "The glossary", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Glossary" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/glossaries/documentation/csv" : { "get" : { "tags" : [ "Glossaries" ], "summary" : "Get CSV documentation", "operationId" : "getCsvDocumentation", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/v1/glossaries/name/{fqn}" : { "patch" : { "tags" : [ "Glossaries" ], "summary" : "Update a glossary using name.", "description" : "Update an existing glossary using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchGlossary", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the glossary", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/glossaries/name/{name}" : { "get" : { "tags" : [ "Glossaries" ], "summary" : "Get a glossary by name", "description" : "Get a glossary by name.", "operationId" : "getGlossaryByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the glossary", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tags,reviewers,usageCount,termCount,domain,extension" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The glossary", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Glossary" } } } }, "404" : { "description" : "Glossary for instance {name} is not found" } } }, "delete" : { "tags" : [ "Glossaries" ], "summary" : "Delete a glossary by name", "description" : "Delete a glossary by `name`.", "operationId" : "deleteGlossaryByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the glossary", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "glossary for instance {name} is not found" } } } }, "/v1/glossaries/name/{name}/export" : { "get" : { "tags" : [ "Glossaries" ], "summary" : "Export glossary in CSV format", "operationId" : "exportGlossary", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the glossary", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with glossary terms", "content" : { "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/v1/glossaries/name/{name}/exportAsync" : { "get" : { "tags" : [ "Glossaries" ], "summary" : "Export glossary in CSV format", "operationId" : "exportGlossary_1", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the glossary", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with glossary terms", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CSVExportResponse" } } } } } } }, "/v1/glossaries/name/{name}/import" : { "put" : { "tags" : [ "Glossaries" ], "summary" : "Import glossary terms from CSV to create, and update glossary terms", "operationId" : "importGlossary", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the glossary", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry-run when true is used for validating the CSV without really importing it. (default=true)", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Import result", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/glossaries/name/{name}/importAsync" : { "put" : { "tags" : [ "Glossaries" ], "summary" : "Import glossary in CSV format asynchronously", "operationId" : "importGlossaryAsync", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the glossary", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry run the import", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "description" : "CSV data to import", "content" : { "text/plain" : { "schema" : { "type" : "string" } } }, "required" : true }, "responses" : { "200" : { "description" : "Import initiated successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/glossaries/restore" : { "put" : { "tags" : [ "Glossaries" ], "summary" : "Restore a soft deleted glossary", "description" : "Restore a soft deleted Glossary.", "operationId" : "restore_15", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Glossary ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Glossary" } } } } } } }, "/v1/glossaries/{id}" : { "get" : { "tags" : [ "Glossaries" ], "summary" : "Get a glossary by Id", "description" : "Get a glossary by `Id`.", "operationId" : "getGlossaryByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the glossary", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tags,reviewers,usageCount,termCount,domain,extension" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The glossary", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Glossary" } } } }, "404" : { "description" : "Glossary for instance {id} is not found" } } }, "delete" : { "tags" : [ "Glossaries" ], "summary" : "Delete a glossary by Id", "description" : "Delete a glossary by `Id`.", "operationId" : "deleteGlossary", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the glossary", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "glossary for instance {id} is not found" } } }, "patch" : { "tags" : [ "Glossaries" ], "summary" : "Update a glossary", "description" : "Update an existing glossary using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchGlossary_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the glossary", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/glossaries/{id}/versions" : { "get" : { "tags" : [ "Glossaries" ], "summary" : "List glossary versions", "description" : "Get a list of all the versions of a glossary identified by `id`", "operationId" : "listAllGlossaryVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the glossary", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of glossary versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/glossaries/{id}/versions/{version}" : { "get" : { "tags" : [ "Glossaries" ], "summary" : "Get a version of the glossaries", "description" : "Get a version of the glossary by given `Id`", "operationId" : "getSpecificGlossaryVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the glossary", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "glossary version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "glossaries", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Glossary" } } } }, "404" : { "description" : "Glossary for instance {id} and version {version} is not found" } } } }, "/v1/glossaries/{id}/vote" : { "put" : { "tags" : [ "Glossaries" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_7", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/glossaryTerms" : { "get" : { "tags" : [ "Glossaries" ], "summary" : "List glossary terms", "description" : "Get a list of glossary terms. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listGlossaryTerm", "parameters" : [ { "name" : "glossary", "in" : "query", "description" : "List glossary terms filtered by glossary identified by Id given in `glossary` parameter.", "schema" : { "type" : "string", "example" : "children,relatedTerms,reviewers,owners,tags,usageCount,domain,extension,childrenCount" } }, { "name" : "parent", "in" : "query", "description" : "List glossary terms filtered by children of glossary term identified by Id given in `parent` parameter.", "schema" : { "type" : "string", "example" : "children,relatedTerms,reviewers,owners,tags,usageCount,domain,extension,childrenCount" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "children,relatedTerms,reviewers,owners,tags,usageCount,domain,extension,childrenCount" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number glossary terms returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of glossary terms before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of glossary terms after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } }, { "name" : "directChildrenOf", "in" : "query", "description" : "List glossary terms filtered to retrieve the first level/immediate children of the glossary term `directChildrenOf` parameter.", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of glossary terms", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GlossaryTermList" } } } } } }, "put" : { "tags" : [ "Glossaries" ], "summary" : "Create or update a glossary term", "description" : "Create a new glossary term, if it does not exist or update an existing glossary term.", "operationId" : "createOrUpdateGlossaryTerm", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateGlossaryTerm" } } } }, "responses" : { "200" : { "description" : "The glossary", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GlossaryTerm" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Glossaries" ], "summary" : "Create a glossary term", "description" : "Create a new glossary term.", "operationId" : "createGlossaryTerm", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateGlossaryTerm" } } } }, "responses" : { "200" : { "description" : "The glossary term", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GlossaryTerm" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/glossaryTerms/name/{fqn}" : { "get" : { "tags" : [ "Glossaries" ], "summary" : "Get a glossary term by fully qualified name", "description" : "Get a glossary term by `fullyQualifiedName`.", "operationId" : "getGlossaryTermByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the glossary term", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "children,relatedTerms,reviewers,owners,tags,usageCount,domain,extension,childrenCount" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The glossary term", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GlossaryTerm" } } } }, "404" : { "description" : "Glossary term for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Glossaries" ], "summary" : "Delete a glossary term by fully qualified name", "description" : "Delete a glossary term by `fullyQualifiedName`.", "operationId" : "deleteGlossaryTermByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the glossary term", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "glossaryTerm for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Glossaries" ], "summary" : "Update a glossary term by name.", "description" : "Update an existing glossary term using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchGlossaryTerm", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the glossary term", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/glossaryTerms/restore" : { "put" : { "tags" : [ "Glossaries" ], "summary" : "Restore a soft deleted glossary term", "description" : "Restore a soft deleted glossary term.", "operationId" : "restore_16", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Chart ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GlossaryTerm" } } } } } } }, "/v1/glossaryTerms/{id}" : { "get" : { "tags" : [ "Glossaries" ], "summary" : "Get a glossary term by Id", "description" : "Get a glossary term by `Id`.", "operationId" : "getGlossaryTermByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the glossary term", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "children,relatedTerms,reviewers,owners,tags,usageCount,domain,extension,childrenCount" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The glossary term", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GlossaryTerm" } } } }, "404" : { "description" : "Glossary term for instance {id} is not found" } } }, "delete" : { "tags" : [ "Glossaries" ], "summary" : "Delete a glossary term by Id", "description" : "Delete a glossary term by `Id`.", "operationId" : "delete", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the glossary term", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "glossaryTerm for instance {id} is not found" } } }, "patch" : { "tags" : [ "Glossaries" ], "summary" : "Update a glossary term", "description" : "Update an existing glossary term using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchGlossaryTerm_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the glossary term", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/glossaryTerms/{id}/assets/add" : { "put" : { "tags" : [ "Glossaries" ], "summary" : "Bulk Add Glossary Term to Assets", "description" : "Bulk Add Glossary Term to Assets", "operationId" : "bulkAddGlossaryTermToAssets", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddGlossaryToAssetsRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkOperationResult" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/glossaryTerms/{id}/assets/remove" : { "put" : { "tags" : [ "Glossaries" ], "summary" : "Bulk Remove Glossary Term from Assets", "description" : "Bulk Remove Glossary Term from Assets", "operationId" : "bulkRemoveGlossaryTermFromAssets", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddGlossaryToAssetsRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/glossaryTerms/{id}/tags/validate" : { "put" : { "tags" : [ "Glossaries" ], "summary" : "Validate Tags Addition to Glossary Term", "description" : "Validate Tags Addition to Glossary Term", "operationId" : "validateGlossaryTermTagsAddition", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddGlossaryToAssetsRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkOperationResult" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/glossaryTerms/{id}/versions" : { "get" : { "tags" : [ "Glossaries" ], "summary" : "List glossary term versions", "description" : "Get a list of all the versions of a glossary terms identified by `id`", "operationId" : "listAllGlossaryTermVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the glossary term", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of glossary term versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/glossaryTerms/{id}/versions/{version}" : { "get" : { "tags" : [ "Glossaries" ], "summary" : "Get a version of the glossary term", "description" : "Get a version of the glossary term by given `Id`", "operationId" : "getSpecificGlossaryTermVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the glossary term", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "glossary term version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "The glossary term", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GlossaryTerm" } } } }, "404" : { "description" : "Glossary term for instance {id} and version {version} is not found" } } } }, "/v1/glossaryTerms/{id}/vote" : { "put" : { "tags" : [ "Glossaries" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_8", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/governance/workflowDefinitions" : { "get" : { "tags" : [ "Workflow Definitions" ], "summary" : "List Workflow Definitions", "description" : "Get a list of Workflow Definitions. Use `fields` parameter to get only necessary fields. Use cursor-based pagination tom limit the number of entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listWorkflowDefinitions", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number of Workflow Definitions returned. Default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns the list of Workflow Definitions before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns the list of Workflow Definitions after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of Workflow Definitions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowDefinitionList" } } } } } }, "put" : { "tags" : [ "Workflow Definitions" ], "summary" : "Create or update Workflow Definition", "description" : "Create a Workflow Definition, if it does not exist or update an existing Workflow Definition.", "operationId" : "createOrUpdateWorkflowDefinition", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateWorkflowDefinition" } } } }, "responses" : { "200" : { "description" : "The updated Workflow Definition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowDefinition" } } } } } }, "post" : { "tags" : [ "Workflow Definitions" ], "summary" : "Create a Workflow Definition", "description" : "Create a Workflow Definition.", "operationId" : "createWorkflowDefinition", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateWorkflowDefinition" } } } }, "responses" : { "200" : { "description" : "The Workflow Definition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowDefinition" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/governance/workflowDefinitions/name/{fqn}" : { "get" : { "tags" : [ "Workflow Definitions" ], "summary" : "Get a Workflow Definition by fully qualified name", "description" : "Get a Workflow Definition by `fullyQualifiedName`.", "operationId" : "getWorkflowDefinitionByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the Workflow Definition", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The Workflow Definition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowDefinition" } } } }, "404" : { "description" : "Workflow Definition for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Workflow Definitions" ], "summary" : "Delete a Workflow Definition by fully qualified name", "description" : "Delete a Workflow Definition by `fullyQualifiedName`.", "operationId" : "deleteWorkflowDefinitionByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the Workflow Definition", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Workflow Definition for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Workflow Definitions" ], "summary" : "Update a Workflow Definition by name.", "description" : "Update an existing Workflow Definition using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchWorkflowDefinition", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the Workflow Definition", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/governance/workflowDefinitions/name/{fqn}/trigger" : { "post" : { "tags" : [ "Workflow Definitions" ], "summary" : "Start a new instance of a Workflow Definition", "description" : "Start a new instance of a Workflow Definition.", "operationId" : "triggerWorkflow", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the Workflow Definition", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Workflow trigger status code", "content" : { "application/json" : { } } }, "404" : { "description" : "Workflow Definition named '{fqn}' is not found" } } } }, "/v1/governance/workflowDefinitions/restore" : { "put" : { "tags" : [ "Workflow Definitions" ], "summary" : "Restore a soft deleted Workflow Definition.", "description" : "Restore a soft deleted Workflow Definition.", "operationId" : "restore_17", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Workflow Definition. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowDefinition" } } } } } } }, "/v1/governance/workflowDefinitions/{id}" : { "get" : { "tags" : [ "Workflow Definitions" ], "summary" : "Get a Workflow Definition by Id", "description" : "Get a Workflow Definition by `Id`.", "operationId" : "getWorkflowDefinitionByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Workflow Definition", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The Workflow Definition", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowDefinition" } } } }, "404" : { "description" : "Workflow Definition for instance {id} is not found" } } }, "delete" : { "tags" : [ "Workflow Definitions" ], "summary" : "Delete a Workflow Definition by Id", "description" : "Delete a Workflow Definition by `Id`.", "operationId" : "deleteWorkflowDefinition", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the Workflow Definition", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Workflow Definition for instance {id} is not found" } } }, "patch" : { "tags" : [ "Workflow Definitions" ], "summary" : "Update a Workflow Definition by Id", "description" : "Update an existing Workflow Definition using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchWorkflowDefinition_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Workflow Definition", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/governance/workflowDefinitions/{id}/versions" : { "get" : { "tags" : [ "Workflow Definitions" ], "summary" : "List Workflow Definition versions", "description" : "Get a list of all the versions of a Workflow Definition identified by `Id`", "operationId" : "listAllWorkflowDefinitionVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Workflow Definition", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of Workflow Definition versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/governance/workflowDefinitions/{id}/versions/{version}" : { "get" : { "tags" : [ "Workflow Definitions" ], "summary" : "Get a version of the Workflow Definition", "description" : "Get a version of the Workflow Definition by given `Id`", "operationId" : "getSpecificWorkflowDefinitionVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Workflow Definition", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "WorkflowDefinition version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "database", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowDefinition" } } } }, "404" : { "description" : "Workflow Definition for instance {id} and version {version} is not found" } } } }, "/v1/governance/workflowInstanceStates" : { "get" : { "tags" : [ "Workflow Instance States" ], "summary" : "List the Workflow Instance States", "description" : "Get a list of all the workflow instances states, filtered by `startTs` and `endTs` of the creation. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listWorkflowInstanceStates", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Limit the number of Workflow Instance States returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "offset", "in" : "query", "description" : "Returns list of Workflow Instance States at the offset", "schema" : { "type" : "string" } }, { "name" : "startTs", "in" : "query", "description" : "Filter Workflow Instance States after the given start timestamp", "schema" : { "type" : "number" } }, { "name" : "endTs", "in" : "query", "description" : "Filter Workflow Instance States before the given end timestamp", "schema" : { "type" : "number" } }, { "name" : "latest", "in" : "query", "description" : "Only list the latest Workflow Instance States", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "List of Workflow Instances", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowInstanceStateResultList" } } } } } } }, "/v1/governance/workflowInstanceStates/{id}" : { "get" : { "tags" : [ "Workflow Instance States" ], "summary" : "Get a Workflow Instance State by id", "description" : "Get a Workflow Instance State by id", "operationId" : "getWorkflowInstanceStateById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Workflow Instance State ID", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "The Workflow Instance State", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowInstanceState" } } } } } } }, "/v1/governance/workflowInstanceStates/{workflowDefinitionName}/{workflowInstanceId}" : { "get" : { "tags" : [ "Workflow Instance States" ], "summary" : "Get all the Workflow Instance States for a Workflow Instance id", "description" : "Get all the Workflow Instance States for a Workflow Instancee id", "operationId" : "getWorkflowInstanceStatesForAWorkflowInstanceId", "parameters" : [ { "name" : "workflowDefinitionName", "in" : "path", "description" : "Workflow Definition Name", "required" : true, "schema" : { "type" : "string" } }, { "name" : "workflowInstanceId", "in" : "path", "description" : "Workflow Instance ID", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number of Workflow Instance States returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "offset", "in" : "query", "description" : "Returns list of Workflow Instance States at the offset", "schema" : { "type" : "string" } }, { "name" : "startTs", "in" : "query", "description" : "Filter Workflow Instance States after the given start timestamp", "schema" : { "type" : "number" } }, { "name" : "endTs", "in" : "query", "description" : "Filter Workflow Instance States before the given end timestamp", "schema" : { "type" : "number" } }, { "name" : "latest", "in" : "query", "description" : "Only list the latest Workflow Instance States", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "The Workflow Instance States", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowInstanceStateResultList" } } } } } } }, "/v1/governance/workflowInstances" : { "get" : { "tags" : [ "Workflow Instances" ], "summary" : "List the Workflow Instances", "description" : "Get a list of all the workflow instances, filtered by `startTs` and `endTs` of the creation, and Workflow Definition FQN. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listWorkflowInstances", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Limit the number of Workflow Instances returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "offset", "in" : "query", "description" : "Returns list of Workflow Instances at the offset", "schema" : { "type" : "string" } }, { "name" : "startTs", "in" : "query", "description" : "Filter Workflow Instances after the given start timestamp", "schema" : { "type" : "number" } }, { "name" : "endTs", "in" : "query", "description" : "Filter Workflow Instances before the given end timestamp", "schema" : { "type" : "number" } }, { "name" : "latest", "in" : "query", "description" : "Only list the latest Workflow Instance", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "workflowDefinitionName", "in" : "query", "description" : "Workflow Definition Name", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of Workflow Instances", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowInstanceResultList" } } } } } } }, "/v1/lineage" : { "put" : { "tags" : [ "Lineage" ], "summary" : "Add a lineage edge", "description" : "Add a lineage edge with from entity as upstream node and to entity as downstream node.", "operationId" : "addLineageEdge", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddLineage" } } } }, "responses" : { "404" : { "description" : "Entity for instance {id} is not found" } } } }, "/v1/lineage/export" : { "get" : { "tags" : [ "Lineage" ], "summary" : "Export lineage", "operationId" : "exportLineage", "parameters" : [ { "name" : "fqn", "in" : "query", "description" : "fqn", "schema" : { "type" : "string" } }, { "name" : "upstreamDepth", "in" : "query", "description" : "upstreamDepth", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "downstreamDepth", "in" : "query", "description" : "downstreamDepth", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "query_filter", "in" : "query", "description" : "Elasticsearch query that will be combined with the query_string query generator from the `query` argument", "schema" : { "type" : "string" } }, { "name" : "includeDeleted", "in" : "query", "description" : "Filter documents by deleted param. By default deleted is false", "schema" : { "type" : "boolean" } }, { "name" : "type", "in" : "query", "description" : "entity type", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "search response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchResponse" } } } } } } }, "/v1/lineage/exportAsync" : { "get" : { "tags" : [ "Lineage" ], "summary" : "Export lineage", "operationId" : "exportLineage_1", "parameters" : [ { "name" : "fqn", "in" : "query", "description" : "fqn", "schema" : { "type" : "string" } }, { "name" : "upstreamDepth", "in" : "query", "description" : "upstreamDepth", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "downstreamDepth", "in" : "query", "description" : "downstreamDepth", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "query_filter", "in" : "query", "description" : "Elasticsearch query that will be combined with the query_string query generator from the `query` argument", "schema" : { "type" : "string" } }, { "name" : "includeDeleted", "in" : "query", "description" : "Filter documents by deleted param. By default deleted is false", "schema" : { "type" : "boolean" } }, { "name" : "type", "in" : "query", "description" : "entity type", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "search response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CSVExportMessage" } } } } } } }, "/v1/lineage/getDataQualityLineage" : { "get" : { "tags" : [ "Lineage" ], "summary" : "Search Data Quality lineage", "operationId" : "searchDataQualityLineage", "parameters" : [ { "name" : "fqn", "in" : "query", "description" : "fqn", "schema" : { "type" : "string" } }, { "name" : "upstreamDepth", "in" : "query", "description" : "upstreamDepth", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "query_filter", "in" : "query", "description" : "Elasticsearch query that will be combined with the query_string query generator from the `query` argument", "schema" : { "type" : "string" } }, { "name" : "includeDeleted", "in" : "query", "description" : "Filter documents by deleted param. By default deleted is false", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "search response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchResponse" } } } } } } }, "/v1/lineage/getLineage" : { "get" : { "tags" : [ "Lineage" ], "summary" : "Search lineage", "operationId" : "searchLineage", "parameters" : [ { "name" : "fqn", "in" : "query", "description" : "fqn", "schema" : { "type" : "string" } }, { "name" : "upstreamDepth", "in" : "query", "description" : "upstreamDepth", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "downstreamDepth", "in" : "query", "description" : "downstreamDepth", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "query_filter", "in" : "query", "description" : "Elasticsearch query that will be combined with the query_string query generator from the `query` argument", "schema" : { "type" : "string" } }, { "name" : "includeDeleted", "in" : "query", "description" : "Filter documents by deleted param. By default deleted is false", "schema" : { "type" : "boolean" } }, { "name" : "type", "in" : "query", "description" : "entity type", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "search response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchResponse" } } } } } } }, "/v1/lineage/getLineageEdge/{fromId}/{toId}" : { "get" : { "tags" : [ "Lineage" ], "summary" : "Get a lineage edge", "description" : "Get a lineage edge with from entity as upstream node and to entity as downstream node.", "operationId" : "getLineageEdge", "parameters" : [ { "name" : "fromId", "in" : "path", "description" : "Entity FQN", "required" : true, "schema" : { "type" : "string" } }, { "name" : "toId", "in" : "path", "description" : "Entity FQN", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "404" : { "description" : "Entity for instance {fromId} is not found" } } } }, "/v1/lineage/{entityType}/{entityId}/type/{lineageSource}" : { "delete" : { "tags" : [ "Lineage" ], "summary" : "Delete a lineage edge by Type", "description" : "Delete a lineage edge with from entity as upstream node and to entity as downstream node by source of lineage", "operationId" : "deleteLineageEdgeByType", "parameters" : [ { "name" : "entityType", "in" : "path", "description" : "Entity type of upstream entity of the edge", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "entityId", "in" : "path", "description" : "Entity ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "lineageSource", "in" : "path", "description" : "Lineage Type", "required" : true, "schema" : { "type" : "string", "example" : "ViewLineage" } } ], "responses" : { "404" : { "description" : "Entity for instance {entityFQN} is not found" } } } }, "/v1/lineage/{entity}/name/{fqn}" : { "get" : { "tags" : [ "Lineage" ], "summary" : "Get lineage by fully qualified name", "description" : "Get lineage details for an entity identified by fully qualified name.", "operationId" : "getLineageByFQN", "parameters" : [ { "name" : "entity", "in" : "path", "description" : "Entity type for which lineage is requested", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the entity that uniquely identifies an entity", "required" : true, "schema" : { "type" : "string" } }, { "name" : "upstreamDepth", "in" : "query", "description" : "Upstream depth of lineage (default=1, min=0, max=3)", "schema" : { "maximum" : 3, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 1 } }, { "name" : "downstreamDepth", "in" : "query", "description" : "Upstream depth of lineage (default=1, min=0, max=3)", "schema" : { "maximum" : 3, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 1 } } ], "responses" : { "200" : { "description" : "Entity lineage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityLineage" } } } }, "404" : { "description" : "Entity for instance {fqn} is not found" } } } }, "/v1/lineage/{entity}/{id}" : { "get" : { "tags" : [ "Lineage" ], "summary" : "Get lineage by Id", "description" : "Get lineage details for an entity identified by `Id`.", "operationId" : "getLineage", "parameters" : [ { "name" : "entity", "in" : "path", "description" : "Entity type for which lineage is requested", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "id", "in" : "path", "description" : "Id of the entity", "required" : true, "schema" : { "type" : "string" } }, { "name" : "upstreamDepth", "in" : "query", "description" : "Upstream depth of lineage (default=1, min=0, max=3)", "schema" : { "maximum" : 3, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 1 } }, { "name" : "downstreamDepth", "in" : "query", "description" : "Upstream depth of lineage (default=1, min=0, max=3)", "schema" : { "maximum" : 3, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 1 } } ], "responses" : { "200" : { "description" : "Entity lineage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityLineage" } } } }, "404" : { "description" : "Entity for instance {id} is not found" } } } }, "/v1/lineage/{fromEntity}/name/{fromFQN}/{toEntity}/name/{toFQN}" : { "delete" : { "tags" : [ "Lineage" ], "summary" : "Delete a lineage edge by FQNs", "description" : "Delete a lineage edge with from entity as upstream node and to entity as downstream node.", "operationId" : "deleteLineageEdgeByName", "parameters" : [ { "name" : "fromEntity", "in" : "path", "description" : "Entity type of upstream entity of the edge", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "fromFQN", "in" : "path", "description" : "Entity FQN", "required" : true, "schema" : { "type" : "string" } }, { "name" : "toEntity", "in" : "path", "description" : "Entity type for downstream entity of the edge", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "toFQN", "in" : "path", "description" : "Entity FQN", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "404" : { "description" : "Entity for instance {fromFQN} is not found" } } } }, "/v1/lineage/{fromEntity}/{fromId}/{toEntity}/{toId}" : { "delete" : { "tags" : [ "Lineage" ], "summary" : "Delete a lineage edge", "description" : "Delete a lineage edge with from entity as upstream node and to entity as downstream node.", "operationId" : "deleteLineageEdge", "parameters" : [ { "name" : "fromEntity", "in" : "path", "description" : "Entity type of upstream entity of the edge", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "fromId", "in" : "path", "description" : "Entity id", "required" : true, "schema" : { "type" : "string" } }, { "name" : "toEntity", "in" : "path", "description" : "Entity type for downstream entity of the edge", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "toId", "in" : "path", "description" : "Entity id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "404" : { "description" : "Entity for instance {fromId} is not found" } } }, "patch" : { "tags" : [ "Lineage" ], "summary" : "Patch a lineage edge", "description" : "Patch a lineage edge with from entity as upstream node and to entity as downstream node.", "operationId" : "patchLineageEdge", "parameters" : [ { "name" : "fromEntity", "in" : "path", "description" : "Entity type of upstream entity of the edge", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "fromId", "in" : "path", "description" : "Entity id", "required" : true, "schema" : { "type" : "string" } }, { "name" : "toEntity", "in" : "path", "description" : "Entity type for downstream entity of the edge", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "toId", "in" : "path", "description" : "Entity id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "404" : { "description" : "Entity for instance {fromId} is not found" } } } }, "/v1/metadata/types" : { "get" : { "tags" : [ "Metadata" ], "summary" : "List types", "description" : "Get a list of types. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listTypes", "parameters" : [ { "name" : "category", "in" : "query", "description" : "Filter types by metadata type category.", "schema" : { "type" : "string", "example" : "Property, Entity" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number types returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of types before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of types after this cursor", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of types", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TypeList" } } } } } }, "put" : { "tags" : [ "Metadata" ], "summary" : "Create or update a type", "description" : "Create a new type, if it does not exist or update an existing type.", "operationId" : "createOrUpdate", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateType" } } } }, "responses" : { "200" : { "description" : "The type", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Type" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Metadata" ], "summary" : "Create a type", "description" : "Create a new type.", "operationId" : "createType", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateType" } } } }, "responses" : { "200" : { "description" : "The type", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Type" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/metadata/types/customProperties" : { "get" : { "tags" : [ "Metadata" ], "operationId" : "getAllCustomPropertiesByEntityType", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/metadata/types/fields/{entityType}" : { "get" : { "tags" : [ "Metadata" ], "operationId" : "getEntityTypeFields", "parameters" : [ { "name" : "entityType", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/metadata/types/name/{fqn}" : { "patch" : { "tags" : [ "Metadata" ], "summary" : "Update a type using name.", "description" : "Update an existing type using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchType", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the type", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/metadata/types/name/{name}" : { "get" : { "tags" : [ "Metadata" ], "summary" : "Get a type by name", "description" : "Get a type by name.", "operationId" : "getTypeByName", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the type", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "customProperties" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The type", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Type" } } } }, "404" : { "description" : "Type for instance {name} is not found" } } }, "delete" : { "tags" : [ "Metadata" ], "summary" : "Delete a type by name", "description" : "Delete a type by `name`.", "operationId" : "deleteTypeByName", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the type", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "type for instance {name} is not found" } } } }, "/v1/metadata/types/{id}" : { "get" : { "tags" : [ "Metadata" ], "summary" : "Get a type", "description" : "Get a type by `id`.", "operationId" : "getTypeByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the type", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "customProperties" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The type", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Type" } } } }, "404" : { "description" : "Type for instance {id} is not found" } } }, "put" : { "tags" : [ "Metadata" ], "summary" : "Add or update a Property to an entity", "description" : "Add or update a property to an entity type. Properties can only be added to entity type and not property type.", "operationId" : "addProperty", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the type", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomProperty" } } } }, "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "type for instance {id} is not found" } } }, "delete" : { "tags" : [ "Metadata" ], "summary" : "Delete a type by id", "description" : "Delete a type by `id`.", "operationId" : "deleteType", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the type", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "type for instance {id} is not found" } } }, "patch" : { "tags" : [ "Metadata" ], "summary" : "Update a type", "description" : "Update an existing type using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchType_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the type", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/metadata/types/{id}/versions" : { "get" : { "tags" : [ "Metadata" ], "summary" : "List type versions", "description" : "Get a list of all the versions of a type identified by `id`", "operationId" : "listAllTypeVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the type", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of type versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/metadata/types/{id}/versions/{version}" : { "get" : { "tags" : [ "Metadata" ], "summary" : "Get a version of the types", "description" : "Get a version of the type by given `id`", "operationId" : "getSpecificTypeVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the type", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "type version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "types", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Type" } } } }, "404" : { "description" : "Type for instance {id} and version {version} is not found" } } } }, "/v1/metrics" : { "get" : { "tags" : [ "Metrics" ], "summary" : "List metrics", "description" : "Get a list of metrics. Use `fields` parameter to get only necessary fields.", "operationId" : "listMetrics", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,relatedMetrics,followers,tags,extension,domain,dataProducts" } }, { "name" : "limit", "in" : "query", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of metrics before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of metrics after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of metrics", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetricsList" } } } } } }, "put" : { "tags" : [ "Metrics" ], "summary" : "Create or update a metric", "description" : "Create a new metric, if it does not exist or update an existing metric.", "operationId" : "createOrUpdateMetric", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateMetric" } } } }, "responses" : { "200" : { "description" : "The metric", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Metric" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Metrics" ], "summary" : "Create a Metric", "description" : "Create a Metric.", "operationId" : "createMetric", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateMetric" } } } }, "responses" : { "200" : { "description" : "The Metric", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Metric" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/metrics/name/{fqn}" : { "get" : { "tags" : [ "Metrics" ], "summary" : "Get a Metric by fully qualified name.", "description" : "Get a Metric by fully qualified name.", "operationId" : "getMetricByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the Metric", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,relatedMetrics,followers,tags,extension,domain,dataProducts" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The Metric", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Metric" } } } }, "404" : { "description" : "Metric for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Metrics" ], "summary" : "Delete a Metric by fully qualified name", "description" : "Delete a Metric by `fullyQualifiedName`.", "operationId" : "deleteAPIEndpointByFQN_1", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the Metric", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Metric for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Metrics" ], "summary" : "Update a Metric using name.", "description" : "Update an existing Metric using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchMetric", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the Metric", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/metrics/restore" : { "put" : { "tags" : [ "Metrics" ], "summary" : "Restore a soft deleted Metric.", "description" : "Restore a soft deleted Metric.", "operationId" : "restore_18", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Metric.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Metric" } } } } } } }, "/v1/metrics/{id}" : { "get" : { "tags" : [ "Metrics" ], "summary" : "Get a metric by Id", "description" : "Get a metric by `Id`.", "operationId" : "getMetricByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the metric", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,relatedMetrics,followers,tags,extension,domain,dataProducts" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The metrics", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Metric" } } } }, "404" : { "description" : "Metrics for instance {id} is not found" } } }, "delete" : { "tags" : [ "Metrics" ], "summary" : "Delete a Metric by id", "description" : "Delete a Metric by `id`.", "operationId" : "deleteMetric", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the Metric", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Metric for instance {id} is not found" } } }, "patch" : { "tags" : [ "Metrics" ], "summary" : "Update a Metric", "description" : "Update an existing Metric using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchMetric_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Metric", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/metrics/{id}/followers" : { "put" : { "tags" : [ "Metrics" ], "summary" : "Add a follower", "description" : "Add a user identified by `userId` as followed of this Metric.", "operationId" : "addFollower_2", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Metric", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "Id of the user to be added as follower", "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "uuid" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "APIEndpoint for instance {id} is not found" } } } }, "/v1/metrics/{id}/followers/{userId}" : { "delete" : { "tags" : [ "Metrics" ], "summary" : "Remove a follower", "description" : "Remove the user identified `userId` as a follower of the Metric.", "operationId" : "deleteFollower_3", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Metric", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed as follower", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } } } } }, "/v1/metrics/{id}/versions" : { "get" : { "tags" : [ "Metrics" ], "summary" : "List Metric versions", "description" : "Get a list of all the versions of a metric identified by `id`", "operationId" : "listAllMetricVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the metric", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of Metric versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/metrics/{id}/versions/{version}" : { "get" : { "tags" : [ "Metrics" ], "summary" : "Get a version of the Metric", "description" : "Get a version of the Metric by given `id`", "operationId" : "getSpecificEndpointVersion_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Metric", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Metric version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "Metric Version", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Metric" } } } }, "404" : { "description" : "Metric for instance {id} and version {version} is not found" } } } }, "/v1/metrics/{id}/vote" : { "put" : { "tags" : [ "Metrics" ], "summary" : "Update Vote for a Metric", "description" : "Update vote for a Metric", "operationId" : "updateVoteForMetric", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/mlmodels" : { "get" : { "tags" : [ "ML Models" ], "summary" : "List ML models", "description" : "Get a list of mlmodels, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listMlModels", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,dashboard,followers,tags,usageSummary,extension,domain,sourceHash" } }, { "name" : "service", "in" : "query", "description" : "Filter MlModels by service name", "schema" : { "type" : "string", "example" : "airflow" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number models returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of models before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of models after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of models", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModelList" } } } } } }, "put" : { "tags" : [ "ML Models" ], "summary" : "Create or update an ML model", "description" : "Create a new ML model, if it does not exist or update an existing model.", "operationId" : "createOrUpdateMlModel", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateMlModel" } } } }, "responses" : { "200" : { "description" : "The model", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModel" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "ML Models" ], "summary" : "Create an ML model", "description" : "Create a new ML model.", "operationId" : "createMlModel", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateMlModel" } } } }, "responses" : { "200" : { "description" : "ML Model", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModel" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/mlmodels/name/{fqn}" : { "get" : { "tags" : [ "ML Models" ], "summary" : "Get an ML model by fully qualified name", "description" : "Get an ML model by fully qualified name.", "operationId" : "getMlModelByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of ML Model", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,dashboard,followers,tags,usageSummary,extension,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The model", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModel" } } } }, "404" : { "description" : "Model for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "ML Models" ], "summary" : "Delete a ML model by fully qualified name", "description" : "Delete an ML model by `fullyQualifiedName`.", "operationId" : "deleteMlModelByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Name of the ML Model", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "model for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "ML Models" ], "summary" : "Update an ML model by name.", "description" : "Update an existing ML model using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchMlModel", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the ML Model", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/mlmodels/restore" : { "put" : { "tags" : [ "ML Models" ], "summary" : "Restore a soft deleted ML model", "description" : "Restore a soft deleted ML Model.", "operationId" : "restore_19", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the MlModel ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModel" } } } } } } }, "/v1/mlmodels/{id}" : { "get" : { "tags" : [ "ML Models" ], "summary" : "Get an ML model by Id", "description" : "Get an ML model by `Id`.", "operationId" : "getMlModelByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ML Model", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,dashboard,followers,tags,usageSummary,extension,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The model", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModel" } } } }, "404" : { "description" : "Model for instance {id} is not found" } } }, "delete" : { "tags" : [ "ML Models" ], "summary" : "Delete an ML model by Id", "description" : "Delete an ML model by `Id`.", "operationId" : "deleteMlModel", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the ML Model", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "model for instance {id} is not found" } } }, "patch" : { "tags" : [ "ML Models" ], "summary" : "Update an ML model", "description" : "Update an existing ML model using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchMlModel_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ML Model", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/mlmodels/{id}/followers" : { "put" : { "tags" : [ "ML Models" ], "summary" : "Add a follower", "description" : "Add a user identified by `userId` as follower of this model", "operationId" : "addFollower_3", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ML Model", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "Id of the user to be added as follower", "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "uuid" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/mlmodels/{id}/followers/{userId}" : { "delete" : { "tags" : [ "ML Models" ], "summary" : "Remove a follower", "description" : "Remove the user identified `userId` as a follower of the model.", "operationId" : "deleteFollower_4", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ML Model", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed as follower", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } } } } }, "/v1/mlmodels/{id}/versions" : { "get" : { "tags" : [ "ML Models" ], "summary" : "List ML model versions", "description" : "Get a list of all the versions of an ML Model identified by `id`", "operationId" : "listAllMlModelVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ML Model", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of Ml Model versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/mlmodels/{id}/versions/{version}" : { "get" : { "tags" : [ "ML Models" ], "summary" : "Get a version of the ML model", "description" : "Get a version of the ML model by given `id`", "operationId" : "getSpecificMlModelVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ML Model", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "ML Model version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "MlModel", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModel" } } } }, "404" : { "description" : "ML Model for instance {id} and version {version} is not found" } } } }, "/v1/mlmodels/{id}/vote" : { "put" : { "tags" : [ "ML Models" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_9", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/permissions" : { "get" : { "tags" : [ "Permissions" ], "summary" : "Get permissions for logged in user", "operationId" : "getResourcePermissions", "parameters" : [ { "name" : "user", "in" : "query", "description" : "Permission for user specified in this query param. If not specified, the user is defaulted to the logged in user", "schema" : { "type" : "string", "example" : "john" } } ], "responses" : { "200" : { "description" : "Permissions for logged in user", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourcePermissionList" } } } } } } }, "/v1/permissions/policies" : { "get" : { "tags" : [ "Permissions" ], "summary" : "Get permissions for a set of policies", "operationId" : "getPermissionsForPolicies", "parameters" : [ { "name" : "ids", "in" : "query", "description" : "List of policy of ids", "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } } } ], "responses" : { "200" : { "description" : "Permissions for a set of policies", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourcePermissionList" } } } } } } }, "/v1/permissions/{resource}" : { "get" : { "tags" : [ "Permissions" ], "summary" : "Get permissions a given resource/entity type for logged in user", "operationId" : "getResourceTypePermission", "parameters" : [ { "name" : "user", "in" : "query", "description" : "Permission for user specified in this query param. If not specified, the user is defaulted to the logged in user", "schema" : { "type" : "string", "example" : "john" } }, { "name" : "resource", "in" : "path", "description" : "Type of the resource", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Permissions for logged in user", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourcePermissionList" } } } } } } }, "/v1/permissions/{resource}/name/{name}" : { "get" : { "tags" : [ "Permissions" ], "summary" : "Get permissions for a given entity name for a logged in user", "operationId" : "getResourcePermissionByName", "parameters" : [ { "name" : "user", "in" : "query", "description" : "Permission for user specified in this query param. If not specified, the user is defaulted to the logged in user", "schema" : { "type" : "string", "example" : "john" } }, { "name" : "resource", "in" : "path", "description" : "Type of the resource", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "description" : "Name of the entity", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Permissions for logged in user", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourcePermissionList" } } } } } } }, "/v1/permissions/{resource}/{id}" : { "get" : { "tags" : [ "Permissions" ], "summary" : "Get permissions for a given entity for a logged in user", "operationId" : "getResourcePermission", "parameters" : [ { "name" : "user", "in" : "query", "description" : "Permission for user specified in this query param. If not specified, the user is defaulted to the logged in user", "schema" : { "type" : "string", "example" : "john" } }, { "name" : "resource", "in" : "path", "description" : "Type of the resource", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "description" : "Id of the entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Permissions for logged in user", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourcePermissionList" } } } } } } }, "/v1/personas" : { "get" : { "tags" : [ "Personas" ], "summary" : "List personas", "description" : "Get a list of personas. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listPersonas", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "users" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number of personas returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of personas before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of personas after this cursor", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of personas", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PersonaList" } } } } } }, "put" : { "tags" : [ "Personas" ], "summary" : "Update Persona", "description" : "Create or Update a Persona.", "operationId" : "createOrUpdatePersona", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreatePersona" } } } }, "responses" : { "200" : { "description" : "The Persona.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Persona" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Personas" ], "summary" : "Create a Persona", "description" : "Create a new Persona.", "operationId" : "createPersona", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreatePersona" } } } }, "responses" : { "200" : { "description" : "The Persona.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Persona" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/personas/name/{fqn}" : { "patch" : { "tags" : [ "Personas" ], "summary" : "Update a Persona using name.", "description" : "Update an existing persona with JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchPersona", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the Persona", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/personas/name/{name}" : { "get" : { "tags" : [ "Personas" ], "summary" : "Get a Persona by name", "description" : "Get a Persona by `name`.", "operationId" : "getPersonaByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Persona", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "users" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The Persona", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Persona" } } } }, "404" : { "description" : "Persona for instance {name} is not found" } } }, "delete" : { "tags" : [ "Personas" ], "summary" : "Delete a Persona by name", "description" : "Delete a Persona by given `name`.", "operationId" : "deletePersonaByName", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Persona", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Persona for instance {name} is not found" } } } }, "/v1/personas/{id}" : { "get" : { "tags" : [ "Personas" ], "summary" : "Get a persona by id", "description" : "Get a persona by `id`.", "operationId" : "getPersonaByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Persona", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "users" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The Persona", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Persona" } } } }, "404" : { "description" : "Persona for instance {id} is not found" } } }, "delete" : { "tags" : [ "Personas" ], "summary" : "Delete a Persona by id", "description" : "Delete a Persona by given `id`.", "operationId" : "deletePersona", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Persona", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Persona for instance {id} is not found" } } }, "patch" : { "tags" : [ "Personas" ], "summary" : "Update a Persona", "description" : "Update an existing persona with JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchPersona_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Persona", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/personas/{id}/versions" : { "get" : { "tags" : [ "Personas" ], "summary" : "List Persona versions", "description" : "Get a list of all the versions of a persona identified by `id`", "operationId" : "listAllPersonaVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Persona", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of persona versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/personas/{id}/versions/{version}" : { "get" : { "tags" : [ "Personas" ], "summary" : "Get a version of the Persona", "description" : "Get a version of the Persona by given `id`", "operationId" : "getSpecificPersonaVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Persona", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Personas version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "Persona", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Persona" } } } }, "404" : { "description" : "Persona for instance {id} and version {version} is not found" } } } }, "/v1/pipelines" : { "get" : { "tags" : [ "Pipelines" ], "summary" : "List pipelines", "description" : "Get a list of pipelines, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listPipelines", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tasks,pipelineStatus,followers,tags,extension,scheduleInterval,domain,sourceHash" } }, { "name" : "service", "in" : "query", "description" : "Filter pipelines by service name", "schema" : { "type" : "string", "example" : "airflow" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number pipelines returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of pipelines before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of pipelines after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of pipelines", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineList" } } } } } }, "put" : { "tags" : [ "Pipelines" ], "summary" : "Create or update a pipeline", "description" : "Create a new pipeline, if it does not exist or update an existing pipeline.", "operationId" : "createOrUpdatePipeline", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreatePipeline" } } } }, "responses" : { "200" : { "description" : "The pipeline", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Pipeline" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Pipelines" ], "summary" : "Create a pipeline", "description" : "Create a new pipeline.", "operationId" : "createPipeline", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreatePipeline" } } } }, "responses" : { "200" : { "description" : "The pipeline", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Pipeline" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/pipelines/name/{fqn}" : { "get" : { "tags" : [ "Pipelines" ], "summary" : "Get a pipeline by fully qualified name", "description" : "Get a pipeline by fully qualified name.", "operationId" : "getPipelineByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the pipeline", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tasks,pipelineStatus,followers,tags,extension,scheduleInterval,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The pipeline", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Pipeline" } } } }, "404" : { "description" : "Pipeline for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Pipelines" ], "summary" : "Delete a pipeline by fully qualified name", "description" : "Delete a pipeline by `fullyQualifiedName`.", "operationId" : "deletePipelineByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the pipeline", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Pipeline for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Pipelines" ], "summary" : "Update a pipeline by name.", "description" : "Update an existing pipeline using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchPipeline", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the pipeline", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/pipelines/restore" : { "put" : { "tags" : [ "Pipelines" ], "summary" : "Restore a soft deleted pipeline", "description" : "Restore a soft deleted pipeline.", "operationId" : "restore_20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Pipeline ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Pipeline" } } } } } } }, "/v1/pipelines/{fqn}/status" : { "get" : { "tags" : [ "Pipelines" ], "summary" : "List pipeline status", "description" : "Get a list of pipeline status.parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listPipelineStatuses", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the pipeline", "required" : true, "schema" : { "type" : "string" } }, { "name" : "startTs", "in" : "query", "description" : "Filter pipeline statues after the given start timestamp", "required" : true, "schema" : { "type" : "number" } }, { "name" : "endTs", "in" : "query", "description" : "Filter pipeline statues before the given end timestamp", "required" : true, "schema" : { "type" : "number" } } ], "responses" : { "200" : { "description" : "List of pipeline statuses.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineStatusList" } } } } } }, "put" : { "tags" : [ "Pipelines" ], "summary" : "Add status data", "description" : "Add status data to the pipeline.", "operationId" : "addStatusData", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the pipeline", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineStatus" } } } }, "responses" : { "200" : { "description" : "The pipeline with a the new status", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Pipeline" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/pipelines/{fqn}/status/{timestamp}" : { "delete" : { "tags" : [ "Pipelines" ], "summary" : "Delete pipeline status", "description" : "Delete pipeline status for a pipeline.", "operationId" : "DeletePipelineStatus", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the pipeline", "required" : true, "schema" : { "type" : "string" } }, { "name" : "timestamp", "in" : "path", "description" : "Timestamp of the pipeline status", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Successfully deleted the PipelineStatus", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Pipeline" } } } } } } }, "/v1/pipelines/{id}" : { "get" : { "tags" : [ "Pipelines" ], "summary" : "Get a pipeline by Id", "description" : "Get a pipeline by `Id`.", "operationId" : "getPipelineWithID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tasks,pipelineStatus,followers,tags,extension,scheduleInterval,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The pipeline", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Pipeline" } } } }, "404" : { "description" : "Pipeline for instance {id} is not found" } } }, "delete" : { "tags" : [ "Pipelines" ], "summary" : "Delete a pipeline by Id", "description" : "Delete a pipeline by `Id`.", "operationId" : "deletePipeline", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Pipeline for instance {id} is not found" } } }, "patch" : { "tags" : [ "Pipelines" ], "summary" : "Update a pipeline", "description" : "Update an existing pipeline using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchPipeline_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/pipelines/{id}/followers" : { "put" : { "tags" : [ "Pipelines" ], "summary" : "Add a follower", "description" : "Add a user identified by `userId` as follower of this pipeline", "operationId" : "addFollower_4", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "Id of the user to be added as follower", "content" : { "application/json" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "Pipeline for instance {id} is not found" } } } }, "/v1/pipelines/{id}/followers/{userId}" : { "delete" : { "tags" : [ "Pipelines" ], "summary" : "Remove a follower", "description" : "Remove the user identified `userId` as a follower of the pipeline.", "operationId" : "deleteFollower_5", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed as follower", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } } } } }, "/v1/pipelines/{id}/versions" : { "get" : { "tags" : [ "Pipelines" ], "summary" : "List pipeline versions", "description" : "Get a list of all the versions of a pipeline identified by `Id`", "operationId" : "listAllPipelineVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of pipeline versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/pipelines/{id}/versions/{version}" : { "get" : { "tags" : [ "Pipelines" ], "summary" : "Get a version of the pipeline", "description" : "Get a version of the pipeline by given `Id`", "operationId" : "getSpecificPipelineVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Pipeline version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "pipeline", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Pipeline" } } } }, "404" : { "description" : "Pipeline for instance {id} and version {version} is not found" } } } }, "/v1/pipelines/{id}/vote" : { "put" : { "tags" : [ "Pipelines" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_10", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/policies" : { "get" : { "tags" : [ "Policies" ], "summary" : "List policies", "description" : "Get a list of policies. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listPolicies", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,location,teams,roles" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number policies returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of policies before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of policies after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of policies", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PolicyList" } } } } } }, "put" : { "tags" : [ "Policies" ], "summary" : "Create or update a policy", "description" : "Create a new policy, if it does not exist or update an existing policy.", "operationId" : "createOrUpdatePolicy", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreatePolicy" } } } }, "responses" : { "200" : { "description" : "The policy", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Policies" ], "summary" : "Create a policy", "description" : "Create a new policy.", "operationId" : "createPolicy", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreatePolicy" } } } }, "responses" : { "200" : { "description" : "The policy", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/policies/functions" : { "get" : { "tags" : [ "Policies" ], "summary" : "Get list of policy functions used in authoring conditions in policy rules.", "description" : "Get list of policy functions used in authoring conditions in policy rules.", "operationId" : "listPolicyFunctions", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResultListFunction" } } } } } } }, "/v1/policies/name/{fqn}" : { "get" : { "tags" : [ "Policies" ], "summary" : "Get a policy by fully qualified name", "description" : "Get a policy by fully qualified name.", "operationId" : "getPolicyByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the policy", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,location,teams,roles" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The policy", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy" } } } }, "404" : { "description" : "Policy for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Policies" ], "summary" : "Delete a policy by fully qualified name", "description" : "Delete a policy by `fullyQualifiedName`.", "operationId" : "deletePolicyByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the policy", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "policy for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Policies" ], "summary" : "Update a policy by name.", "description" : "Update an existing policy using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchPolicy", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the policy", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/policies/resources" : { "get" : { "tags" : [ "Policies" ], "summary" : "Get list of policy resources used in authoring a policy", "description" : "Get list of policy resources used in authoring a policy.", "operationId" : "listPolicyResources", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResultListResourceDescriptor" } } } } } } }, "/v1/policies/restore" : { "put" : { "tags" : [ "Policies" ], "summary" : "Restore a soft deleted policy", "description" : "Restore a soft deleted policy.", "operationId" : "restore_21", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Policy ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy" } } } } } } }, "/v1/policies/validation/condition/{expression}" : { "get" : { "tags" : [ "Policies" ], "summary" : "Validate a given condition", "description" : "Validate a given condition expression used in authoring rules.", "operationId" : "validateCondition_1", "parameters" : [ { "name" : "expression", "in" : "path", "description" : "Expression of validating rule", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No value is returned" }, "400" : { "description" : "Invalid expression" } } } }, "/v1/policies/{id}" : { "get" : { "tags" : [ "Policies" ], "summary" : "Get a policy by id", "description" : "Get a policy by `Id`.", "operationId" : "getPolicyByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the policy", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,location,teams,roles" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The policy", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy" } } } }, "404" : { "description" : "Policy for instance {id} is not found" } } }, "delete" : { "tags" : [ "Policies" ], "summary" : "Delete a policy by Id", "description" : "Delete a policy by `Id`.", "operationId" : "deletePolicy", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the policy", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "policy for instance {id} is not found" } } }, "patch" : { "tags" : [ "Policies" ], "summary" : "Update a policy", "description" : "Update an existing policy using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchPolicy_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the policy", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/policies/{id}/versions" : { "get" : { "tags" : [ "Policies" ], "summary" : "List policy versions", "description" : "Get a list of all the versions of a policy identified by `id`", "operationId" : "listAllPolicyVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the policy", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of policy versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/policies/{id}/versions/{version}" : { "get" : { "tags" : [ "Policies" ], "summary" : "Get a version of the policy by Id", "description" : "Get a version of the policy by given `Id`", "operationId" : "getSpecificPolicyVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the policy", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "policy version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "policy", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Policy" } } } }, "404" : { "description" : "Policy for instance {id} and version {version} is not found" } } } }, "/v1/queries" : { "get" : { "tags" : [ "Queries" ], "summary" : "Get a list of Queries", "description" : "Get a list of queries. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listQueries", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,users,votes,tags,queryUsedIn" } }, { "name" : "entityId", "in" : "query", "description" : "UUID of the entity for which to list the Queries", "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "service", "in" : "query", "description" : "Filter Queries by service Fully Qualified Name", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number queries returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of queries before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of queries after this cursor", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Get List of queries", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QueryList" } } } } } }, "put" : { "tags" : [ "Queries" ], "summary" : "Create or update a query", "description" : "Create a query, if it does not exist. If a query already exists, update the query.", "operationId" : "createOrUpdateQuery", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateQuery" } } } }, "responses" : { "200" : { "description" : "The query", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Query" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Queries" ], "summary" : "Create a query", "description" : "Create a query under an existing entity.", "operationId" : "createQuery", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateQuery" } } } }, "responses" : { "200" : { "description" : "The query", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QueryList" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/queries/name/{fqn}" : { "get" : { "tags" : [ "Queries" ], "summary" : "Get a query by name", "description" : "Get a query by fully qualified table name.", "operationId" : "getQueryFqn", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,users,votes,tags,queryUsedIn" } } ], "responses" : { "200" : { "description" : "query", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Query" } } } }, "404" : { "description" : "Query for instance {id} is not found" } } }, "delete" : { "tags" : [ "Queries" ], "summary" : "Delete a query", "description" : "Delete a query by `fullyQualifiedName`.", "operationId" : "deleteQueryByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the location", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Query for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Queries" ], "summary" : "Update a query using name.", "description" : "Update an existing query using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchQuery", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the query", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/queries/restore" : { "put" : { "tags" : [ "Queries" ], "summary" : "Restore a soft deleted Query", "description" : "Restore a soft deleted Query.", "operationId" : "restore_22", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Query ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Query" } } } } } } }, "/v1/queries/{id}" : { "get" : { "tags" : [ "Queries" ], "summary" : "Get a query", "description" : "Get a Query by `id`", "operationId" : "getQueryById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "query Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,users,votes,tags,queryUsedIn" } } ], "responses" : { "200" : { "description" : "query", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Query" } } } }, "404" : { "description" : "Query for instance {id} is not found" } } }, "delete" : { "tags" : [ "Queries" ], "summary" : "Delete a query", "description" : "Delete a query by `id`.", "operationId" : "deleteQuery", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the query", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Query for instance {id} is not found" } } }, "patch" : { "tags" : [ "Queries" ], "summary" : "Update a query", "description" : "Update an existing query using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchQuery_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the query", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/queries/{id}/followers" : { "put" : { "tags" : [ "Queries" ], "summary" : "Add a follower", "description" : "Add a user identified by `userId` as follower of this model", "operationId" : "addFollower_5", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Query", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "Id of the user to be added as follower", "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "uuid" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/queries/{id}/followers/{userId}" : { "delete" : { "tags" : [ "Queries" ], "summary" : "Remove a follower", "description" : "Remove the user identified `userId` as a follower of the model.", "operationId" : "deleteFollower_6", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Query", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed as follower", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } } } } }, "/v1/queries/{id}/usage" : { "put" : { "tags" : [ "Queries" ], "summary" : "Add query usage", "description" : "Add query usage", "operationId" : "addQueryUsage", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the query", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Query" } } } } } }, "delete" : { "tags" : [ "Queries" ], "summary" : "remove query used in", "description" : "remove Query Used in", "operationId" : "removeQueryUsedIn", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the query", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Query" } } } } } } }, "/v1/queries/{id}/usedBy" : { "put" : { "tags" : [ "Queries" ], "summary" : "Populate Used By Field", "description" : "Add query users", "operationId" : "addQueryUsedBy", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the query", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Query" } } } } } } }, "/v1/queries/{id}/users" : { "put" : { "tags" : [ "Queries" ], "summary" : "Add query users", "description" : "Add query users", "operationId" : "addQueryUsers", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the query", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Query" } } } } } } }, "/v1/queries/{id}/versions" : { "get" : { "tags" : [ "Queries" ], "summary" : "Get List of all query versions", "description" : "Get a list of all the versions of a query identified by `id`", "operationId" : "listAllQueryVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Query Id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of query versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/queries/{id}/versions/{version}" : { "get" : { "tags" : [ "Queries" ], "summary" : "Get a specific version of the query", "description" : "Get a version of the query by given `id`", "operationId" : "getSpecificQueryVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Query Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Query version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "query", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Query" } } } }, "404" : { "description" : "query for instance {id} and version {version} is not found" } } } }, "/v1/queries/{id}/vote" : { "put" : { "tags" : [ "Queries" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_11", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/reports" : { "get" : { "tags" : [ "Reports (beta)" ], "summary" : "List reports", "description" : "Get a list of reports. Use `fields` parameter to get only necessary fields.", "operationId" : "listReports", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,usageSummary" } } ], "responses" : { "200" : { "description" : "List of reports", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportList" } } } } } }, "put" : { "tags" : [ "Reports (beta)" ], "summary" : "Create or update a report", "description" : "Create a new report, it it does not exist or update an existing report.", "operationId" : "createOrUpdateReport", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report" } } } }, "responses" : { "200" : { "description" : "The report", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Reports (beta)" ], "summary" : "Create a report", "description" : "Create a new report.", "operationId" : "getReportByFQN", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report" } } } }, "responses" : { "200" : { "description" : "The report", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/reports/{id}" : { "get" : { "tags" : [ "Reports (beta)" ], "summary" : "Get a report by Id", "description" : "Get a report by `Id`.", "operationId" : "getReportByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the report", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,usageSummary" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The report", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report" } } } }, "404" : { "description" : "Report for instance {id} is not found" } } } }, "/v1/reports/{id}/vote" : { "put" : { "tags" : [ "Reports (beta)" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_12", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/roles" : { "get" : { "tags" : [ "Roles" ], "summary" : "List roles", "description" : "Get a list of roles. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listRoles", "parameters" : [ { "name" : "default", "in" : "query", "description" : "List only default role(s)", "schema" : { "type" : "boolean", "example" : true } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "policies,teams,users" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number tables returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of tables before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of tables after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of roles", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RoleList" } } } } } }, "put" : { "tags" : [ "Roles" ], "summary" : "Update role", "description" : "Create or Update a role.", "operationId" : "createOrUpdateRole", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateRole" } } } }, "responses" : { "200" : { "description" : "The role ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Role" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Roles" ], "summary" : "Create a role", "description" : "Create a new role.", "operationId" : "createRole", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateRole" } } } }, "responses" : { "200" : { "description" : "The role", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Role" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/roles/name/{fqn}" : { "patch" : { "tags" : [ "Roles" ], "summary" : "Update a role using name.", "description" : "Update an existing role with JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchRole", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the role", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/roles/name/{name}" : { "get" : { "tags" : [ "Roles" ], "summary" : "Get a role by name", "description" : "Get a role by `name`.", "operationId" : "getRoleByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the role", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "policies,teams,users" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The role", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Role" } } } }, "404" : { "description" : "Role for instance {name} is not found" } } }, "delete" : { "tags" : [ "Roles" ], "summary" : "Delete a role", "description" : "Delete a role by given `name`.", "operationId" : "deleteRoleByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the role", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Role for instance {name} is not found" } } } }, "/v1/roles/restore" : { "put" : { "tags" : [ "Roles" ], "summary" : "Restore a soft deleted role", "description" : "Restore a soft deleted role.", "operationId" : "restore_35", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Role. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Role" } } } } } } }, "/v1/roles/{id}" : { "get" : { "tags" : [ "Roles" ], "summary" : "Get a role by id", "description" : "Get a role by `id`.", "operationId" : "getRoleByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the role", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "policies,teams,users" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The role", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Role" } } } }, "404" : { "description" : "Role for instance {id} is not found" } } }, "delete" : { "tags" : [ "Roles" ], "summary" : "Delete a role", "description" : "Delete a role by given `id`.", "operationId" : "deleteRole", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the role", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Role for instance {id} is not found" } } }, "patch" : { "tags" : [ "Roles" ], "summary" : "Update a role", "description" : "Update an existing role with JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchRole_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the role", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/roles/{id}/versions" : { "get" : { "tags" : [ "Roles" ], "summary" : "List role versions", "description" : "Get a list of all the versions of a role identified by `id`", "operationId" : "listAllRoleVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the role", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of role versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/roles/{id}/versions/{version}" : { "get" : { "tags" : [ "Roles" ], "summary" : "Get a version of the role", "description" : "Get a version of the role by given `id`", "operationId" : "getSpecificRoleVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the role", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Role version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "role", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Role" } } } }, "404" : { "description" : "Role for instance {id} and version {version} is not found" } } } }, "/v1/search/aggregate" : { "get" : { "tags" : [ "Search" ], "summary" : "Get aggregated fields", "description" : "Get aggregated fields from entities.", "operationId" : "getAggregateFields", "parameters" : [ { "name" : "index", "in" : "query", "schema" : { "type" : "string", "default" : "table_search_index" } }, { "name" : "field", "in" : "query", "description" : "Field in an entity.", "schema" : { "type" : "string" } }, { "name" : "value", "in" : "query", "description" : "value for searching in aggregation", "schema" : { "type" : "string", "default" : "" } }, { "name" : "q", "in" : "query", "description" : "Search Query Text, Pass *text* for substring match; Pass without wildcards for exact match. <br/> 1. For listing all tables or topics pass q=* <br/>2. For search tables or topics pass q=*search_term* <br/>3. For searching field names such as search by columnNames pass q=columnNames:address, for searching deleted entities, use q=deleted:true <br/>4. For searching by tag names pass q=tags.tagFQN:user.email <br/>5. When user selects a filter pass q=query_text AND tags.tagFQN:user.email AND platform:MYSQL <br/>6. Search with multiple values of same filter q=tags.tagFQN:user.email AND tags.tagFQN:user.address <br/>NOTE: logic operators such as AND, OR and NOT must be in uppercase ", "required" : true, "schema" : { "type" : "string", "default" : "*" } }, { "name" : "size", "in" : "query", "description" : "Size field to limit the no.of results returned, defaults to 10", "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "deleted", "in" : "query", "schema" : { "type" : "string", "default" : "false" } } ], "responses" : { "200" : { "description" : "Table Aggregate API", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Suggest" } } } } } } }, "/v1/search/fieldQuery" : { "get" : { "tags" : [ "Search" ], "summary" : "Search entities", "operationId" : "searchEntitiesWithSpecificFieldAndValue", "parameters" : [ { "name" : "fieldName", "in" : "query", "description" : "field name", "schema" : { "type" : "string" } }, { "name" : "fieldValue", "in" : "query", "description" : "field value", "schema" : { "type" : "string" } }, { "name" : "index", "in" : "query", "description" : "Search Index name, defaults to table_search_index", "schema" : { "type" : "string", "default" : "table_search_index" } } ], "responses" : { "200" : { "description" : "search response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchResponse" } } } } } } }, "/v1/search/get/{index}/doc/{id}" : { "get" : { "tags" : [ "Search" ], "summary" : "Search entities in ES index with Id", "operationId" : "searchEntityInEsIndexWithId", "parameters" : [ { "name" : "id", "in" : "path", "description" : "document Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "index", "in" : "path", "description" : "Index Name", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "search response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchResponse" } } } } } } }, "/v1/search/query" : { "get" : { "tags" : [ "Search" ], "summary" : "Search entities", "description" : "Search entities using query test. Use query params `from` and `size` for pagination. Use `sort_field` to sort the results in `sort_order`.", "operationId" : "searchEntitiesWithQuery", "parameters" : [ { "name" : "q", "in" : "query", "description" : "Search Query Text, Pass *text* for substring match; Pass without wildcards for exact match. <br/> 1. For listing all tables or topics pass q=* <br/>2. For search tables or topics pass q=*search_term* <br/>3. For searching field names such as search by columnNames pass q=columnNames:address , for searching deleted entities, use q=deleted:true <br/> 4. For searching by tag names pass q=tags.tagFQN:user.email <br/>5. When user selects a filter pass q=query_text AND q=tags.tagFQN:user.email AND platform:MYSQL <br/>6. Search with multiple values of same filter q=tags.tagFQN:user.email AND tags.tagFQN:user.address <br/> 7. Search by service version and type q=service.type:databaseService AND version:0.1 <br/> 8. Search Tables with Specific Constraints q=tableConstraints.constraintType.keyword:PRIMARY_KEY AND NOT tier.tagFQN:Tier.Tier1 <br/> 9. Search with owners q=owner.displayName.keyword:owner_name <br/> NOTE: logic operators such as AND, OR and NOT must be in uppercase ", "required" : true, "schema" : { "type" : "string", "default" : "*" } }, { "name" : "index", "in" : "query", "description" : "ElasticSearch Index name, defaults to table_search_index", "schema" : { "type" : "string", "default" : "table_search_index" } }, { "name" : "deleted", "in" : "query", "description" : "Filter documents by deleted param. By default deleted is false", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "from", "in" : "query", "description" : "From field to paginate the results, defaults to 0", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "size", "in" : "query", "description" : "Size field to limit the no.of results returned, defaults to 10", "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "search_after", "in" : "query", "description" : "When paginating, specify the search_after values. Use it ass search_after=<val1>,<val2>,...", "schema" : { "type" : "string" } }, { "name" : "sort_field", "in" : "query", "description" : "Sort the search results by field, available fields to sort weekly_stats , daily_stats, monthly_stats, last_updated_timestamp", "schema" : { "type" : "string", "default" : "_score" } }, { "name" : "sort_order", "in" : "query", "description" : "Sort order asc for ascending or desc for descending, defaults to desc", "schema" : { "type" : "string", "default" : "desc" } }, { "name" : "track_total_hits", "in" : "query", "description" : "Track Total Hits", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "query_filter", "in" : "query", "description" : "Elasticsearch query that will be combined with the query_string query generator from the `query` argument", "schema" : { "type" : "string" } }, { "name" : "post_filter", "in" : "query", "description" : "Elasticsearch query that will be used as a post_filter", "schema" : { "type" : "string" } }, { "name" : "fetch_source", "in" : "query", "description" : "Get document body for each hit", "schema" : { "type" : "boolean", "default" : true } }, { "name" : "include_source_fields", "in" : "query", "description" : "Get only selected fields of the document body for each hit. Empty value will return all fields", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "getHierarchy", "in" : "query", "description" : "Fetch search results in hierarchical order of children elements. By default hierarchy is not fetched. Currently only supported for glossary_term_search_index.", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "explain", "in" : "query", "description" : "Explain the results of the query. Defaults to false. Only for debugging purposes.", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "search response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchResponse" } } } } } } }, "/v1/search/reindex/stream/status" : { "get" : { "tags" : [ "Search" ], "summary" : "Get Stream Job Latest Status", "description" : "Stream Job Status", "operationId" : "getStreamJobStatus", "responses" : { "200" : { "description" : "Success" }, "404" : { "description" : "Status not found" } } } }, "/v1/search/sourceUrl" : { "get" : { "tags" : [ "Search" ], "summary" : "Search entities", "operationId" : "searchEntitiesWithSourceUrl", "parameters" : [ { "name" : "sourceUrl", "in" : "query", "description" : "source url", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "search response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchResponse" } } } } } } }, "/v1/search/suggest" : { "get" : { "tags" : [ "Search" ], "summary" : "Suggest entities", "description" : "Get suggested entities used for auto-completion.", "operationId" : "getSuggestedEntities", "parameters" : [ { "name" : "q", "in" : "query", "description" : "Suggest API can be used to auto-fill the entities name while use is typing search text <br/> 1. To get suggest results pass q=us or q=user etc.. <br/> 2. Do not add any wild-cards such as * like in search api <br/> 3. suggest api is a prefix suggestion <br/>", "required" : true, "schema" : { "type" : "string" } }, { "name" : "index", "in" : "query", "schema" : { "type" : "string", "default" : "table_search_index" } }, { "name" : "field", "in" : "query", "description" : "Field in object containing valid suggestions. Defaults to 'suggest`. All indices has a `suggest` field, only some indices have other `suggest_*` fields.", "schema" : { "type" : "string", "default" : "suggest" } }, { "name" : "size", "in" : "query", "description" : "Size field to limit the no.of results returned, defaults to 10", "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "fetch_source", "in" : "query", "description" : "Get document body for each hit", "schema" : { "type" : "boolean", "default" : true } }, { "name" : "include_source_fields", "in" : "query", "description" : "Get only selected fields of the document body for each hit. Empty value will return all fields", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "deleted", "in" : "query", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "Table Suggestion API", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Suggest" } } } } } } }, "/v1/searchIndexes" : { "get" : { "tags" : [ "SearchIndex" ], "summary" : "List searchIndexes", "description" : "Get a list of SearchIndexes, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listSearchIndexes", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,tags,extension,domain,dataProducts,sourceHash" } }, { "name" : "service", "in" : "query", "description" : "Filter SearchIndexes by service name", "schema" : { "type" : "string", "example" : "ElasticSearchWestCoast" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number SearchIndexes returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of SearchIndexes before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of SearchIndexes after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of SearchIndexes", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchIndexList" } } } } } }, "put" : { "tags" : [ "SearchIndex" ], "summary" : "Update SearchIndex", "description" : "Create a SearchIndex, it it does not exist or update an existing SearchIndex.", "operationId" : "createOrUpdateSearchIndex", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateSearchIndex" } } } }, "responses" : { "200" : { "description" : "The updated SearchIndex ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchIndex" } } } } } }, "post" : { "tags" : [ "SearchIndex" ], "summary" : "Create a SearchIndex", "description" : "Create a SearchIndex under an existing `service`.", "operationId" : "createSearchIndex", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateSearchIndex" } } } }, "responses" : { "200" : { "description" : "The SearchIndex", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchIndex" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/searchIndexes/name/{fqn}" : { "get" : { "tags" : [ "SearchIndex" ], "summary" : "Get a SearchIndex by fully qualified name", "description" : "Get a SearchIndex by fully qualified name.", "operationId" : "getSearchIndexByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the SearchIndex", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,tags,extension,domain,dataProducts,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The SearchIndex", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchIndex" } } } }, "404" : { "description" : "SearchIndex for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "SearchIndex" ], "summary" : "Delete a SearchIndex by fully qualified name", "description" : "Delete a SearchIndex by `fullyQualifiedName`.", "operationId" : "deleteSearchIndexByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the SearchIndex", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "SearchIndex for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "SearchIndex" ], "summary" : "Update a SearchIndex using name.", "description" : "Update an existing SearchIndex using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchSearchIndex", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the SearchIndex", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/searchIndexes/restore" : { "put" : { "tags" : [ "SearchIndex" ], "summary" : "Restore a soft deleted SearchIndex", "description" : "Restore a soft deleted SearchIndex.", "operationId" : "restore_23", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the SearchIndex. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchIndex" } } } } } } }, "/v1/searchIndexes/{id}" : { "get" : { "tags" : [ "SearchIndex" ], "summary" : "Get a SearchIndex by id", "description" : "Get a SearchIndex by `id`.", "operationId" : "get_6", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the SearchIndex", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,tags,extension,domain,dataProducts,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The SearchIndex", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchIndex" } } } }, "404" : { "description" : "SearchIndex for instance {id} is not found" } } }, "delete" : { "tags" : [ "SearchIndex" ], "summary" : "Delete a SearchIndex by id", "description" : "Delete a SearchIndex by `id`.", "operationId" : "deleteSearchIndex", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the SearchIndex", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "SearchIndex for instance {id} is not found" } } }, "patch" : { "tags" : [ "SearchIndex" ], "summary" : "Update a SearchIndex", "description" : "Update an existing SearchIndex using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchSearchIndex_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the SearchIndex", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/searchIndexes/{id}/followers" : { "put" : { "tags" : [ "SearchIndex" ], "summary" : "Add a follower", "description" : "Add a user identified by `userId` as followed of this SearchIndex", "operationId" : "addFollower_6", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the SearchIndex", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "Id of the user to be added as follower", "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "uuid" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "SearchIndex for instance {id} is not found" } } } }, "/v1/searchIndexes/{id}/followers/{userId}" : { "delete" : { "tags" : [ "SearchIndex" ], "summary" : "Remove a follower", "description" : "Remove the user identified `userId` as a follower of the SearchIndex.", "operationId" : "deleteFollower_7", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the SearchIndex", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed as follower", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } } } } }, "/v1/searchIndexes/{id}/sampleData" : { "get" : { "tags" : [ "SearchIndex" ], "summary" : "Get sample data", "description" : "Get sample data from the SearchIndex.", "operationId" : "getSampleData_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the SearchIndex", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Successfully obtained the SampleData for SearchIndex", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchIndex" } } } } } }, "put" : { "tags" : [ "SearchIndex" ], "summary" : "Add sample data", "description" : "Add sample data to the searchIndex.", "operationId" : "addSampleData_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the SearchIndex", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchIndexSampleData" } } } }, "responses" : { "200" : { "description" : "The SearchIndex", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchIndex" } } } } } } }, "/v1/searchIndexes/{id}/versions" : { "get" : { "tags" : [ "SearchIndex" ], "summary" : "List SearchIndex versions", "description" : "Get a list of all the versions of a SearchIndex identified by `id`", "operationId" : "listAllSearchIndexVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the SearchIndex", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of SearchIndex versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/searchIndexes/{id}/versions/{version}" : { "get" : { "tags" : [ "SearchIndex" ], "summary" : "Get a version of the SearchIndex", "description" : "Get a version of the SearchIndex by given `id`", "operationId" : "getSpecificSearchIndexVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the SearchIndex", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "SearchIndex version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "SearchIndex", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchIndex" } } } }, "404" : { "description" : "SearchIndex for instance {id} and version {version} is not found" } } } }, "/v1/searchIndexes/{id}/vote" : { "put" : { "tags" : [ "SearchIndex" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_13", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/services/apiServices" : { "get" : { "tags" : [ "API Services" ], "summary" : "List API services", "description" : "Get a list of API services.", "operationId" : "listAPIServices", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "domain", "in" : "query", "description" : "Filter services by domain", "schema" : { "type" : "string", "example" : "Marketing" } }, { "name" : "limit", "in" : "query", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of API services before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of API services after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of API service instances", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/APIServiceList" } } } } } }, "put" : { "tags" : [ "API Services" ], "summary" : "Update API service", "description" : "Update an existing or create a new API service.", "operationId" : "createOrUpdateAPIService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateApiService" } } } }, "responses" : { "200" : { "description" : "Object store service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiService" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "API Services" ], "summary" : "Create API service", "description" : "Create a new API service.", "operationId" : "createApiService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateApiService" } } } }, "responses" : { "200" : { "description" : "API service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiService" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/services/apiServices/name/{fqn}" : { "delete" : { "tags" : [ "API Services" ], "summary" : "Delete an APIService by fully qualified name", "description" : "Delete an APIService by `fullyQualifiedName`.", "operationId" : "deleteAPIServiceByFQN", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Name of the APIService", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "APIService for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "API Services" ], "summary" : "Update an API service using name.", "description" : "Update an existing API service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchAPIService", "parameters" : [ { "name" : "fqn", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/apiServices/name/{name}" : { "get" : { "tags" : [ "API Services" ], "summary" : "Get API service by name", "description" : "Get a API service by the service `name`.", "operationId" : "getAPIServiceByFQN", "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "API service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiService" } } } }, "404" : { "description" : "API service for instance {id} is not found" } } } }, "/v1/services/apiServices/restore" : { "put" : { "tags" : [ "API Services" ], "summary" : "Restore a soft deleted API Service.", "description" : "Restore a soft deleted API Service.", "operationId" : "restore_24", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the API Service.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiService" } } } } } } }, "/v1/services/apiServices/{id}" : { "get" : { "tags" : [ "API Services" ], "summary" : "Get an API service", "description" : "Get an API service by `id`.", "operationId" : "getAPIServiceByID", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "API service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiService" } } } }, "404" : { "description" : "API service for instance {id} is not found" } } }, "delete" : { "tags" : [ "API Services" ], "summary" : "Delete an API service", "description" : "Delete an API services.", "operationId" : "deleteAPIService", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the API service", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "API service for instance {id} is not found" } } }, "patch" : { "tags" : [ "API Services" ], "summary" : "Update an API service", "description" : "Update an existing API service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchAPIService_1", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/apiServices/{id}/testConnectionResult" : { "put" : { "tags" : [ "API Services" ], "summary" : "Add test connection result", "description" : "Add test connection result to the service.", "operationId" : "addTestConnectionResult", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestConnectionResult" } } } }, "responses" : { "200" : { "description" : "Successfully updated the service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiService" } } } } } } }, "/v1/services/apiServices/{id}/versions" : { "get" : { "tags" : [ "API Services" ], "summary" : "List API service versions", "description" : "Get a list of all the versions of an API service identified by `id`", "operationId" : "listAllAPIServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "API service Id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of API service versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/services/apiServices/{id}/versions/{version}" : { "get" : { "tags" : [ "API Services" ], "summary" : "Get a version of the API service", "description" : "Get a version of the API service by given `id`", "operationId" : "getSpecificAPIServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "API service Id", "required" : true, "schema" : { "type" : "string" } }, { "name" : "version", "in" : "path", "description" : "API service version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "API service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiService" } } } }, "404" : { "description" : "API service for instance {id} and version {version} is not found" } } } }, "/v1/services/dashboardServices" : { "get" : { "tags" : [ "Dashboard Services" ], "summary" : "List dashboard services", "description" : "Get a list of dashboard services.", "operationId" : "listDashboardsService", "parameters" : [ { "name" : "name", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,domain" } }, { "name" : "domain", "in" : "query", "description" : "Filter services by domain", "schema" : { "type" : "string", "example" : "Marketing" } }, { "name" : "limit", "in" : "query", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of dashboard services before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of dashboard services after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of dashboard service instances", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardServiceList" } } } } } }, "put" : { "tags" : [ "Dashboard Services" ], "summary" : "Update a dashboard service", "description" : "Update an existing dashboard service identified by `Id`.", "operationId" : "createOrUpdateDashboardService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDashboardService" } } } }, "responses" : { "200" : { "description" : "Dashboard service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardService" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Dashboard Services" ], "summary" : "Create a dashboard service", "description" : "Create a new dashboard service.", "operationId" : "createDashboardService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDashboardService" } } } }, "responses" : { "200" : { "description" : "Dashboard service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardService" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/services/dashboardServices/name/{fqn}" : { "patch" : { "tags" : [ "Dashboard Services" ], "summary" : "Update a dashboard service using name.", "description" : "Update an existing dashboard service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDashboardService", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the dashboard service", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/dashboardServices/name/{name}" : { "get" : { "tags" : [ "Dashboard Services" ], "summary" : "Get dashboard service by name", "description" : "Get a dashboard service by the service `name`.", "operationId" : "getDashboardServiceByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the dashboard service", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "Dashboard service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardService" } } } }, "404" : { "description" : "Dashboard service for instance {name} is not found" } } }, "delete" : { "tags" : [ "Dashboard Services" ], "summary" : "Delete a dashboard service by name", "description" : "Delete a Dashboard services by `name`. If dashboard (and charts) belong to the service, it can't be deleted.", "operationId" : "deleteDashboardServiceByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the dashboard service", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "DashboardService service for instance {name} is not found" } } } }, "/v1/services/dashboardServices/restore" : { "put" : { "tags" : [ "Dashboard Services" ], "summary" : "Restore a soft deleted dashboard service", "description" : "Restore a soft deleted dashboard service.", "operationId" : "restore_25", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Chart ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardService" } } } } } } }, "/v1/services/dashboardServices/{id}" : { "get" : { "tags" : [ "Dashboard Services" ], "summary" : "Get a dashboard service by Id", "description" : "Get a dashboard service by `Id`.", "operationId" : "getDashboardServiceByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "Dashboard service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardService" } } } }, "404" : { "description" : "Dashboard service for instance {id} is not found" } } }, "delete" : { "tags" : [ "Dashboard Services" ], "summary" : "Delete a dashboard service by Id", "description" : "Delete a Dashboard services. If dashboard (and charts) belong to the service, it can't be deleted.", "operationId" : "deleteDashboardService", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the dashboard service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "DashboardService service for instance {id} is not found" } } }, "patch" : { "tags" : [ "Dashboard Services" ], "summary" : "Update a dashboard service", "description" : "Update an existing dashboard service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDashboardService_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/dashboardServices/{id}/testConnectionResult" : { "put" : { "tags" : [ "Dashboard Services" ], "summary" : "Add test connection result", "description" : "Add test connection result to the service.", "operationId" : "addTestConnectionResult_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestConnectionResult" } } } }, "responses" : { "200" : { "description" : "Successfully updated the service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardService" } } } } } } }, "/v1/services/dashboardServices/{id}/versions" : { "get" : { "tags" : [ "Dashboard Services" ], "summary" : "List dashboard service versions", "description" : "Get a list of all the versions of a dashboard service identified by `Id`", "operationId" : "listAllDashboardServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of dashboard service versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/services/dashboardServices/{id}/versions/{version}" : { "get" : { "tags" : [ "Dashboard Services" ], "summary" : "Get a version of the dashboard service", "description" : "Get a version of the dashboard service by given `Id`", "operationId" : "getSpecificDashboardServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the dashboard service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "dashboard service version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "dashboard service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DashboardService" } } } }, "404" : { "description" : "Dashboard service for instance {id} and version {version} is not found" } } } }, "/v1/services/databaseServices" : { "get" : { "tags" : [ "Database Services" ], "summary" : "List database services", "description" : "Get a list of database services.", "operationId" : "listDatabaseServices", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "domain", "in" : "query", "description" : "Filter services by domain", "schema" : { "type" : "string", "example" : "Marketing" } }, { "name" : "limit", "in" : "query", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of database services before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of database services after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of database service instances", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseServiceList" } } } } } }, "put" : { "tags" : [ "Database Services" ], "summary" : "Update database service", "description" : "Update an existing or create a new database service.", "operationId" : "createOrUpdateDatabaseService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDatabaseService" } } } }, "responses" : { "200" : { "description" : "Database service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseService" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Database Services" ], "summary" : "Create database service", "description" : "Create a new database service.", "operationId" : "createDatabaseService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDatabaseService" } } } }, "responses" : { "200" : { "description" : "Database service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseService" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/services/databaseServices/name/{fqn}" : { "patch" : { "tags" : [ "Database Services" ], "summary" : "Update a database service using name.", "description" : "Update an existing database service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDatabaseService", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the database service", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/databaseServices/name/{name}" : { "get" : { "tags" : [ "Database Services" ], "summary" : "Get database service by name", "description" : "Get a database service by the service `name`.", "operationId" : "getDatabaseServiceByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the database service", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "Database service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseService" } } } }, "404" : { "description" : "Database service for instance {name} is not found" } } }, "delete" : { "tags" : [ "Database Services" ], "summary" : "Delete a database service by name", "description" : "Delete a database services by `name`. If databases (and tables) belong the service, it can't be deleted.", "operationId" : "deleteDatabaseServiceByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the database service", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "DatabaseService service for instance {name} is not found" } } } }, "/v1/services/databaseServices/name/{name}/export" : { "get" : { "tags" : [ "Database Services" ], "summary" : "Export database service in CSV format", "operationId" : "exportDatabaseServices", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Database Service", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with services from the database services", "content" : { "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/v1/services/databaseServices/name/{name}/exportAsync" : { "get" : { "tags" : [ "Database Services" ], "summary" : "Export database service in CSV format", "operationId" : "exportDatabaseService", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Database", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with database schemas", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CSVExportResponse" } } } } } } }, "/v1/services/databaseServices/name/{name}/import" : { "put" : { "tags" : [ "Database Services" ], "summary" : "Import service from CSV to update database service (no creation allowed)", "operationId" : "importDatabaseService", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Database Service", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry-run when true is used for validating the CSV without really importing it. (default=true)", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Import result", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/services/databaseServices/name/{name}/importAsync" : { "put" : { "tags" : [ "Database Services" ], "summary" : "Import service from CSV to update database service asynchronously (no creation allowed)", "operationId" : "importDatabaseServiceAsync", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Database Service", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry-run when true is used for validating the CSV without really importing it. (default=true)", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Import initiated successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/services/databaseServices/restore" : { "put" : { "tags" : [ "Database Services" ], "summary" : "Restore a soft deleted database service", "description" : "Restore a soft deleted database service.", "operationId" : "restore_26", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the DatabaseService.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseService" } } } } } } }, "/v1/services/databaseServices/{id}" : { "get" : { "tags" : [ "Database Services" ], "summary" : "Get a database service", "description" : "Get a database service by `Id`.", "operationId" : "getDatabaseServiceByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the database service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "Database service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseService" } } } }, "404" : { "description" : "Database service for instance {id} is not found" } } }, "delete" : { "tags" : [ "Database Services" ], "summary" : "Delete a database service by Id", "description" : "Delete a database services. If databases (and tables) belong the service, it can't be deleted.", "operationId" : "deleteDatabaseService", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the database service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "DatabaseService service for instance {id} is not found" } } }, "patch" : { "tags" : [ "Database Services" ], "summary" : "Update a database service", "description" : "Update an existing database service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchDatabaseService_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the database service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/databaseServices/{id}/testConnectionResult" : { "put" : { "tags" : [ "Database Services" ], "summary" : "Add test connection result", "description" : "Add test connection result to the service.", "operationId" : "addTestConnectionResult_2", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestConnectionResult" } } } }, "responses" : { "200" : { "description" : "Successfully updated the service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseService" } } } } } } }, "/v1/services/databaseServices/{id}/versions" : { "get" : { "tags" : [ "Database Services" ], "summary" : "List database service versions", "description" : "Get a list of all the versions of a database service identified by `Id`", "operationId" : "listAllDatabaseServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the database service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of database service versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/services/databaseServices/{id}/versions/{version}" : { "get" : { "tags" : [ "Database Services" ], "summary" : "Get a version of the database service", "description" : "Get a version of the database service by given `Id`", "operationId" : "getSpecificDatabaseServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the database service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "database service version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "database service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseService" } } } }, "404" : { "description" : "Database service for instance {id} and version {version} is not found" } } } }, "/v1/services/ingestionPipelines" : { "get" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "List ingestion pipelines for metadata operations", "description" : "Get a list of airflow pipelines for metadata operations. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listIngestionPipelines", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners" } }, { "name" : "service", "in" : "query", "description" : "Filter Ingestion Pipelines by service fully qualified name", "schema" : { "type" : "string", "example" : "snowflakeWestCoast" } }, { "name" : "testSuite", "in" : "query", "description" : "Filter Ingestion Pipelines by test suite fully qualified name", "schema" : { "type" : "string", "example" : "service.db.schema.name.testSuite" } }, { "name" : "pipelineType", "in" : "query", "description" : "Filter Ingestion Pipelines by pipeline Type", "schema" : { "type" : "string", "example" : "elasticSearchReindex" } }, { "name" : "serviceType", "in" : "query", "description" : "Filter Ingestion Pipelines by service Type", "schema" : { "type" : "string", "example" : "messagingService" } }, { "name" : "applicationType", "in" : "query", "description" : "Filter Ingestion Pipelines by the type of the application", "schema" : { "type" : "string", "example" : "Automator" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number ingestion returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of ingestion before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of ingestion after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of ingestion workflows", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IngestionPipeline" } } } } } }, "put" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Create or update an ingestion pipeline", "description" : "Create a new ingestion pipeline, if it does not exist or update an existing ingestion pipeline.", "operationId" : "createOrUpdateIngestionPipeline", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateIngestionPipeline" } } } }, "responses" : { "200" : { "description" : "The IngestionPipeline", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IngestionPipeline" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Create an ingestion pipeline", "description" : "Create a new ingestion pipeline.", "operationId" : "createIngestionPipeline", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateIngestionPipeline" } } } }, "responses" : { "200" : { "description" : "The Ingestion Pipeline", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IngestionPipeline" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/services/ingestionPipelines/bulk/deploy" : { "post" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Bulk deploy a list of Ingestion Pipeline", "description" : "Bulk deploy a list of Ingestion Pipelines given a list of IDs", "operationId" : "bulkDeployIngestion", "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } } } } }, "responses" : { "200" : { "description" : "List of Statuses of the deployed pipelines", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineServiceClientResponse" } } } } } } }, "/v1/services/ingestionPipelines/deploy/{id}" : { "post" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Deploy an ingestion pipeline run", "description" : "Deploy a ingestion pipeline run by Id.", "operationId" : "deployIngestion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ingestion pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "The ingestion", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineServiceClientResponse" } } } }, "404" : { "description" : "Ingestion for instance {id} is not found" } } } }, "/v1/services/ingestionPipelines/ip" : { "get" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Check the airflow REST host IP", "description" : "Check the Airflow REST host IP", "operationId" : "checkAirflowHostIp", "responses" : { "200" : { "description" : "Pipeline Service host IP", "content" : { "application/json" : { } } } } } }, "/v1/services/ingestionPipelines/kill/{id}" : { "post" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Mark as failed and kill any not-finished workflow or task for the ingestion pipeline", "description" : "Kill an ingestion pipeline by Id.", "operationId" : "killIngestionPipelineRuns", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ingestion pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "The ingestion", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineServiceClientResponse" } } } }, "404" : { "description" : "Ingestion for instance {id} is not found" } } } }, "/v1/services/ingestionPipelines/logs/{id}/last" : { "get" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Retrieve all logs from last ingestion pipeline run", "description" : "Get all logs from last ingestion pipeline run by `Id`.", "operationId" : "getLastIngestionLogs", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ingestion pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "after", "in" : "query", "description" : "Returns log chunk after this cursor", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "JSON object with the task instance name of the ingestion on each key and log in the value", "content" : { "application/json" : { } } }, "404" : { "description" : "Logs for instance {id} is not found" } } } }, "/v1/services/ingestionPipelines/name/{fqn}" : { "get" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Get an ingestion pipeline by fully qualified name", "description" : "Get an ingestion by fully qualified name.", "operationId" : "getSpecificIngestionPipelineByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the ingestion pipeline", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "IngestionPipeline", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IngestionPipeline" } } } }, "404" : { "description" : "Ingestion for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Delete an ingestion pipeline by fully qualified name", "description" : "Delete an ingestion pipeline by `fullyQualifiedName`.", "operationId" : "deleteIngestionPipelineByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the ingestion pipeline", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Ingestion for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Update an ingestion pipeline using name.", "description" : "Update an existing ingestion pipeline using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchIngestionPipeline", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the ingestion pipeline", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/ingestionPipelines/restore" : { "put" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Restore a soft deleted ingestion pipeline", "description" : "Restore a soft deleted ingestion pipeline.", "operationId" : "restore_27", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the IngestionPipeline. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IngestionPipeline" } } } } } } }, "/v1/services/ingestionPipelines/status" : { "get" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Check the airflow REST status", "description" : "Check that the Airflow REST endpoint is reachable and up and running", "operationId" : "checkRestAirflowStatus", "responses" : { "200" : { "description" : "Status message", "content" : { "application/json" : { } } } } } }, "/v1/services/ingestionPipelines/toggleIngestion/{id}" : { "post" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Set an ingestion pipeline either as enabled or disabled", "description" : "Toggle an ingestion pipeline state by Id.", "operationId" : "toggleIngestionPipelineEnabled", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ingestion pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "The ingestion", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IngestionPipeline" } } } }, "404" : { "description" : "Ingestion for instance {id} is not found" } } } }, "/v1/services/ingestionPipelines/trigger/{id}" : { "post" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Trigger an ingestion pipeline run", "description" : "Trigger a ingestion pipeline run by id.", "operationId" : "triggerIngestionPipelineRun", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ingestion pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "The ingestion", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineServiceClientResponse" } } } }, "404" : { "description" : "Ingestion for instance {id} is not found" } } } }, "/v1/services/ingestionPipelines/{fqn}/pipelineStatus" : { "get" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "List of pipeline status", "description" : "Get a list of all the pipeline status for the given ingestion pipeline id, optionally filtered by `startTs` and `endTs` of the profile. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listPipelineStatuses_1", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the ingestion pipeline", "required" : true, "schema" : { "type" : "string" } }, { "name" : "startTs", "in" : "query", "description" : "Filter pipeline status after the given start timestamp", "schema" : { "type" : "number" } }, { "name" : "endTs", "in" : "query", "description" : "Filter pipeline status before the given end timestamp", "schema" : { "type" : "number" } } ], "responses" : { "200" : { "description" : "List of pipeline status", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IngestionPipeline" } } } } } }, "put" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Add pipeline status", "description" : "Add pipeline status of ingestion pipeline.", "operationId" : "addPipelineStatus", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the ingestion pipeline", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineStatus" } } } }, "responses" : { "200" : { "description" : "Successfully updated the PipelineStatus. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IngestionPipeline" } } } } } } }, "/v1/services/ingestionPipelines/{fqn}/pipelineStatus/{id}" : { "get" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Get pipeline status", "description" : "Get pipeline status of ingestion pipeline", "operationId" : "getPipelineStatus", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the ingestion pipeline", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "description" : "Id of pipeline status run", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successfully updated state of the PipelineStatus.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IngestionPipeline" } } } } } } }, "/v1/services/ingestionPipelines/{id}" : { "get" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Get an ingestion pipeline by Id", "description" : "Get an ingestion pipeline by `Id`.", "operationId" : "getIngestionPipelineByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ingestion pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The ingestion", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IngestionPipeline" } } } }, "404" : { "description" : "IngestionPipeline for instance {id} is not found" } } }, "delete" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Delete an ingestion pipeline by Id", "description" : "Delete an ingestion pipeline by `Id`.", "operationId" : "deleteIngestionPipeline", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the ingestion pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Ingestion for instance {id} is not found" } } }, "patch" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Update an ingestion pipeline", "description" : "Update an existing ingestion pipeline using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchIngestionPipeline_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ingestion pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/ingestionPipelines/{id}/pipelineStatus" : { "delete" : { "tags" : [ "ingestionPipelines", "Ingestion Pipelines" ], "summary" : "Delete Pipeline Status", "description" : "Delete the Pipeline Status for this Ingestion Pipeline.", "operationId" : "deletePipelineStatus", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Ingestion Pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Successfully deleted the Statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IngestionPipeline" } } } } } } }, "/v1/services/ingestionPipelines/{id}/versions" : { "get" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "List ingestion workflow versions", "description" : "Get a list of all the versions of a ingestion pipeline identified by `Id`", "operationId" : "listAllIngestionPipelineVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ingestion pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of IngestionPipeline versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/services/ingestionPipelines/{id}/versions/{version}" : { "get" : { "tags" : [ "Ingestion Pipelines" ], "summary" : "Get a version of the ingestion pipeline", "description" : "Get a version of the ingestion pipeline by given `Id`", "operationId" : "getSpecificIngestionPipelineVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ingestion pipeline", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Ingestion version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "IngestionPipelines", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IngestionPipeline" } } } }, "404" : { "description" : "IngestionPipeline for instance {id} and version {version} is not found" } } } }, "/v1/services/messagingServices" : { "get" : { "tags" : [ "Messaging Services" ], "summary" : "List messaging services", "description" : "Get a list of messaging services. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listMessagingService", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,domain" } }, { "name" : "domain", "in" : "query", "description" : "Filter services by domain", "schema" : { "type" : "string", "example" : "Marketing" } }, { "name" : "limit", "in" : "query", "description" : "Limit number services returned. (1 to 1000000, default 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of services before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of services after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of messaging services", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessagingServiceList" } } } } } }, "put" : { "tags" : [ "Messaging Services" ], "summary" : "Update messaging service", "description" : "Create a new messaging service or Update an existing messaging service identified by `id`.", "operationId" : "createOrUpdateMessagingService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateMessagingService" } } } }, "responses" : { "200" : { "description" : "Messaging service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessagingService" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Messaging Services" ], "summary" : "Create a messaging service", "description" : "Create a new messaging service.", "operationId" : "createMessagingService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateMessagingService" } } } }, "responses" : { "200" : { "description" : "Messaging service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessagingService" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/services/messagingServices/name/{fqn}" : { "patch" : { "tags" : [ "Messaging Services" ], "summary" : "Update a messaging service using name.", "description" : "Update an existing messaging service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchMessagingService", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the messaging service", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/messagingServices/name/{name}" : { "get" : { "tags" : [ "Messaging Services" ], "summary" : "Get messaging service by name", "description" : "Get a messaging service by the service `name`.", "operationId" : "getMessagingServiceByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the messaging service", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "Messaging service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessagingService" } } } }, "404" : { "description" : "Messaging service for instance {name} is not found" } } }, "delete" : { "tags" : [ "Messaging Services" ], "summary" : "Delete a messaging service by name", "description" : "Delete a messaging service by `name`. If topics belong the service, it can't be deleted.", "operationId" : "deleteMessagingServiceByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the messaging service", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "MessagingService service for instance {name} is not found" } } } }, "/v1/services/messagingServices/restore" : { "put" : { "tags" : [ "Messaging Services" ], "summary" : "Restore a soft deleted messaging service", "description" : "Restore a soft deleted messaging service.", "operationId" : "restore_28", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the MessagingService ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessagingService" } } } } } } }, "/v1/services/messagingServices/{id}" : { "get" : { "tags" : [ "Messaging Services" ], "summary" : "Get a messaging service by Id", "description" : "Get a messaging service by `Id`.", "operationId" : "getMessagingServiceByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the messaging service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "Messaging service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessagingService" } } } }, "404" : { "description" : "Messaging service for instance {id} is not found" } } }, "delete" : { "tags" : [ "Messaging Services" ], "summary" : "Delete a messaging service by Id", "description" : "Delete a messaging service. If topics belong the service, it can't be deleted.", "operationId" : "deleteMessagingService", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the messaging service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "MessagingService service for instance {id} is not found" } } }, "patch" : { "tags" : [ "Messaging Services" ], "summary" : "Update a messaging service", "description" : "Update an existing messaging service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchMessagingService_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the messaging service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/messagingServices/{id}/testConnectionResult" : { "put" : { "tags" : [ "Messaging Services" ], "summary" : "Add test connection result", "description" : "Add test connection result to the service.", "operationId" : "addTestConnectionResult_3", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestConnectionResult" } } } }, "responses" : { "200" : { "description" : "Successfully updated the service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessagingService" } } } } } } }, "/v1/services/messagingServices/{id}/versions" : { "get" : { "tags" : [ "Messaging Services" ], "summary" : "List messaging service versions", "description" : "Get a list of all the versions of a messaging service identified by `id`", "operationId" : "listAllMessagingServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the messaging service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of messaging service versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/services/messagingServices/{id}/versions/{version}" : { "get" : { "tags" : [ "Messaging Services" ], "summary" : "Get a version of the messaging service", "description" : "Get a version of the messaging service by given `Id`", "operationId" : "getSpecificMessagingServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the messaging service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "messaging service version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "messaging service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessagingService" } } } }, "404" : { "description" : "Messaging service for instance {id} and version {version} is not found" } } } }, "/v1/services/metadataServices" : { "get" : { "tags" : [ "Metadata Services" ], "summary" : "List metadata services", "description" : "Get a list of metadata services.", "operationId" : "listMetadataServices", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags" } }, { "name" : "limit", "in" : "query", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of metadata services before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of metadata services after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of Metadata Service instances", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataServiceList" } } } } } }, "put" : { "tags" : [ "Metadata Services" ], "summary" : "Update metadata service", "description" : "Update an existing or create a new Metadata Service.", "operationId" : "createOrUpdateMetadataService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateMetadataService" } } } }, "responses" : { "200" : { "description" : "Metadata Service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataService" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Metadata Services" ], "summary" : "Create metadata service", "description" : "Create a new Metadata Service.", "operationId" : "createMetadataService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateMetadataService" } } } }, "responses" : { "200" : { "description" : "Metadata Service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataService" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/services/metadataServices/name/{fqn}" : { "patch" : { "tags" : [ "Metadata Services" ], "summary" : "Update a metadata service using name.", "description" : "Update an existing Metadata service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchMetadataService", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the metadata service", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/metadataServices/name/{name}" : { "get" : { "tags" : [ "Metadata Services" ], "summary" : "Get a metadata service by name", "description" : "Get a Metadata Service by the service `name`.", "operationId" : "getMetadataServiceByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the metadata service", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "Metadata Service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataService" } } } }, "404" : { "description" : "Metadata Service for instance {name} is not found" } } }, "delete" : { "tags" : [ "Metadata Services" ], "summary" : "Delete a metadata service by name", "description" : "Delete a metadata services by `name`. If some service belong the service, it can't be deleted.", "operationId" : "deleteMetadataServiceByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the metadata service", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "MetadataService service for instance {name} is not found" } } } }, "/v1/services/metadataServices/restore" : { "put" : { "tags" : [ "Metadata Services" ], "summary" : "Restore a soft deleted metadata service.", "description" : "Restore a soft deleted metadata service.", "operationId" : "restore_29", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the MetadataService ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataService" } } } } } } }, "/v1/services/metadataServices/{id}" : { "get" : { "tags" : [ "Metadata Services" ], "summary" : "Get a metadata service by Id", "description" : "Get a Metadata Service by `Id`.", "operationId" : "getMetadataServiceByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the metadata service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "Metadata Service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataService" } } } }, "404" : { "description" : "Metadata Service for instance {id} is not found" } } }, "delete" : { "tags" : [ "Metadata Services" ], "summary" : "Delete a metadata service by Id", "description" : "Delete a metadata services. If some service belong the service, it can't be deleted.", "operationId" : "deleteMetadataService", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the metadata service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "MetadataService service for instance {id} is not found" } } }, "patch" : { "tags" : [ "Metadata Services" ], "summary" : "Update a metadata service", "description" : "Update an existing Metadata service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchMetadataService_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the metadata service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/metadataServices/{id}/testConnectionResult" : { "put" : { "tags" : [ "Metadata Services" ], "summary" : "Add test connection result", "description" : "Add test connection result to the service.", "operationId" : "addTestConnectionResult_4", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestConnectionResult" } } } }, "responses" : { "200" : { "description" : "Successfully updated the service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataService" } } } } } } }, "/v1/services/metadataServices/{id}/versions" : { "get" : { "tags" : [ "Metadata Services" ], "summary" : "List metadata service versions", "description" : "Get a list of all the versions of a Metadata Service identified by `Id`", "operationId" : "listAllMetadataServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the metadata service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of Metadata Service versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/services/metadataServices/{id}/versions/{version}" : { "get" : { "tags" : [ "Metadata Services" ], "summary" : "Get a version of the metadata service", "description" : "Get a version of the Metadata Service by given `Id`", "operationId" : "getSpecificMetadataServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the metadata service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Metadata Service version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "Metadata Service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataService" } } } }, "404" : { "description" : "Metadata Service for instance {id} and version {version} is not found" } } } }, "/v1/services/mlmodelServices" : { "get" : { "tags" : [ "ML Model Services" ], "summary" : "List ML model services", "description" : "Get a list of mlModel services. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listMlModelService", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "domain", "in" : "query", "description" : "Filter services by domain", "schema" : { "type" : "string", "example" : "Marketing" } }, { "name" : "limit", "in" : "query", "description" : "Limit number services returned. (1 to 1000000, default 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of services before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of services after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of mlModel services", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModelServiceList" } } } } } }, "put" : { "tags" : [ "ML Model Services" ], "summary" : "Update ML model service", "description" : "Create a new mlModel service or update an existing mlModel service identified by `Id`.", "operationId" : "createOrUpdateMlModelService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateMlModelService" } } } }, "responses" : { "200" : { "description" : "MlModel service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModelService" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "ML Model Services" ], "summary" : "Create an ML model service", "description" : "Create a new mlModel service.", "operationId" : "createMlModelService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateMlModelService" } } } }, "responses" : { "200" : { "description" : "MlModel service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModelService" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/services/mlmodelServices/name/{fqn}" : { "patch" : { "tags" : [ "ML Model Services" ], "summary" : "Update an ML model service using name.", "description" : "Update an existing MlModelService service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchMlModelService", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the ML Model service", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/mlmodelServices/name/{name}" : { "get" : { "tags" : [ "ML Model Services" ], "summary" : "Get an ML model service by name", "description" : "Get a mlModel service by the service `name`.", "operationId" : "getMlModelServiceByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the ML Model service", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "MlModel service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModelService" } } } }, "404" : { "description" : "MlModel service for instance {name} is not found" } } }, "delete" : { "tags" : [ "ML Model Services" ], "summary" : "Delete an ML model service by name", "description" : "Delete a mlModel services by `name`. If mlModels (and tasks) belong to the service, it can't be deleted.", "operationId" : "deleteMlModelServiceByName", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the ML Model service", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "MlModel service for instance {name} is not found" } } } }, "/v1/services/mlmodelServices/restore" : { "put" : { "tags" : [ "ML Model Services" ], "summary" : "Restore a soft deleted ML model service", "description" : "Restore a soft deleted Ml model service.", "operationId" : "restore_30", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the MlModelService ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModelService" } } } } } } }, "/v1/services/mlmodelServices/{id}" : { "get" : { "tags" : [ "ML Model Services" ], "summary" : "Get an ML model service by Id", "description" : "Get a mlModel service by `Id`.", "operationId" : "getMlModelServiceByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ML Model service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "MlModel service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModelService" } } } }, "404" : { "description" : "MlModel service for instance {id} is not found" } } }, "delete" : { "tags" : [ "ML Model Services" ], "summary" : "Delete an ML model service by Id", "description" : "Delete a mlModel services. If mlModels (and tasks) belong to the service, it can't be deleted.", "operationId" : "deleteMlModelService", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the ML Model service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "MlModel service for instance {id} is not found" } } }, "patch" : { "tags" : [ "ML Model Services" ], "summary" : "Update an ML model service", "description" : "Update an existing MlModelService service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchMlModelService_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ML Model service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/mlmodelServices/{id}/testConnectionResult" : { "put" : { "tags" : [ "ML Model Services" ], "summary" : "Add test connection result", "description" : "Add test connection result to the service.", "operationId" : "addTestConnectionResult_5", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestConnectionResult" } } } }, "responses" : { "200" : { "description" : "Successfully updated the service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModelService" } } } } } } }, "/v1/services/mlmodelServices/{id}/versions" : { "get" : { "tags" : [ "ML Model Services" ], "summary" : "List ML model service versions", "description" : "Get a list of all the versions of a mlModel service identified by `Id`", "operationId" : "listAllMlModelServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ML Model service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of mlModel service versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/services/mlmodelServices/{id}/versions/{version}" : { "get" : { "tags" : [ "ML Model Services" ], "summary" : "Get a version of the ML model service", "description" : "Get a version of the mlModel service by given `Id`", "operationId" : "getSpecificMlModelService", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the ML Model service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "mlModel service version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "mlModel service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MlModelService" } } } }, "404" : { "description" : "MlModel service for instance {id} and version {version} is not found" } } } }, "/v1/services/pipelineServices" : { "get" : { "tags" : [ "Pipeline Services" ], "summary" : "List pipeline services", "description" : "Get a list of pipeline services. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listPipelineService", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,domain" } }, { "name" : "domain", "in" : "query", "description" : "Filter services by domain", "schema" : { "type" : "string", "example" : "Marketing" } }, { "name" : "limit", "in" : "query", "description" : "Limit number services returned. (1 to 1000000, default 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of services before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of services after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of pipeline services", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineServiceList" } } } } } }, "put" : { "tags" : [ "Pipeline Services" ], "summary" : "Update pipeline service", "description" : "Create a new pipeline service or update an existing pipeline service identified by `id`.", "operationId" : "createOrUpdatePipelineService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreatePipelineService" } } } }, "responses" : { "200" : { "description" : "Pipeline service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineService" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Pipeline Services" ], "summary" : "Create a pipeline service", "description" : "Create a new pipeline service.", "operationId" : "createPipelineService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreatePipelineService" } } } }, "responses" : { "200" : { "description" : "Pipeline service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineService" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/services/pipelineServices/name/{fqn}" : { "get" : { "tags" : [ "Pipeline Services" ], "summary" : "Get pipeline service by fully qualified name", "description" : "Get a pipeline service by the service `fullyQualifiedName`.", "operationId" : "getPipelineServiceByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the pipeline service", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "Pipeline service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineService" } } } }, "404" : { "description" : "Pipeline service for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Pipeline Services" ], "summary" : "Delete a pipeline service by fully qualified name", "description" : "Delete a pipeline services by `fullyQualifiedName`. If pipelines (and tasks) belong to the service, it can't be deleted.", "operationId" : "deletePipelineServiceByName", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the pipeline service", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Pipeline service for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Pipeline Services" ], "summary" : "Update a pipeline service using name.", "description" : "Update an existing pipeline service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchPipelineService", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the pipeline service", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/pipelineServices/restore" : { "put" : { "tags" : [ "Pipeline Services" ], "summary" : "Restore a soft deleted pipeline service.", "description" : "Restore a soft deleted pipeline service.", "operationId" : "restore_31", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the PipelineService ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineService" } } } } } } }, "/v1/services/pipelineServices/{id}" : { "get" : { "tags" : [ "Pipeline Services" ], "summary" : "Get a pipeline service by Id", "description" : "Get a pipeline service by `Id`.", "operationId" : "getPipelineServiceByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the pipeline service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "Pipeline service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineService" } } } }, "404" : { "description" : "Pipeline service for instance {id} is not found" } } }, "delete" : { "tags" : [ "Pipeline Services" ], "summary" : "Delete a pipeline service by Id", "description" : "Delete a pipeline services. If pipelines (and tasks) belong to the service, it can't be deleted.", "operationId" : "deletePipelineService", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the pipeline service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Pipeline service for instance {id} is not found" } } }, "patch" : { "tags" : [ "Pipeline Services" ], "summary" : "Update a pipeline service", "description" : "Update an existing pipeline service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchPipelineService_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the pipeline service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/pipelineServices/{id}/testConnectionResult" : { "put" : { "tags" : [ "Pipeline Services" ], "summary" : "Add test connection result", "description" : "Add test connection result to the service.", "operationId" : "addTestConnectionResult_6", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestConnectionResult" } } } }, "responses" : { "200" : { "description" : "Successfully updated the service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineService" } } } } } } }, "/v1/services/pipelineServices/{id}/versions" : { "get" : { "tags" : [ "Pipeline Services" ], "summary" : "List pipeline service versions", "description" : "Get a list of all the versions of a pipeline service identified by `Id`", "operationId" : "listAllPipelineServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the pipeline service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of pipeline service versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/services/pipelineServices/{id}/versions/{version}" : { "get" : { "tags" : [ "Pipeline Services" ], "summary" : "Get a version of the pipeline service", "description" : "Get a version of the pipeline service by given `Id`", "operationId" : "getSpecificPipelineService", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the pipeline service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "pipeline service version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "pipeline service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PipelineService" } } } }, "404" : { "description" : "Pipeline service for instance {id} and version {version} is not found" } } } }, "/v1/services/searchServices" : { "get" : { "tags" : [ "Search Services" ], "summary" : "List search services", "description" : "Get a list of search services.", "operationId" : "listSearchServices", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "domain", "in" : "query", "description" : "Filter services by domain", "schema" : { "type" : "string", "example" : "Marketing" } }, { "name" : "limit", "in" : "query", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of search services before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of search services after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of search service instances", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchServiceList" } } } } } }, "put" : { "tags" : [ "Search Services" ], "summary" : "Update search service", "description" : "Update an existing or create a new search service.", "operationId" : "createOrUpdateSearchService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateSearchService" } } } }, "responses" : { "200" : { "description" : "Object store service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchService" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Search Services" ], "summary" : "Create search service", "description" : "Create a new search service.", "operationId" : "createSearchService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateSearchService" } } } }, "responses" : { "200" : { "description" : "Search service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchService" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/services/searchServices/name/{fqn}" : { "delete" : { "tags" : [ "Search Services" ], "summary" : "Delete an SearchService by fully qualified name", "description" : "Delete an SearchService by `fullyQualifiedName`.", "operationId" : "deleteSearchServiceByFQN", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Name of the SearchService", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "SearchService for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Search Services" ], "summary" : "Update an search service using name.", "description" : "Update an existing search service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchSearchService", "parameters" : [ { "name" : "fqn", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/searchServices/name/{name}" : { "get" : { "tags" : [ "Search Services" ], "summary" : "Get search service by name", "description" : "Get a search service by the service `name`.", "operationId" : "getSearchServiceByFQN", "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "search service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchService" } } } }, "404" : { "description" : "search service for instance {id} is not found" } } } }, "/v1/services/searchServices/restore" : { "put" : { "tags" : [ "Search Services" ], "summary" : "Restore a soft deleted SearchService.", "description" : "Restore a soft deleted SearchService.", "operationId" : "restore_32", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the SearchService.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchService" } } } } } } }, "/v1/services/searchServices/{id}" : { "get" : { "tags" : [ "Search Services" ], "summary" : "Get an search service", "description" : "Get an search service by `id`.", "operationId" : "getSearchServiceByID", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "search service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchService" } } } }, "404" : { "description" : "search service for instance {id} is not found" } } }, "delete" : { "tags" : [ "Search Services" ], "summary" : "Delete an search service", "description" : "Delete an search services. If containers belong the service, it can't be deleted.", "operationId" : "deleteSearchService", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the search service", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "SearchService service for instance {id} is not found" } } }, "patch" : { "tags" : [ "Search Services" ], "summary" : "Update an search service", "description" : "Update an existing search service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchSearchService_1", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/searchServices/{id}/testConnectionResult" : { "put" : { "tags" : [ "Search Services" ], "summary" : "Add test connection result", "description" : "Add test connection result to the service.", "operationId" : "addTestConnectionResult_7", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestConnectionResult" } } } }, "responses" : { "200" : { "description" : "Successfully updated the service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchService" } } } } } } }, "/v1/services/searchServices/{id}/versions" : { "get" : { "tags" : [ "Search Services" ], "summary" : "List search service versions", "description" : "Get a list of all the versions of an search service identified by `id`", "operationId" : "listAllSearchServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "search service Id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of search service versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/services/searchServices/{id}/versions/{version}" : { "get" : { "tags" : [ "Search Services" ], "summary" : "Get a version of the search service", "description" : "Get a version of the search service by given `id`", "operationId" : "getSpecificSearchServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "search service Id", "required" : true, "schema" : { "type" : "string" } }, { "name" : "version", "in" : "path", "description" : "search service version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "search service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchService" } } } }, "404" : { "description" : "Object store service for instance {id} and version {version} is not found" } } } }, "/v1/services/storageServices" : { "get" : { "tags" : [ "Object Store Services" ], "summary" : "List storage services", "description" : "Get a list of storage services.", "operationId" : "listStorageServices", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "domain", "in" : "query", "description" : "Filter services by domain", "schema" : { "type" : "string", "example" : "Marketing" } }, { "name" : "limit", "in" : "query", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of storage services before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of storage services after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of storage service instances", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StorageServiceList" } } } } } }, "put" : { "tags" : [ "Object Store Services" ], "summary" : "Update storage service", "description" : "Update an existing or create a new storage service.", "operationId" : "createOrUpdateStorageService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateStorageService" } } } }, "responses" : { "200" : { "description" : "Object store service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StorageService" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Object Store Services" ], "summary" : "Create storage service", "description" : "Create a new storage service.", "operationId" : "createStorageService", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateStorageService" } } } }, "responses" : { "200" : { "description" : "Object store service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StorageService" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/services/storageServices/name/{fqn}" : { "delete" : { "tags" : [ "Object Store Services" ], "summary" : "Delete an StorageService by fully qualified name", "description" : "Delete an StorageService by `fullyQualifiedName`.", "operationId" : "deleteStorageServiceByFQN", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Name of the StorageService", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "StorageService for instance {fqn} is not found" } } } }, "/v1/services/storageServices/name/{name}" : { "get" : { "tags" : [ "Object Store Services" ], "summary" : "Get storage service by name", "description" : "Get a storage service by the service `name`.", "operationId" : "getStorageServiceByFQN", "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "Object store service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StorageService" } } } }, "404" : { "description" : "Object store service for instance {id} is not found" } } } }, "/v1/services/storageServices/restore" : { "put" : { "tags" : [ "Object Store Services" ], "summary" : "Restore a soft deleted StorageService.", "description" : "Restore a soft deleted StorageService.", "operationId" : "restore_33", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the StorageService.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StorageService" } } } } } } }, "/v1/services/storageServices/{id}" : { "get" : { "tags" : [ "Object Store Services" ], "summary" : "Get an storage service", "description" : "Get an storage service by `id`.", "operationId" : "getStorageServiceByID", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "pipelines,owners,tags,domain" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "Object store service instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StorageService" } } } }, "404" : { "description" : "Object store service for instance {id} is not found" } } }, "delete" : { "tags" : [ "Object Store Services" ], "summary" : "Delete an storage service", "description" : "Delete an storage services. If containers belong the service, it can't be deleted.", "operationId" : "deleteStorageService", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the storage service", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "StorageService service for instance {id} is not found" } } }, "patch" : { "tags" : [ "Object Store Services" ], "summary" : "Update an storage service", "description" : "Update an existing storage service using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchStorageService", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/services/storageServices/{id}/testConnectionResult" : { "put" : { "tags" : [ "Object Store Services" ], "summary" : "Add test connection result", "description" : "Add test connection result to the service.", "operationId" : "addTestConnectionResult_8", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the service", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestConnectionResult" } } } }, "responses" : { "200" : { "description" : "Successfully updated the service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseService" } } } } } } }, "/v1/services/storageServices/{id}/versions" : { "get" : { "tags" : [ "Object Store Services" ], "summary" : "List storage service versions", "description" : "Get a list of all the versions of an storage service identified by `id`", "operationId" : "listAllStorageServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "storage service Id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of storage service versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/services/storageServices/{id}/versions/{version}" : { "get" : { "tags" : [ "Object Store Services" ], "summary" : "Get a version of the storage service", "description" : "Get a version of the storage service by given `id`", "operationId" : "getSpecificStorageServiceVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "storage service Id", "required" : true, "schema" : { "type" : "string" } }, { "name" : "version", "in" : "path", "description" : "storage service version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "storage service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StorageService" } } } }, "404" : { "description" : "Object store service for instance {id} and version {version} is not found" } } } }, "/v1/storedProcedures" : { "get" : { "tags" : [ "Stored Procedures" ], "summary" : "List Stored Procedures", "description" : "Get a list of stored procedures, optionally filtered by `databaseSchema` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listStoredProcedures", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tags,followers,extension,domain,sourceHash" } }, { "name" : "databaseSchema", "in" : "query", "description" : "Filter stored procedures by database schema", "schema" : { "type" : "string", "example" : "customerDatabaseSchema" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number schemas returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of schemas before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of schemas after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of stored procedures", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredProcedureList" } } } } } }, "put" : { "tags" : [ "Stored Procedures" ], "summary" : "Create or update Stored Procedure", "description" : "Create a stored procedure, if it does not exist or update an existing stored procedure.", "operationId" : "createOrUpdateStoredProcedure", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateStoredProcedure" } } } }, "responses" : { "200" : { "description" : "The updated schema ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredProcedure" } } } } } }, "post" : { "tags" : [ "Stored Procedures" ], "summary" : "Create a Stored Procedure", "description" : "Create a Stored Procedure under an existing `service`.", "operationId" : "createStoredProcedure", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateStoredProcedure" } } } }, "responses" : { "200" : { "description" : "The Stored Procedure", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredProcedure" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/storedProcedures/name/{fqn}" : { "get" : { "tags" : [ "Stored Procedures" ], "summary" : "Get a Stored Procedure by fully qualified name", "description" : "Get a Stored Procedure by fully qualified name.", "operationId" : "getStoredProcedureByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the Stored Procedure", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tags,followers,extension,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The schema", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredProcedure" } } } }, "404" : { "description" : "Stored Procedure for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Stored Procedures" ], "summary" : "Delete a schema by fully qualified name", "description" : "Delete a schema by `fullyQualifiedName`. Schema can only be deleted if it has no tables.", "operationId" : "deleteDBSchemaByFQN_1", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Name of the DBSchema", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Schema for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Stored Procedures" ], "summary" : "Update a Stored Procedure by name.", "description" : "Update an existing StoredProcedure using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchStoredProcedure", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Stored Procedure name", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/storedProcedures/restore" : { "put" : { "tags" : [ "Stored Procedures" ], "summary" : "Restore a soft deleted stored procedure.", "description" : "Restore a soft deleted stored procedure.", "operationId" : "restore_9", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the StoredProcedure ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredProcedure" } } } } } } }, "/v1/storedProcedures/{id}" : { "get" : { "tags" : [ "Stored Procedures" ], "summary" : "Get a stored procedure by Id", "description" : "Get a stored procedure by `Id`.", "operationId" : "getStoredProcedureByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Stored Procedure Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,tags,followers,extension,domain,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The Stored Procedure", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredProcedure" } } } }, "404" : { "description" : "Schema for instance {id} is not found" } } }, "delete" : { "tags" : [ "Stored Procedures" ], "summary" : "Delete a StoredProcedure by Id", "description" : "Delete a StoredProcedure by `Id`.", "operationId" : "deleteStoredProcedure", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Database schema Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "StoredProcedure for instance {id} is not found" } } }, "patch" : { "tags" : [ "Stored Procedures" ], "summary" : "Update a Stored Procedure", "description" : "Update an existing StoredProcedure using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchStoredProcedure_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Stored Procedure Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/storedProcedures/{id}/followers" : { "put" : { "tags" : [ "Stored Procedures" ], "summary" : "Add a follower", "description" : "Add a user identified by `userId` as followed of this Stored Procedure", "operationId" : "addFollower_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the StoredProcedure", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "Id of the user to be added as follower", "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "uuid" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "StoredProcedure for instance {id} is not found" } } } }, "/v1/storedProcedures/{id}/followers/{userId}" : { "delete" : { "tags" : [ "Stored Procedures" ], "summary" : "Remove a follower", "description" : "Remove the user identified `userId` as a follower of the Stored Procedure.", "operationId" : "deleteFollower_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Stored Procedure", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed as follower", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } } } } }, "/v1/storedProcedures/{id}/versions" : { "get" : { "tags" : [ "Stored Procedures" ], "summary" : "List stored procedure versions", "description" : "Get a list of all the versions of a stored procedure identified by `Id`", "operationId" : "listAllStoredProceduresVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Stored Procedure Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of schema versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/storedProcedures/{id}/versions/{version}" : { "get" : { "tags" : [ "Stored Procedures" ], "summary" : "Get a version of the Stored Procedure", "description" : "Get a version of the Stored Procedure by given `Id`", "operationId" : "getSpecificStoredProcedureVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Stored Procedure Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Stored Procedure version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "database schema", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredProcedure" } } } }, "404" : { "description" : "Stored Procedure for instance {id} and version {version} is not found" } } } }, "/v1/storedProcedures/{id}/vote" : { "put" : { "tags" : [ "Stored Procedures" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_4", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/suggestions" : { "get" : { "tags" : [ "Suggestions" ], "summary" : "List Suggestions", "description" : "Get a list of suggestions, optionally filtered by `entityLink` or `entityFQN`.", "operationId" : "listSuggestions", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Limit the number of suggestions returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of threads before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of threads after this cursor", "schema" : { "type" : "string" } }, { "name" : "entityFQN", "in" : "query", "description" : "Filter suggestions by entityFQN", "schema" : { "type" : "string" } }, { "name" : "userId", "in" : "query", "description" : "Filter threads by user id or bot id. This filter requires a 'filterType' query param.", "schema" : { "type" : "string" } }, { "name" : "status", "in" : "query", "description" : "Filter threads by whether they are accepted or rejected. By default status is OPEN.", "schema" : { "type" : "string", "default" : "Open" } } ], "responses" : { "200" : { "description" : "List of Suggestions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuggestionList" } } } } } }, "post" : { "tags" : [ "Suggestions" ], "summary" : "Create a Suggestion", "description" : "Create a new Suggestion. A Suggestion is created about a data asset when a user suggests an update.", "operationId" : "createSuggestion", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateSuggestion" } } } }, "responses" : { "200" : { "description" : "The thread", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Suggestion" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/suggestions/accept-all" : { "put" : { "tags" : [ "Suggestions" ], "summary" : "Accept all Suggestions from a user and an Entity", "description" : "Accept a Suggestion and apply the changes to the entity.", "operationId" : "acceptAllSuggestion", "parameters" : [ { "name" : "userId", "in" : "query", "description" : "user id", "schema" : { "type" : "string" } }, { "name" : "entityFQN", "in" : "query", "description" : "fullyQualifiedName of entity", "schema" : { "type" : "string" } }, { "name" : "suggestionType", "in" : "query", "description" : "Suggestion type being accepted", "schema" : { "type" : "string", "default" : "SuggestDescription" } } ], "responses" : { "200" : { "description" : "The suggestion.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Suggestion" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/suggestions/reject-all" : { "put" : { "tags" : [ "Suggestions" ], "summary" : "Reject all Suggestions from a user and an Entity", "description" : "Reject all Suggestions from a user and an Entity", "operationId" : "rejectAllSuggestion", "parameters" : [ { "name" : "userId", "in" : "query", "description" : "user id", "schema" : { "type" : "string" } }, { "name" : "entityFQN", "in" : "query", "description" : "fullyQualifiedName of entity", "schema" : { "type" : "string" } }, { "name" : "suggestionType", "in" : "query", "description" : "Suggestion type being rejected", "schema" : { "type" : "string", "default" : "SuggestDescription" } } ], "responses" : { "200" : { "description" : "The suggestion.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Suggestion" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/suggestions/{entityType}/name/{entityFQN}" : { "delete" : { "tags" : [ "Suggestions" ], "summary" : "Delete a Suggestions by entityFQN", "description" : "Delete an existing Suggestions and all its relationships.", "operationId" : "deleteSuggestions", "parameters" : [ { "name" : "entityType", "in" : "path", "description" : "entity type", "required" : true, "schema" : { "type" : "string" } }, { "name" : "entityFQN", "in" : "path", "description" : "fullyQualifiedName of entity", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "thread with {threadId} is not found" }, "400" : { "description" : "Bad request" } } } }, "/v1/suggestions/{id}" : { "get" : { "tags" : [ "Suggestions" ], "summary" : "Get a suggestion by Id", "description" : "Get a suggestion by `Id`.", "operationId" : "getSuggestionByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Thread", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The Suggestion", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Suggestion" } } } }, "404" : { "description" : "Suggestion for instance {id} is not found" } } }, "put" : { "tags" : [ "Suggestions" ], "summary" : "Update a suggestion by `Id`.", "description" : "Update an existing suggestion using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "updateSuggestion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Suggestion", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Suggestion" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/suggestions/{id}/accept" : { "put" : { "tags" : [ "Suggestions" ], "summary" : "Accept a Suggestion", "description" : "Accept a Suggestion and apply the changes to the entity.", "operationId" : "acceptSuggestion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the suggestion", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The suggestion.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Suggestion" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/suggestions/{id}/reject" : { "put" : { "tags" : [ "Suggestions" ], "summary" : "Reject a Suggestion", "description" : "Close a Suggestion without making any changes to the entity.", "operationId" : "rejectSuggestion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the suggestion", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The Suggestion.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Suggestion" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/suggestions/{suggestionId}" : { "delete" : { "tags" : [ "Suggestions" ], "summary" : "Delete a Suggestion by Id", "description" : "Delete an existing Suggestion and all its relationships.", "operationId" : "deleteSuggestion", "parameters" : [ { "name" : "suggestionId", "in" : "path", "description" : "ThreadId of the thread to be deleted", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "thread with {threadId} is not found" }, "400" : { "description" : "Bad request" } } } }, "/v1/system/version" : { "get" : { "tags" : [ "System" ], "summary" : "Get version of metadata service", "description" : "Get the build version of OpenMetadata service and build timestamp.", "operationId" : "getCatalogVersion", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OpenMetadataServerVersion" } } } } } } }, "/v1/tables" : { "get" : { "tags" : [ "Tables" ], "summary" : "List tables", "description" : "Get a list of tables, optionally filtered by `database` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listTables", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "tableConstraints,tablePartition,usageSummary,owners,customMetrics,columns,tags,followers,joins,schemaDefinition,dataModel,extension,testSuite,domain,dataProducts,lifeCycle,sourceHash" } }, { "name" : "database", "in" : "query", "description" : "Filter tables by database fully qualified name", "schema" : { "type" : "string", "example" : "snowflakeWestCoast.financeDB" } }, { "name" : "databaseSchema", "in" : "query", "description" : "Filter tables by databaseSchema fully qualified name", "schema" : { "type" : "string", "example" : "snowflakeWestCoast.financeDB.schema" } }, { "name" : "includeEmptyTestSuite", "in" : "query", "description" : "Include tables with an empty test suite (i.e. no test cases have been created for this table). Default to true", "schema" : { "type" : "boolean", "example" : true, "default" : true } }, { "name" : "limit", "in" : "query", "description" : "Limit the number tables returned. (1 to 1000000, default = 10) ", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of tables before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of tables after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of tables", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TableList" } } } } } }, "put" : { "tags" : [ "Tables" ], "summary" : "Create or update a table", "description" : "Create a table, if it does not exist. If a table already exists, update the table.", "operationId" : "createOrUpdateTable", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTable" } } } }, "responses" : { "200" : { "description" : "The table", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Tables" ], "summary" : "Create a table", "description" : "Create a new table under an existing `database`.", "operationId" : "createTable", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTable" } } } }, "responses" : { "200" : { "description" : "table", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/tables/entityRelationship" : { "get" : { "tags" : [ "Tables" ], "summary" : "Search Entity Relationship", "operationId" : "searchEntityRelationship", "parameters" : [ { "name" : "fqn", "in" : "query", "description" : "fqn", "schema" : { "type" : "string" } }, { "name" : "upstreamDepth", "in" : "query", "description" : "upstreamDepth", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "downstreamDepth", "in" : "query", "description" : "downstreamDepth", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "query_filter", "in" : "query", "description" : "Elasticsearch query that will be combined with the query_string query generator from the `query` argument", "schema" : { "type" : "string" } }, { "name" : "includeDeleted", "in" : "query", "description" : "Filter documents by deleted param. By default deleted is false", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "search response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchResponse" } } } } } } }, "/v1/tables/name/{fqn}" : { "get" : { "tags" : [ "Tables" ], "summary" : "Get a table by fully qualified name", "description" : "Get a table by fully qualified table name.", "operationId" : "getTableByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the table", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "tableConstraints,tablePartition,usageSummary,owners,customMetrics,columns,tags,followers,joins,schemaDefinition,dataModel,extension,testSuite,domain,dataProducts,lifeCycle,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "table", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } }, "404" : { "description" : "Table for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Tables" ], "summary" : "Delete a table by fully qualified name", "description" : "Delete a table by `fullyQualifiedName`.", "operationId" : "deleteTable_1", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Name of the table", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Table for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Tables" ], "summary" : "Update a table by name.", "description" : "Update an existing table using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchTable", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the table", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/tables/name/{name}/export" : { "get" : { "tags" : [ "Tables" ], "summary" : "Export table in CSV format", "operationId" : "exportTable", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the table", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with columns from the table", "content" : { "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/v1/tables/name/{name}/exportAsync" : { "get" : { "tags" : [ "Tables" ], "summary" : "Export table in CSV format", "operationId" : "exportTable_1", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the table", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with columns from the table", "content" : { "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/v1/tables/name/{name}/import" : { "put" : { "tags" : [ "Tables" ], "summary" : "Import columns from CSV to update table (no creation allowed)", "operationId" : "importTable", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the table", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry-run when true is used for validating the CSV without really importing it. (default=true)", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Import result", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/tables/name/{name}/importAsync" : { "put" : { "tags" : [ "Tables" ], "summary" : "Import columns from CSV to update table asynchronously (no creation allowed)", "operationId" : "importTableAsync", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the table", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry-run when true is used for validating the CSV without really importing it. (default=true)", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Import result", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/tables/restore" : { "put" : { "tags" : [ "Tables" ], "summary" : "Restore a soft deleted table", "description" : "Restore a soft deleted table.", "operationId" : "restore_10", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Table ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } } } } }, "/v1/tables/{fqn}/columnProfile" : { "get" : { "tags" : [ "Tables" ], "summary" : "List of column profiles", "description" : "Get a list of all the column profiles for the given table fqn, optionally filtered by `extension`, `startTs` and `endTs` of the profile. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.", "operationId" : "list column Profiles", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "FQN of the column", "required" : true, "schema" : { "type" : "string" } }, { "name" : "startTs", "in" : "query", "description" : "Filter table/column profiles after the given start timestamp", "required" : true, "schema" : { "type" : "number" } }, { "name" : "endTs", "in" : "query", "description" : "Filter table/column profiles before the given end timestamp", "required" : true, "schema" : { "type" : "number" } } ], "responses" : { "200" : { "description" : "List of table profiles", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ColumnProfileList" } } } } } } }, "/v1/tables/{fqn}/systemProfile" : { "get" : { "tags" : [ "Tables" ], "summary" : "List of system profiles", "description" : "Get a list of all the system profiles for the given table fqn, filtered by `extension`, `startTs` and `endTs` of the profile. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.", "operationId" : "list system Profiles", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "FQN of the table", "required" : true, "schema" : { "type" : "string" } }, { "name" : "startTs", "in" : "query", "description" : "Filter system profiles after the given start timestamp", "required" : true, "schema" : { "type" : "number" } }, { "name" : "endTs", "in" : "query", "description" : "Filter system profiles before the given end timestamp", "required" : true, "schema" : { "type" : "number" } } ], "responses" : { "200" : { "description" : "List of system profiles", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SystemProfileList" } } } } } } }, "/v1/tables/{fqn}/tableProfile" : { "get" : { "tags" : [ "Tables" ], "summary" : "List of table profiles", "description" : "Get a list of all the table profiles for the given table fqn, optionally filtered by `extension`, `startTs` and `endTs` of the profile. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.", "operationId" : "list Profiles", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "FQN of the table or column", "required" : true, "schema" : { "type" : "string" } }, { "name" : "startTs", "in" : "query", "description" : "Filter table/column profiles after the given start timestamp", "schema" : { "type" : "number" } }, { "name" : "endTs", "in" : "query", "description" : "Filter table/column profiles before the given end timestamp", "schema" : { "type" : "number" } } ], "responses" : { "200" : { "description" : "List of table profiles", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TableProfileList" } } } } } } }, "/v1/tables/{fqn}/tableProfile/latest" : { "get" : { "tags" : [ "Tables" ], "summary" : "Get the latest table profile", "description" : "Get the latest table and column profile ", "operationId" : "Get the latest table and column profile", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "FQN of the table or column", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Table with profile and column profile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } } } } }, "/v1/tables/{fqn}/{entityType}/{timestamp}/profile" : { "delete" : { "tags" : [ "Tables" ], "summary" : "Delete table profile data", "description" : "Delete table profile data to the table.", "operationId" : "deleteDataProfiler", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "FQN of the table or column", "required" : true, "schema" : { "type" : "string" } }, { "name" : "entityType", "in" : "path", "description" : "type of the entity table or column", "required" : true, "schema" : { "type" : "string" } }, { "name" : "timestamp", "in" : "path", "description" : "Timestamp of the table profile", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Successfully deleted the Table Profile", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TableProfile" } } } } } } }, "/v1/tables/{id}" : { "get" : { "tags" : [ "Tables" ], "summary" : "Get a table by Id", "description" : "Get a table by `Id`", "operationId" : "getTableByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "table Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "tableConstraints,tablePartition,usageSummary,owners,customMetrics,columns,tags,followers,joins,schemaDefinition,dataModel,extension,testSuite,domain,dataProducts,lifeCycle,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "table", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } }, "404" : { "description" : "Table for instance {id} is not found" } } }, "delete" : { "tags" : [ "Tables" ], "summary" : "Delete a table by Id", "description" : "Delete a table by `Id`.", "operationId" : "deleteTable", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Table for instance {id} is not found" } } }, "patch" : { "tags" : [ "Tables" ], "summary" : "Update a table", "description" : "Update an existing table using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchTable_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/tables/{id}/customMetric" : { "put" : { "tags" : [ "Tables" ], "summary" : "Add column custom metrics", "description" : "Add column custom metrics.", "operationId" : "addCustomMetric", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateCustomMetric" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } } } } }, "/v1/tables/{id}/customMetric/{columnName}/{customMetricName}" : { "delete" : { "tags" : [ "Tables" ], "summary" : "Delete custom metric from a column", "description" : "Delete a custom metric from a column.", "operationId" : "deleteCustomMetric", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "columnName", "in" : "path", "description" : "column of the table", "required" : true, "schema" : { "type" : "string" } }, { "name" : "customMetricName", "in" : "path", "description" : "column Test Type", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } } } } }, "/v1/tables/{id}/customMetric/{customMetricName}" : { "delete" : { "tags" : [ "Tables" ], "summary" : "Delete custom metric from a table", "description" : "Delete a custom metric from a table.", "operationId" : "deleteCustomMetric_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "customMetricName", "in" : "path", "description" : "column Test Type", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } } } } }, "/v1/tables/{id}/dataModel" : { "put" : { "tags" : [ "Tables" ], "summary" : "Add data modeling information to a table", "description" : "Add data modeling (such as DBT model) information on how the table was created to the table.", "operationId" : "addDataModel", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DataModel" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } } } } }, "/v1/tables/{id}/followers" : { "put" : { "tags" : [ "Tables" ], "summary" : "Add a follower", "description" : "Add a user identified by `userId` as followed of this table", "operationId" : "addFollowerToTable", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "Id of the user to be added as follower", "content" : { "application/json" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "Table for instance {id} is not found" } } } }, "/v1/tables/{id}/followers/{userId}" : { "delete" : { "tags" : [ "Tables" ], "summary" : "Remove a follower", "description" : "Remove the user identified `userId` as a follower of the table.", "operationId" : "deleteFollower_2", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed as follower", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } } } } }, "/v1/tables/{id}/joins" : { "put" : { "tags" : [ "Tables" ], "summary" : "Add table join information", "description" : "Add information about other tables that this table is joined with. Join information can only be added for the last 30 days starting today.", "operationId" : "addTableJoinInfo", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TableJoins" } } } }, "responses" : { "200" : { "description" : "Successfully updated the Table", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } }, "404" : { "description" : "Table for instance {id} is not found" }, "400" : { "description" : "Date range can only include past 30 days starting today" } } } }, "/v1/tables/{id}/sampleData" : { "get" : { "tags" : [ "Tables" ], "summary" : "Get sample data", "description" : "Get sample data from the table.", "operationId" : "getSampleData", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Successfully update the Table", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } } } }, "put" : { "tags" : [ "Tables" ], "summary" : "Add sample data", "description" : "Add sample data to the table.", "operationId" : "addSampleData", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TableData" } } } }, "responses" : { "200" : { "description" : "Successfully update the Table", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } } } }, "delete" : { "tags" : [ "Tables" ], "summary" : "Delete sample data", "description" : "Delete sample data from the table.", "operationId" : "deleteSampleData", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Successfully update the Table", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } } } } }, "/v1/tables/{id}/tableProfile" : { "put" : { "tags" : [ "Tables" ], "summary" : "Add table profile data", "description" : "Add table profile data to the table.", "operationId" : "addDataProfiler", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTableProfile" } } } }, "responses" : { "200" : { "description" : "Successfully updated the Table ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } } } } }, "/v1/tables/{id}/tableProfilerConfig" : { "get" : { "tags" : [ "Tables" ], "summary" : "Get table profile config", "description" : "Get table profile config to the table.", "operationId" : "getDataProfilerConfig_2", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Successfully updated the Table ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } } } }, "put" : { "tags" : [ "Tables" ], "summary" : "Add table profile config", "description" : "Add table profile config to the table.", "operationId" : "addDataProfilerConfig_2", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TableProfilerConfig" } } } }, "responses" : { "200" : { "description" : "Successfully updated the Table ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } } } }, "delete" : { "tags" : [ "Tables" ], "summary" : "Delete table profiler config", "description" : "delete table profile config to the table.", "operationId" : "delete DataProfilerConfig_2", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the table", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Successfully deleted the Table profiler config", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } } } } }, "/v1/tables/{id}/versions" : { "get" : { "tags" : [ "Tables" ], "summary" : "List table versions", "description" : "Get a list of all the versions of a table identified by `Id`", "operationId" : "listAllTableVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Table Id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List of table versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/tables/{id}/versions/{version}" : { "get" : { "tags" : [ "Tables" ], "summary" : "Get a version of the table", "description" : "Get a version of the table by given `Id`", "operationId" : "getSpecificDatabaseVersion_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Table Id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Table version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "table", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Table" } } } }, "404" : { "description" : "Table for instance {id} and version {version} is not found" } } } }, "/v1/tables/{id}/vote" : { "put" : { "tags" : [ "Tables" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_5", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/tags" : { "get" : { "tags" : [ "Classifications" ], "summary" : "List tags", "description" : "Get a list of tags. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listTags", "parameters" : [ { "name" : "parent", "in" : "query", "description" : "List tags filtered by children of tag identified by fqn given in `parent` parameter. The fqn can either be classificationName or fqn of a parent tag", "schema" : { "type" : "string", "example" : "children,usageCount" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "children,usageCount" } }, { "name" : "disabled", "in" : "query", "description" : "Filter Disabled Classifications", "schema" : { "type" : "string", "example" : "children,usageCount", "default" : "false" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number tags returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of tags before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of tags after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of tags", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TagList" } } } } } }, "put" : { "tags" : [ "Classifications" ], "summary" : "Create or update a tag", "description" : "Create a new tag, if it does not exist or update an existing tag.", "operationId" : "createOrUpdateTag", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTag" } } } }, "responses" : { "200" : { "description" : "The tag", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tag" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Classifications" ], "summary" : "Create a tag", "description" : "Create a new tag.", "operationId" : "createTag", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTag" } } } }, "responses" : { "200" : { "description" : "The tag", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tag" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/tags/name/{fqn}" : { "get" : { "tags" : [ "Classifications" ], "summary" : "Get a tag by fully qualified name", "description" : "Get a tag by `fullyQualifiedName`.", "operationId" : "getTagByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the tag", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "children,usageCount" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The tag", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tag" } } } }, "404" : { "description" : "Tag for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Classifications" ], "summary" : "Delete a tag by fully qualified name", "description" : "Delete a tag by `fullyQualifiedName`.", "operationId" : "deleteTagByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the tag", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "tag for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Classifications" ], "summary" : "Update a tag using name.", "description" : "Update an existing tag using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchTag", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the tag", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/tags/restore" : { "put" : { "tags" : [ "Classifications" ], "summary" : "Restore a soft deleted tag.", "description" : "Restore a soft deleted tag.", "operationId" : "restoreTag", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Tag ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tag" } } } } } } }, "/v1/tags/{id}" : { "get" : { "tags" : [ "Classifications" ], "summary" : "Get a tag by id", "description" : "Get a tag by `id`.", "operationId" : "getTagByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the tag", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "children,usageCount" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The tag", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tag" } } } }, "404" : { "description" : "Tag for instance {id} is not found" } } }, "delete" : { "tags" : [ "Classifications" ], "summary" : "Delete a tag by id", "description" : "Delete a tag by `id`.", "operationId" : "deleteTag", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this entity and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the tag", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "tag for instance {id} is not found" } } }, "patch" : { "tags" : [ "Classifications" ], "summary" : "Update a tag", "description" : "Update an existing tag using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchTag_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the tag", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/tags/{id}/assets/add" : { "put" : { "tags" : [ "Classifications" ], "summary" : "Bulk Add Classification Tag to Assets", "description" : "Bulk Add Classification Tag to Assets", "operationId" : "bulkAddTagToAssets", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddTagToAssetsRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkOperationResult" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/tags/{id}/assets/remove" : { "put" : { "tags" : [ "Classifications" ], "summary" : "Bulk Remove Tag from Assets", "description" : "Bulk Remove Tag from Assets", "operationId" : "bulkRemoveTagFromAssets", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddTagToAssetsRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/tags/{id}/versions" : { "get" : { "tags" : [ "Classifications" ], "summary" : "List tag versions", "description" : "Get a list of all the versions of a tag identified by `id`", "operationId" : "listAllTagVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the tag", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of tag versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/tags/{id}/versions/{version}" : { "get" : { "tags" : [ "Classifications" ], "summary" : "Get a version of the tags", "description" : "Get a version of the tag by given `id`", "operationId" : "getSpecificTagVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the tag", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "tag version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "tags", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tag" } } } }, "404" : { "description" : "Tag for instance {id} and version {version} is not found" } } } }, "/v1/teams" : { "get" : { "tags" : [ "Teams" ], "summary" : "List teams", "description" : "Get a list of teams. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listTeams", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,profile,users,owns,defaultRoles,parents,children,policies,userCount,childrenCount,domains" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number of teams returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of teams before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of teams after this cursor", "schema" : { "type" : "string" } }, { "name" : "parentTeam", "in" : "query", "description" : "Filter the results by parent team name", "schema" : { "type" : "string" } }, { "name" : "isJoinable", "in" : "query", "description" : "Filter the results by whether the team can be joined by any user or not", "schema" : { "type" : "boolean" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of teams", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TeamList" } } } } } }, "put" : { "tags" : [ "Teams" ], "summary" : "Update team", "description" : "Create or Update a team.", "operationId" : "createOrUpdateTeam", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTeam" } } } }, "responses" : { "200" : { "description" : "The team ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Team" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Teams" ], "summary" : "Create a team", "description" : "Create a new team.", "operationId" : "createTeam", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTeam" } } } }, "responses" : { "200" : { "description" : "The team", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Team" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/teams/documentation/csv" : { "get" : { "tags" : [ "Teams" ], "summary" : "Get CSV documentation for team import/export", "operationId" : "getCsvDocumentation_1", "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/v1/teams/hierarchy" : { "get" : { "tags" : [ "Teams" ], "summary" : "List teams with hierarchy", "description" : "Get a list of teams with hierarchy.", "operationId" : "listTeamsHierarchy", "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Limit the number of teams returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 1000, "type" : "integer", "format" : "int32", "default" : 10000 } }, { "name" : "isJoinable", "in" : "query", "description" : "Filter the results by whether the team can be joined by any user or not", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "List of teams with hierarchy", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TeamList" } } } } } } }, "/v1/teams/name/{fqn}" : { "patch" : { "tags" : [ "Teams" ], "summary" : "Update a team using name.", "description" : "Update an existing team with JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchTeam", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the team", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/teams/name/{name}" : { "get" : { "tags" : [ "Teams" ], "summary" : "Get a team by name", "description" : "Get a team by `name`.", "operationId" : "getTeamByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the team", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,profile,users,owns,defaultRoles,parents,children,policies,userCount,childrenCount,domains" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The team", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Team" } } } }, "404" : { "description" : "Team for instance {name} is not found" } } }, "delete" : { "tags" : [ "Teams" ], "summary" : "Delete a team by name", "description" : "Delete a team by given `name`.", "operationId" : "deleteTeamByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the team", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Team for instance {name} is not found" } } } }, "/v1/teams/name/{name}/export" : { "get" : { "tags" : [ "Teams" ], "summary" : "Export teams in CSV format", "operationId" : "exportTeams", "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with teams information", "content" : { "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/v1/teams/name/{name}/exportAsync" : { "get" : { "tags" : [ "Teams" ], "summary" : "Export teams in CSV format", "operationId" : "exportTeams_1", "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with teams information", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CSVExportResponse" } } } } } } }, "/v1/teams/name/{name}/import" : { "put" : { "tags" : [ "Teams" ], "summary" : "Import from CSV to create, and update teams.", "operationId" : "importTeams", "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry-run when true is used for validating the CSV without really importing it. (default=true)", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Import result", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/teams/name/{name}/importAsync" : { "put" : { "tags" : [ "Teams" ], "summary" : "Import from CSV to create, and update teams asynchronously.", "operationId" : "importTeamsAsync", "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry-run when true is used for validating the CSV without really importing it. (default=true)", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Import initiated successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/teams/restore" : { "put" : { "tags" : [ "Teams" ], "summary" : "Restore a soft deleted team", "description" : "Restore a soft deleted team.", "operationId" : "restore_36", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Team ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Team" } } } } } } }, "/v1/teams/{id}" : { "get" : { "tags" : [ "Teams" ], "summary" : "Get a team by id", "description" : "Get a team by `id`.", "operationId" : "getTeamByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the team", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,profile,users,owns,defaultRoles,parents,children,policies,userCount,childrenCount,domains" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The team", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Team" } } } }, "404" : { "description" : "Team for instance {id} is not found" } } }, "delete" : { "tags" : [ "Teams" ], "summary" : "Delete a team by id", "description" : "Delete a team by given `id`.", "operationId" : "deleteTeam", "parameters" : [ { "name" : "recursive", "in" : "query", "description" : "Recursively delete this team and it's children. (Default `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the team", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Team for instance {id} is not found" } } }, "patch" : { "tags" : [ "Teams" ], "summary" : "Update a team", "description" : "Update an existing team with JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchTeam_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the team", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/teams/{id}/versions" : { "get" : { "tags" : [ "Teams" ], "summary" : "List team versions", "description" : "Get a list of all the versions of a team identified by `id`", "operationId" : "listAllTeamVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the team", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of team versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/teams/{id}/versions/{version}" : { "get" : { "tags" : [ "Teams" ], "summary" : "Get a version of the team", "description" : "Get a version of the team by given `id`", "operationId" : "getSpecificTeamVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the team", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Team version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "team", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Team" } } } }, "404" : { "description" : "Team for instance {id} and version {version} is not found" } } } }, "/v1/teams/{name}/assets/add" : { "put" : { "tags" : [ "Teams" ], "summary" : "Bulk Add Assets", "description" : "Bulk Add Assets", "operationId" : "bulkAddAssets_2", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Team", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkAssets" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkOperationResult" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/teams/{name}/assets/remove" : { "put" : { "tags" : [ "Teams" ], "summary" : "Bulk Remove Assets", "description" : "Bulk Remove Assets", "operationId" : "bulkRemoveAssets_2", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the Team", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkAssets" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/teams/{teamId}/users" : { "put" : { "tags" : [ "Teams" ], "summary" : "Update team users", "description" : "Update the list of users for a team. Replaces existing users with the provided list.", "operationId" : "updateTeamUsers", "parameters" : [ { "name" : "teamId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } } } } }, "responses" : { "200" : { "description" : "Updated team users", "content" : { "application/json" : { } } }, "404" : { "description" : "Team not found" } } } }, "/v1/teams/{teamId}/users/{userId}" : { "delete" : { "tags" : [ "Teams" ], "summary" : "Remove a user from a team", "description" : "Remove the user identified by `userId` from the team identified by `teamId`.", "operationId" : "deleteTeamUser", "parameters" : [ { "name" : "teamId", "in" : "path", "description" : "Id of the team", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "User removed from team", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "Team or user not found" } } } }, "/v1/topics" : { "get" : { "tags" : [ "Topics" ], "summary" : "List topics", "description" : "Get a list of topics, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listTopics", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,tags,extension,domain,dataProducts,sourceHash" } }, { "name" : "service", "in" : "query", "description" : "Filter topics by service name", "schema" : { "type" : "string", "example" : "kafkaWestCoast" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number topics returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of topics before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of topics after this cursor", "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "List of topics", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TopicList" } } } } } }, "put" : { "tags" : [ "Topics" ], "summary" : "Update topic", "description" : "Create a topic, it it does not exist or update an existing topic.", "operationId" : "createOrUpdateTopic", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTopic" } } } }, "responses" : { "200" : { "description" : "The updated topic ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Topic" } } } } } }, "post" : { "tags" : [ "Topics" ], "summary" : "Create a topic", "description" : "Create a topic under an existing `service`.", "operationId" : "createTopic", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTopic" } } } }, "responses" : { "200" : { "description" : "The topic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Topic" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/topics/name/{fqn}" : { "get" : { "tags" : [ "Topics" ], "summary" : "Get a topic by fully qualified name", "description" : "Get a topic by fully qualified name.", "operationId" : "getTopicByFQN", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the topic", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,tags,extension,domain,dataProducts,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The topic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Topic" } } } }, "404" : { "description" : "Topic for instance {fqn} is not found" } } }, "delete" : { "tags" : [ "Topics" ], "summary" : "Delete a topic by fully qualified name", "description" : "Delete a topic by `fullyQualifiedName`.", "operationId" : "deleteTopicByFQN", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the topic", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Topic for instance {fqn} is not found" } } }, "patch" : { "tags" : [ "Topics" ], "summary" : "Update a topic using name.", "description" : "Update an existing topic using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchTopic", "parameters" : [ { "name" : "fqn", "in" : "path", "description" : "Name of the topic", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/topics/restore" : { "put" : { "tags" : [ "Topics" ], "summary" : "Restore a soft deleted topic", "description" : "Restore a soft deleted topic.", "operationId" : "restore_38", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the Topic. ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Topic" } } } } } } }, "/v1/topics/{id}" : { "get" : { "tags" : [ "Topics" ], "summary" : "Get a topic by id", "description" : "Get a topic by `id`.", "operationId" : "get_7", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the topic", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "owners,followers,tags,extension,domain,dataProducts,sourceHash" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The topic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Topic" } } } }, "404" : { "description" : "Topic for instance {id} is not found" } } }, "delete" : { "tags" : [ "Topics" ], "summary" : "Delete a topic by id", "description" : "Delete a topic by `id`.", "operationId" : "deleteTopic", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the topic", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "Topic for instance {id} is not found" } } }, "patch" : { "tags" : [ "Topics" ], "summary" : "Update a topic", "description" : "Update an existing topic using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchTopic_1", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the topic", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/topics/{id}/followers" : { "put" : { "tags" : [ "Topics" ], "summary" : "Add a follower", "description" : "Add a user identified by `userId` as followed of this topic", "operationId" : "addFollower_8", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the topic", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "Id of the user to be added as follower", "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "uuid" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "Topic for instance {id} is not found" } } } }, "/v1/topics/{id}/followers/{userId}" : { "delete" : { "tags" : [ "Topics" ], "summary" : "Remove a follower", "description" : "Remove the user identified `userId` as a follower of the topic.", "operationId" : "deleteFollower_9", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the topic", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "userId", "in" : "path", "description" : "Id of the user being removed as follower", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } } } } }, "/v1/topics/{id}/sampleData" : { "get" : { "tags" : [ "Topics" ], "summary" : "Get sample data", "description" : "Get sample data from the topic.", "operationId" : "getSampleData_2", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the topic", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Successfully obtained the Topic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Topic" } } } } } }, "put" : { "tags" : [ "Topics" ], "summary" : "Add sample data", "description" : "Add sample data to the topic.", "operationId" : "addSampleData_2", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the topic", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TopicSampleData" } } } }, "responses" : { "200" : { "description" : "The topic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Topic" } } } } } } }, "/v1/topics/{id}/versions" : { "get" : { "tags" : [ "Topics" ], "summary" : "List topic versions", "description" : "Get a list of all the versions of a topic identified by `id`", "operationId" : "listAllTopicVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the topic", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of topic versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/topics/{id}/versions/{version}" : { "get" : { "tags" : [ "Topics" ], "summary" : "Get a version of the topic", "description" : "Get a version of the topic by given `id`", "operationId" : "getSpecificTopicVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the topic", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "Topic version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "topic", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Topic" } } } }, "404" : { "description" : "Topic for instance {id} and version {version} is not found" } } } }, "/v1/topics/{id}/vote" : { "put" : { "tags" : [ "Topics" ], "summary" : "Update Vote for a Entity", "description" : "Update vote for a Entity", "operationId" : "updateVoteForEntity_15", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the Entity", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoteRequest" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "404" : { "description" : "model for instance {id} is not found" } } } }, "/v1/usage/{entity}/name/{fqn}" : { "get" : { "tags" : [ "Usage" ], "summary" : "Get usage by fully qualified name", "description" : "Get usage details for an entity identified by fully qualified name.", "operationId" : "getEntityUsageByFQN", "parameters" : [ { "name" : "entity", "in" : "path", "description" : "Entity type for which usage is requested", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the entity that uniquely identifies an entity", "required" : true, "schema" : { "type" : "string" } }, { "name" : "days", "in" : "query", "description" : "Usage for number of days going back from the given date (default=1, min=1, max=30)", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "date", "in" : "query", "description" : "Usage for number of days going back from this date in ISO 8601 format (default = currentDate)", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Entity usage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityUsage" } } } }, "404" : { "description" : "Entity for instance {fqn} is not found" } } }, "put" : { "tags" : [ "Usage" ], "summary" : "Report usage by fully qualified name", "description" : "Report usage information for an entity by name on a given date. System stores last 30 days of usage information. Usage information older than 30 days is deleted.", "operationId" : "reportEntityUsageWithFQN_1", "parameters" : [ { "name" : "entity", "in" : "path", "description" : "Entity type for which usage is reported", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the entity that uniquely identifies an entity", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "Usage information a given date", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DailyCount" } } } }, "responses" : { "200" : { "description" : "Usage information", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityUsage" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Usage" ], "summary" : "Report usage by fully qualified name", "description" : "Report usage information for an entity by name on a given date. System stores last 30 days of usage information. Usage information older than 30 days is deleted.", "operationId" : "reportEntityUsageWithFQN", "parameters" : [ { "name" : "entity", "in" : "path", "description" : "Entity type for which usage is reported", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "fqn", "in" : "path", "description" : "Fully qualified name of the entity that uniquely identifies an entity", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "Usage information a given date", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DailyCount" } } } }, "responses" : { "200" : { "description" : "Usage information", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityUsage" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/usage/{entity}/{id}" : { "get" : { "tags" : [ "Usage" ], "summary" : "Get usage by id", "description" : "Get usage details for an entity identified by `id`.", "operationId" : "getEntityUsageByID", "parameters" : [ { "name" : "entity", "in" : "path", "description" : "Entity type for which usage is requested", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "id", "in" : "path", "description" : "Entity id", "required" : true, "schema" : { "type" : "string" } }, { "name" : "days", "in" : "query", "description" : "Usage for number of days going back from the given date (default=1, min=1, max=30)", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "date", "in" : "query", "description" : "Usage for number of days going back from this date in ISO 8601 format. (default = currentDate)", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Entity usage", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityUsage" } } } }, "404" : { "description" : "Entity for instance {id} is not found" } } }, "put" : { "tags" : [ "Usage" ], "summary" : "Report usage", "description" : "Report usage information for an entity on a given date. System stores last 30 days of usage information. Usage information older than 30 days is deleted.", "operationId" : "reportEntityUsageWithID_1", "parameters" : [ { "name" : "entity", "in" : "path", "description" : "Entity type for which usage is reported", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "id", "in" : "path", "description" : "Entity id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "Usage information a given date", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DailyCount" } } } }, "responses" : { "200" : { "description" : "Usage information", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityUsage" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Usage" ], "summary" : "Report usage", "description" : "Report usage information for an entity on a given date. System stores last 30 days of usage information. Usage information older than 30 days is deleted.", "operationId" : "reportEntityUsageWithID", "parameters" : [ { "name" : "entity", "in" : "path", "description" : "Entity type for which usage is reported", "required" : true, "schema" : { "type" : "string", "example" : "table, report, metrics, or dashboard" } }, { "name" : "id", "in" : "path", "description" : "Entity id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "Usage information a given date", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DailyCount" } } } }, "responses" : { "200" : { "description" : "Usage information", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityUsage" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users" : { "get" : { "tags" : [ "Users" ], "summary" : "List users", "description" : "Get a list of users. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.", "operationId" : "listUsers", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "profile,roles,teams,follows,owns,domains,personas,defaultPersona" } }, { "name" : "team", "in" : "query", "description" : "Filter users by team", "schema" : { "type" : "string", "example" : "Legal" } }, { "name" : "limit", "in" : "query", "description" : "Limit the number users returned. (1 to 1000000, default = 10)", "schema" : { "maximum" : 1000000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 10 } }, { "name" : "before", "in" : "query", "description" : "Returns list of users before this cursor", "schema" : { "type" : "string" } }, { "name" : "after", "in" : "query", "description" : "Returns list of users after this cursor", "schema" : { "type" : "string" } }, { "name" : "isAdmin", "in" : "query", "description" : "Returns list of admin users if set to true", "schema" : { "type" : "boolean" } }, { "name" : "isBot", "in" : "query", "description" : "Returns list of bot users if set to true", "schema" : { "type" : "boolean" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserList" } } } } } }, "put" : { "tags" : [ "Users" ], "summary" : "Update user", "description" : "Create or Update a user.", "operationId" : "createOrUpdateUser", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateUser" } } } }, "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateUser" } } } }, "400" : { "description" : "Bad request" } } }, "post" : { "tags" : [ "Users" ], "summary" : "Create a user", "description" : "Create a new user.", "operationId" : "createUser", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateUser" } } } }, "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users/auth-mechanism/{id}" : { "get" : { "tags" : [ "Users" ], "summary" : "Get Authentication Mechanism for a Bot User", "description" : "Get Authentication Mechanism for a Bot User.", "operationId" : "getAuthenticationMechanismBotUser", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the user", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthenticationMechanism" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users/changePassword" : { "put" : { "tags" : [ "Users" ], "summary" : "Change Password For User", "description" : "Create a new user.", "operationId" : "changeUserPassword", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangePasswordRequest" } } } }, "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users/checkEmailInUse" : { "post" : { "tags" : [ "Users" ], "summary" : "Check if a email is already in use", "description" : "Check if a email is already in use", "operationId" : "checkEmailInUse", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailRequest" } } } }, "responses" : { "200" : { "description" : "Return true or false", "content" : { "application/json" : { "schema" : { "type" : "boolean" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users/checkEmailVerified" : { "post" : { "tags" : [ "Users" ], "summary" : "Check if a mail is verified", "description" : "Check if a mail is already in use", "operationId" : "checkEmailIsVerified", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailRequest" } } } }, "responses" : { "200" : { "description" : "Return true or false", "content" : { "application/json" : { "schema" : { "type" : "boolean" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users/documentation/csv" : { "get" : { "tags" : [ "Users" ], "summary" : "Get CSV documentation for user import/export", "operationId" : "getCsvDocumentation_2", "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/v1/users/export" : { "get" : { "tags" : [ "Users" ], "summary" : "Export users in a team in CSV format", "operationId" : "exportUsers", "parameters" : [ { "name" : "team", "in" : "query", "description" : "Name of the team to under which the users are imported to", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with user information", "content" : { "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/v1/users/exportAsync" : { "get" : { "tags" : [ "Users" ], "summary" : "Export users in a team in CSV format", "operationId" : "exportUsers_1", "parameters" : [ { "name" : "team", "in" : "query", "description" : "Name of the team to under which the users are imported to", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Exported csv with user information", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CSVExportResponse" } } } } } } }, "/v1/users/generatePasswordResetLink" : { "post" : { "tags" : [ "Users" ], "summary" : "Generate Password Reset Link", "description" : "Generate Password Reset Link", "operationId" : "generatePasswordResetLink", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailRequest" } } } }, "responses" : { "200" : { "description" : "The user " }, "400" : { "description" : "Bad request" } } } }, "/v1/users/generateRandomPwd" : { "get" : { "tags" : [ "Users" ], "summary" : "Generate a random password", "description" : "Generate a random password", "operationId" : "generateRandomPwd", "responses" : { "200" : { "description" : "Random pwd" } } } }, "/v1/users/generateToken/{id}" : { "put" : { "tags" : [ "Users" ], "summary" : "Generate JWT Token for a Bot User", "description" : "Generate JWT Token for a Bot User.", "operationId" : "generateJWTTokenForBotUser", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the user", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GenerateTokenRequest" } } } }, "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "type" : "string", "enum" : [ "OneHour", "1", "7", "30", "60", "90", "Unlimited" ] } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users/import" : { "put" : { "tags" : [ "Users" ], "summary" : "Import from CSV to create, and update teams.", "operationId" : "importTeams_1", "parameters" : [ { "name" : "team", "in" : "query", "description" : "Name of the team to under which the users are imported to", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry-run when true is used for validating the CSV without really importing it. (default=true)", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Import result", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/users/importAsync" : { "put" : { "tags" : [ "Users" ], "summary" : "Import from CSV to create, and update teams asynchronously.", "operationId" : "importTeamsAsync_1", "parameters" : [ { "name" : "team", "in" : "query", "description" : "Name of the team to under which the users are imported to", "required" : true, "schema" : { "type" : "string" } }, { "name" : "dryRun", "in" : "query", "description" : "Dry-run when true is used for validating the CSV without really importing it. (default=true)", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "description" : "Import result", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CsvImportResult" } } } } } } }, "/v1/users/loggedInUser" : { "get" : { "tags" : [ "Users" ], "summary" : "Get current logged in user", "description" : "Get the user who is authenticated and is currently logged in.", "operationId" : "getCurrentLoggedInUser", "parameters" : [ { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "profile,roles,teams,follows,owns,domains,personas,defaultPersona" } } ], "responses" : { "200" : { "description" : "The user", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } } }, "404" : { "description" : "User not found" } } } }, "/v1/users/loggedInUser/groupTeams" : { "get" : { "tags" : [ "Users" ], "summary" : "Get group type of teams for current logged in user", "description" : "Get the group type of teams of user who is authenticated and is currently logged in.", "operationId" : "getCurrentLoggedInUserGroupTeams", "responses" : { "200" : { "description" : "The teams of type 'Group' that a user belongs to", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } } } } }, "404" : { "description" : "User not found" } } } }, "/v1/users/login" : { "post" : { "tags" : [ "Users" ], "summary" : "Login User with email (plain-text) and Password (encoded in base 64)", "description" : "Login User with email(plain-text) and Password (encoded in base 64)", "operationId" : "loginUserWithPwd", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LoginRequest" } } } }, "responses" : { "200" : { "description" : "Returns the Jwt Token Response ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/JwtResponse" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users/logout" : { "post" : { "tags" : [ "Users" ], "summary" : "Logout a User(Only called for saml and basic Auth)", "description" : "Logout a User(Only called for saml and basic Auth)", "operationId" : "logoutUser", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LogoutRequest" } } } }, "responses" : { "200" : { "description" : "The user " }, "400" : { "description" : "Bad request" } } } }, "/v1/users/name/{name}" : { "get" : { "tags" : [ "Users" ], "summary" : "Get a user by name", "description" : "Get a user by `name`.", "operationId" : "getUserByFQN", "parameters" : [ { "name" : "name", "in" : "path", "description" : "Name of the user", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "profile,roles,teams,follows,owns,domains,personas,defaultPersona" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The user", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } } }, "404" : { "description" : "User for instance {name} is not found" } } }, "delete" : { "tags" : [ "Users" ], "summary" : "Delete a user", "description" : "Users can't be deleted but are soft-deleted.", "operationId" : "deleteUserByName", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "name", "in" : "path", "description" : "Name of the user", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "User for instance {name} is not found" } } } }, "/v1/users/password/reset" : { "post" : { "tags" : [ "Users" ], "summary" : "Reset Password For User", "description" : "Reset User Password", "operationId" : "resetUserPassword", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PasswordResetRequest" } } } }, "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users/refresh" : { "post" : { "tags" : [ "Users" ], "summary" : "Provide access token to User with refresh token", "description" : "Provide access token to User with refresh token", "operationId" : "refreshToken", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TokenRefreshRequest" } } } }, "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/JwtResponse" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users/registrationConfirmation" : { "put" : { "tags" : [ "Users" ], "summary" : "Confirm User Email", "description" : "Confirm User Email", "operationId" : "confirmUserEmail", "parameters" : [ { "name" : "token", "in" : "query", "description" : "Token sent for Email Confirmation", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The user " }, "400" : { "description" : "Bad request" } } } }, "/v1/users/resendRegistrationToken" : { "put" : { "tags" : [ "Users" ], "summary" : "Resend Registration Token", "description" : "Resend Registration Token", "operationId" : "resendRegistrationToken", "parameters" : [ { "name" : "user", "in" : "query", "description" : "Token sent for Email Confirmation Earlier", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The user " }, "400" : { "description" : "Bad request" } } } }, "/v1/users/restore" : { "put" : { "tags" : [ "Users" ], "summary" : "Restore a soft deleted User.", "description" : "Restore a soft deleted User.", "operationId" : "restore_37", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreEntity" } } } }, "responses" : { "200" : { "description" : "Successfully restored the User ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } } } } } }, "/v1/users/revokeToken" : { "put" : { "tags" : [ "Users" ], "summary" : "Revoke JWT Token for a Bot User", "description" : "Revoke JWT Token for a Bot User.", "operationId" : "revokeJWTTokenForBotUser", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RevokeTokenRequest" } } } }, "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/JWTAuthMechanism" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users/security/token" : { "get" : { "tags" : [ "Users" ], "summary" : "Get personal access token to User", "description" : "Get a personal access token", "operationId" : "getPersonalAccessToken", "parameters" : [ { "name" : "username", "in" : "query", "description" : "User Name of the User for which to get. (Default = `false`)", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "List Of Personal Access Tokens ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PersonalAccessTokenList" } } } }, "400" : { "description" : "Bad request" } } }, "put" : { "tags" : [ "Users" ], "summary" : "Provide access token to User", "description" : "Provide access token to User", "operationId" : "createPersonalAccessToken", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreatePersonalToken" } } } }, "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PersonalAccessToken" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users/security/token/revoke" : { "put" : { "tags" : [ "Users" ], "summary" : "Revoke personal access token to User", "description" : "Revoke personal access token", "operationId" : "revokePersonalAccessToken", "parameters" : [ { "name" : "username", "in" : "query", "description" : "Username in case admin is revoking. (Default = `false`)", "schema" : { "type" : "string" } }, { "name" : "removeAll", "in" : "query", "description" : "Remove All tokens of the user. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RevokePersonalTokenRequest" } } } }, "responses" : { "200" : { "description" : "The Personal access token ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PersonalAccessTokenList" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users/signup" : { "post" : { "tags" : [ "Users" ], "summary" : "Register User", "description" : "Register a new User", "operationId" : "registerUser", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RegistrationRequest" } } } }, "responses" : { "200" : { "description" : "The user " }, "400" : { "description" : "Bad request" } } } }, "/v1/users/token/{id}" : { "get" : { "tags" : [ "Users" ], "summary" : "Get JWT Token for a Bot User", "description" : "Get JWT Token for a Bot User.", "operationId" : "getJWTTokenForBotUser", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the user", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "The user ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/JWTAuthMechanism" } } } }, "400" : { "description" : "Bad request" } } } }, "/v1/users/{id}" : { "get" : { "tags" : [ "Users" ], "summary" : "Get a user", "description" : "Get a user by `id`", "operationId" : "getUserByID", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the user", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "fields", "in" : "query", "description" : "Fields requested in the returned resource", "schema" : { "type" : "string", "example" : "profile,roles,teams,follows,owns,domains,personas,defaultPersona" } }, { "name" : "include", "in" : "query", "description" : "Include all, deleted, or non-deleted entities.", "schema" : { "type" : "string", "default" : "non-deleted", "enum" : [ "all", "deleted", "non-deleted" ] } } ], "responses" : { "200" : { "description" : "The user", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } } }, "404" : { "description" : "User for instance {id} is not found" } } }, "delete" : { "tags" : [ "Users" ], "summary" : "Delete a user", "description" : "Users can't be deleted but are soft-deleted.", "operationId" : "deleteUser", "parameters" : [ { "name" : "hardDelete", "in" : "query", "description" : "Hard delete the entity. (Default = `false`)", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "id", "in" : "path", "description" : "Id of the user", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "OK" }, "404" : { "description" : "User for instance {id} is not found" } } }, "patch" : { "tags" : [ "Users" ], "summary" : "Update a user", "description" : "Update an existing user using JsonPatch.", "externalDocs" : { "description" : "JsonPatch RFC", "url" : "https://tools.ietf.org/html/rfc6902" }, "operationId" : "patchUser", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the user", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "description" : "JsonPatch with array of operations", "content" : { "application/json-patch+json" : { "schema" : { "type" : "object" }, "example" : "[{op:remove, path:/a},{op:add, path: /b, value: val}]" } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/users/{id}/versions" : { "get" : { "tags" : [ "Users" ], "summary" : "List user versions", "description" : "Get a list of all the versions of a user identified by `id`", "operationId" : "listAllUserVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the user", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "List of user versions", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityHistory" } } } } } } }, "/v1/users/{id}/versions/{version}" : { "get" : { "tags" : [ "Users" ], "summary" : "Get a version of the user", "description" : "Get a version of the user by given `id`", "operationId" : "getSpecificUserVersion", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of the user", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "version", "in" : "path", "description" : "User version number in the form `major`.`minor`", "required" : true, "schema" : { "type" : "string", "example" : "0.1 or 1.1" } } ], "responses" : { "200" : { "description" : "user", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } } }, "404" : { "description" : "User for instance {id} and version {version} is not found" } } } } }, "components" : { "schemas" : { "APICollection" : { "required" : [ "endpointURL", "id", "name", "service" ], "type" : "object", "properties" : { "apiEndpoints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "endpointURL" : { "type" : "string", "format" : "uri" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "Rest", "WEBHOOK" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "APICollectionList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/APICollection" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "APIEndpoint" : { "required" : [ "endpointURL", "id", "name", "service" ], "type" : "object", "properties" : { "apiCollection" : { "$ref" : "#/components/schemas/EntityReference" }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "endpointURL" : { "type" : "string", "format" : "uri" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "requestMethod" : { "type" : "string", "enum" : [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "requestSchema" : { "$ref" : "#/components/schemas/APISchema" }, "responseSchema" : { "$ref" : "#/components/schemas/APISchema" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "Rest", "WEBHOOK" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "APIEndpointList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/APIEndpoint" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "APISchema" : { "type" : "object", "properties" : { "schemaFields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Field" } }, "schemaType" : { "type" : "string", "enum" : [ "Avro", "Protobuf", "JSON", "Other", "None" ] } } }, "APIServiceList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "AccessDetails" : { "required" : [ "timestamp" ], "type" : "object", "properties" : { "accessedBy" : { "$ref" : "#/components/schemas/EntityReference" }, "accessedByAProcess" : { "type" : "string" }, "timestamp" : { "type" : "integer", "format" : "int64" } } }, "AddGlossaryToAssetsRequest" : { "type" : "object", "properties" : { "assets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dryRun" : { "type" : "boolean" }, "glossaryTags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "operation" : { "type" : "string", "enum" : [ "AddAssets", "AddGlossaryTags" ] } } }, "AddLineage" : { "required" : [ "edge" ], "type" : "object", "properties" : { "edge" : { "$ref" : "#/components/schemas/EntitiesEdge" } } }, "AddTagToAssetsRequest" : { "type" : "object", "properties" : { "assets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dryRun" : { "type" : "boolean" }, "operation" : { "type" : "string", "enum" : [ "AddAssets", "AddClassificationTags" ] } } }, "Aggregation" : { "type" : "object", "properties" : { "fragment" : { "type" : "boolean" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "name" : { "type" : "string" }, "type" : { "type" : "string" } } }, "AggregationProfileShardResult" : { "type" : "object", "properties" : { "fragment" : { "type" : "boolean" }, "profileResults" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProfileResult" } } } }, "Aggregations" : { "type" : "object", "properties" : { "asMap" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Aggregation" } }, "fragment" : { "type" : "boolean" } } }, "AirflowConfig" : { "type" : "object", "properties" : { "concurrency" : { "type" : "integer", "format" : "int32" }, "email" : { "maxLength" : 127, "minLength" : 6, "pattern" : "^[\\S.!#$%&’*+/=?^_`{|}~-]+@\\S+\\.\\S+$", "type" : "string" }, "endDate" : { "type" : "string", "format" : "date-time" }, "maxActiveRuns" : { "type" : "integer", "format" : "int32" }, "pausePipeline" : { "type" : "boolean" }, "pipelineCatchup" : { "type" : "boolean" }, "pipelineTimezone" : { "type" : "string" }, "retries" : { "type" : "integer", "format" : "int32" }, "retryDelay" : { "type" : "integer", "format" : "int32" }, "scheduleInterval" : { "type" : "string" }, "startDate" : { "type" : "string", "format" : "date-time" }, "workflowDefaultView" : { "type" : "string" }, "workflowDefaultViewOrientation" : { "type" : "string" }, "workflowTimeout" : { "type" : "integer", "format" : "int32" } } }, "AlertFilteringInput" : { "type" : "object", "properties" : { "actions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ArgumentsInput" } }, "filters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ArgumentsInput" } } } }, "AnnouncementDetails" : { "required" : [ "endTime", "startTime" ], "type" : "object", "properties" : { "description" : { "type" : "string" }, "endTime" : { "type" : "integer", "format" : "int64" }, "startTime" : { "type" : "integer", "format" : "int64" } } }, "ApiConnection" : { "type" : "object", "properties" : { "config" : { "type" : "object" } } }, "ApiService" : { "required" : [ "id", "name", "serviceType" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "connection" : { "$ref" : "#/components/schemas/ApiConnection" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelines" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "Rest", "WEBHOOK" ] }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testConnectionResult" : { "$ref" : "#/components/schemas/TestConnectionResult" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "App" : { "required" : [ "appSchedule", "appType", "className", "id", "name", "permission", "runtime", "scheduleType" ], "type" : "object", "properties" : { "allowConfiguration" : { "type" : "boolean" }, "appConfiguration" : { "type" : "object" }, "appLogoUrl" : { "type" : "string", "format" : "uri" }, "appSchedule" : { "$ref" : "#/components/schemas/AppSchedule" }, "appScreenshots" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "appType" : { "type" : "string", "enum" : [ "internal", "external" ] }, "bot" : { "$ref" : "#/components/schemas/EntityReference" }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "className" : { "type" : "string" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "developer" : { "type" : "string" }, "developerUrl" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "features" : { "type" : "string" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "openMetadataServerConnection" : { "$ref" : "#/components/schemas/OpenMetadataConnection" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "permission" : { "type" : "string", "enum" : [ "All" ] }, "pipelines" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "preview" : { "type" : "boolean" }, "privacyPolicyUrl" : { "type" : "string" }, "privateConfiguration" : { "type" : "object" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "runtime" : { "type" : "object" }, "scheduleType" : { "type" : "string", "enum" : [ "Live", "Scheduled", "ScheduledOrManual", "NoSchedule" ] }, "sourcePythonClass" : { "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "supportEmail" : { "type" : "string" }, "supportsInterrupt" : { "type" : "boolean" }, "system" : { "type" : "boolean" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "AppExtension" : { "required" : [ "appId", "appName", "extension" ], "type" : "object", "properties" : { "appId" : { "type" : "string", "format" : "uuid" }, "appName" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "extension" : { "type" : "string", "enum" : [ "status", "limits", "custom" ] }, "timestamp" : { "type" : "integer", "format" : "int64" } } }, "AppList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/App" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "AppMarketPlaceDefinition" : { "required" : [ "appType", "className", "id", "name", "permission", "scheduleType" ], "type" : "object", "properties" : { "allowConfiguration" : { "type" : "boolean" }, "appConfiguration" : { "type" : "object" }, "appLogoUrl" : { "type" : "string", "format" : "uri" }, "appScreenshots" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "appType" : { "type" : "string", "enum" : [ "internal", "external" ] }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "className" : { "type" : "string" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "developer" : { "type" : "string" }, "developerUrl" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "features" : { "type" : "string" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "permission" : { "type" : "string", "enum" : [ "All" ] }, "preview" : { "type" : "boolean" }, "privacyPolicyUrl" : { "type" : "string" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "runtime" : { "type" : "object" }, "scheduleType" : { "type" : "string", "enum" : [ "Live", "Scheduled", "ScheduledOrManual", "NoSchedule" ] }, "sourcePythonClass" : { "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "supportEmail" : { "type" : "string" }, "supportsInterrupt" : { "type" : "boolean" }, "system" : { "type" : "boolean" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "AppMarketPlaceDefinitionList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AppMarketPlaceDefinition" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "AppRunList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AppRunRecord" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "AppRunRecord" : { "type" : "object", "properties" : { "appId" : { "type" : "string", "format" : "uuid" }, "appName" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "config" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "endTime" : { "type" : "integer", "format" : "int64" }, "executionTime" : { "type" : "integer", "format" : "int64" }, "extension" : { "type" : "string" }, "failureContext" : { "$ref" : "#/components/schemas/FailureContext" }, "runType" : { "type" : "string" }, "scheduleInfo" : { "$ref" : "#/components/schemas/AppSchedule" }, "startTime" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "string", "enum" : [ "started", "running", "completed", "failed", "active", "activeError", "stopped", "success", "pending" ] }, "successContext" : { "$ref" : "#/components/schemas/SuccessContext" }, "timestamp" : { "type" : "integer", "format" : "int64" } } }, "AppSchedule" : { "required" : [ "scheduleTimeline" ], "type" : "object", "properties" : { "cronExpression" : { "type" : "string" }, "scheduleTimeline" : { "type" : "string", "enum" : [ "Hourly", " Daily", "Weekly", "Monthly", "Custom", "None" ] } } }, "Argument" : { "type" : "object", "properties" : { "input" : { "type" : "array", "items" : { "type" : "string" } }, "name" : { "type" : "string" } } }, "ArgumentsInput" : { "type" : "object", "properties" : { "arguments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Argument" } }, "effect" : { "type" : "string", "enum" : [ "include", "exclude" ] }, "name" : { "type" : "string" }, "prefixCondition" : { "type" : "string", "enum" : [ "AND", "OR" ] } } }, "AssetCertification" : { "required" : [ "appliedDate", "expiryDate", "tagLabel" ], "type" : "object", "properties" : { "appliedDate" : { "type" : "integer", "format" : "int64" }, "expiryDate" : { "type" : "integer", "format" : "int64" }, "tagLabel" : { "$ref" : "#/components/schemas/TagLabel" } } }, "AuthenticationMechanism" : { "type" : "object", "properties" : { "authType" : { "type" : "string", "enum" : [ "JWT", "SSO", "BASIC" ] }, "config" : { "type" : "object" } } }, "Bot" : { "required" : [ "botUser", "id", "name" ], "type" : "object", "properties" : { "botUser" : { "$ref" : "#/components/schemas/EntityReference" }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "BotList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Bot" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "BulkAssets" : { "type" : "object", "properties" : { "assets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } } } }, "BulkOperationResult" : { "type" : "object", "properties" : { "abortReason" : { "type" : "string" }, "dryRun" : { "type" : "boolean" }, "failedRequest" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BulkResponse" } }, "numberOfRowsFailed" : { "type" : "integer", "format" : "int32" }, "numberOfRowsPassed" : { "type" : "integer", "format" : "int32" }, "numberOfRowsProcessed" : { "type" : "integer", "format" : "int32" }, "status" : { "type" : "string", "enum" : [ "success", "failure", "aborted", "partialSuccess" ] }, "successRequest" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BulkResponse" } } } }, "BulkResponse" : { "type" : "object", "properties" : { "message" : { "type" : "string" }, "request" : { "type" : "object" } } }, "BytesReference" : { "type" : "object", "properties" : { "fragment" : { "type" : "boolean" } } }, "CSVExportMessage" : { "type" : "object", "properties" : { "data" : { "type" : "string" }, "error" : { "type" : "string" }, "jobId" : { "type" : "string" }, "status" : { "type" : "string" } } }, "CSVExportResponse" : { "type" : "object", "properties" : { "jobId" : { "type" : "string" }, "message" : { "type" : "string" } } }, "ChangeDescription" : { "type" : "object", "properties" : { "fieldsAdded" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FieldChange" } }, "fieldsDeleted" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FieldChange" } }, "fieldsUpdated" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FieldChange" } }, "previousVersion" : { "type" : "number", "format" : "double" } } }, "ChangeEvent" : { "required" : [ "entityId", "entityType", "eventType", "id", "timestamp" ], "type" : "object", "properties" : { "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "currentVersion" : { "type" : "number", "format" : "double" }, "domain" : { "type" : "string", "format" : "uuid" }, "entity" : { "type" : "object" }, "entityFullyQualifiedName" : { "type" : "string" }, "entityId" : { "type" : "string", "format" : "uuid" }, "entityType" : { "type" : "string" }, "eventType" : { "type" : "string", "enum" : [ "entityCreated", "entityUpdated", "entityFieldsChanged", "entityNoChange", "entitySoftDeleted", "entityDeleted", "entityRestored", "threadCreated", "threadUpdated", "postCreated", "postUpdated", "taskResolved", "taskClosed", "logicalTestCaseAdded", "suggestionCreated", "suggestionUpdated", "suggestionAccepted", "suggestionRejected", "suggestionDeleted" ] }, "id" : { "type" : "string", "format" : "uuid" }, "previousVersion" : { "type" : "number", "format" : "double" }, "timestamp" : { "type" : "integer", "format" : "int64" }, "userName" : { "type" : "string" } } }, "ChangePasswordRequest" : { "required" : [ "confirmPassword", "newPassword" ], "type" : "object", "properties" : { "confirmPassword" : { "type" : "string" }, "newPassword" : { "type" : "string" }, "oldPassword" : { "type" : "string" }, "requestType" : { "type" : "string", "enum" : [ "SELF", "USER" ] }, "username" : { "type" : "string" } } }, "Chart" : { "required" : [ "id", "name", "service" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "chartType" : { "type" : "string", "enum" : [ "Line", "Table", "Bar", "Area", "Pie", "Histogram", "Scatter", "Text", "BoxPlot", "Other" ] }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dashboards" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "Superset", "Looker", "Tableau", "Redash", "Metabase", "PowerBI", "PowerBIReportServer", "Mode", "CustomDashboard", "DomoDashboard", "QuickSight", "QlikSense", "Lightdash", "MicroStrategy", "QlikCloud", "Sigma" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "usageSummary" : { "$ref" : "#/components/schemas/UsageDetails" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "ChartList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Chart" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ChatbotDetails" : { "type" : "object", "properties" : { "query" : { "type" : "string" } } }, "Classification" : { "required" : [ "description", "name" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "disabled" : { "type" : "boolean" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "mutuallyExclusive" : { "type" : "boolean" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "termCount" : { "type" : "integer", "format" : "int32" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "usageCount" : { "type" : "integer", "format" : "int32" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "ClassificationList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Classification" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "CloseTask" : { "required" : [ "comment" ], "type" : "object", "properties" : { "comment" : { "type" : "string" }, "testCaseFQN" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" } } }, "Clusters" : { "type" : "object", "properties" : { "fragment" : { "type" : "boolean" }, "skipped" : { "type" : "integer", "format" : "int32" }, "successful" : { "type" : "integer", "format" : "int32" }, "total" : { "type" : "integer", "format" : "int32" } } }, "CollectorResult" : { "type" : "object", "properties" : { "fragment" : { "type" : "boolean" }, "name" : { "type" : "string" }, "profiledChildren" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CollectorResult" } }, "reason" : { "type" : "string" }, "time" : { "type" : "integer", "format" : "int64" } } }, "Column" : { "required" : [ "dataType", "name" ], "type" : "object", "properties" : { "arrayDataType" : { "type" : "string", "enum" : [ "NUMBER", "TINYINT", "SMALLINT", "INT", "BIGINT", "BYTEINT", "BYTES", "FLOAT", "DOUBLE", "DECIMAL", "NUMERIC", "TIMESTAMP", "TIMESTAMPZ", "TIME", "DATE", "DATETIME", "INTERVAL", "STRING", "MEDIUMTEXT", "TEXT", "CHAR", "LONG", "VARCHAR", "BOOLEAN", "BINARY", "VARBINARY", "ARRAY", "BLOB", "LONGBLOB", "MEDIUMBLOB", "MAP", "STRUCT", "UNION", "SET", "GEOGRAPHY", "ENUM", "JSON", "UUID", "VARIANT", "GEOMETRY", "BYTEA", "AGGREGATEFUNCTION", "ERROR", "FIXED", "RECORD", "NULL", "SUPER", "HLLSKETCH", "PG_LSN", "PG_SNAPSHOT", "TSQUERY", "TXID_SNAPSHOT", "XML", "MACADDR", "TSVECTOR", "UNKNOWN", "CIDR", "INET", "CLOB", "ROWID", "LOWCARDINALITY", "YEAR", "POINT", "POLYGON", "TUPLE", "SPATIAL", "TABLE", "NTEXT", "IMAGE", "IPV4", "IPV6", "DATETIMERANGE", "HLL", "LARGEINT", "QUANTILE_STATE", "AGG_STATE", "BITMAP", "UINT", "BIT", "MONEY" ] }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Column" } }, "constraint" : { "type" : "string", "enum" : [ "NULL", "NOT_NULL", "UNIQUE", "PRIMARY_KEY" ] }, "customMetrics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CustomMetric" } }, "dataLength" : { "type" : "integer", "format" : "int32" }, "dataType" : { "type" : "string", "enum" : [ "NUMBER", "TINYINT", "SMALLINT", "INT", "BIGINT", "BYTEINT", "BYTES", "FLOAT", "DOUBLE", "DECIMAL", "NUMERIC", "TIMESTAMP", "TIMESTAMPZ", "TIME", "DATE", "DATETIME", "INTERVAL", "STRING", "MEDIUMTEXT", "TEXT", "CHAR", "LONG", "VARCHAR", "BOOLEAN", "BINARY", "VARBINARY", "ARRAY", "BLOB", "LONGBLOB", "MEDIUMBLOB", "MAP", "STRUCT", "UNION", "SET", "GEOGRAPHY", "ENUM", "JSON", "UUID", "VARIANT", "GEOMETRY", "BYTEA", "AGGREGATEFUNCTION", "ERROR", "FIXED", "RECORD", "NULL", "SUPER", "HLLSKETCH", "PG_LSN", "PG_SNAPSHOT", "TSQUERY", "TXID_SNAPSHOT", "XML", "MACADDR", "TSVECTOR", "UNKNOWN", "CIDR", "INET", "CLOB", "ROWID", "LOWCARDINALITY", "YEAR", "POINT", "POLYGON", "TUPLE", "SPATIAL", "TABLE", "NTEXT", "IMAGE", "IPV4", "IPV6", "DATETIMERANGE", "HLL", "LARGEINT", "QUANTILE_STATE", "AGG_STATE", "BITMAP", "UINT", "BIT", "MONEY" ] }, "dataTypeDisplay" : { "type" : "string" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "jsonSchema" : { "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "ordinalPosition" : { "type" : "integer", "format" : "int32" }, "precision" : { "type" : "integer", "format" : "int32" }, "profile" : { "$ref" : "#/components/schemas/ColumnProfile" }, "scale" : { "type" : "integer", "format" : "int32" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "ColumnJoin" : { "type" : "object", "properties" : { "columnName" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "joinedWith" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JoinedWith" } } } }, "ColumnLineage" : { "type" : "object", "properties" : { "fromColumns" : { "type" : "array", "items" : { "type" : "string" } }, "function" : { "type" : "string" }, "toColumn" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" } } }, "ColumnProfile" : { "required" : [ "name", "timestamp" ], "type" : "object", "properties" : { "customMetrics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CustomMetricProfile" } }, "distinctCount" : { "type" : "number", "format" : "double" }, "distinctProportion" : { "type" : "number", "format" : "double" }, "duplicateCount" : { "type" : "number", "format" : "double" }, "firstQuartile" : { "type" : "number", "format" : "double" }, "histogram" : { "$ref" : "#/components/schemas/Histogram" }, "interQuartileRange" : { "type" : "number", "format" : "double" }, "max" : { "type" : "object" }, "maxLength" : { "type" : "number", "format" : "double" }, "mean" : { "type" : "number", "format" : "double" }, "median" : { "type" : "number", "format" : "double" }, "min" : { "type" : "object" }, "minLength" : { "type" : "number", "format" : "double" }, "missingCount" : { "type" : "number", "format" : "double" }, "missingPercentage" : { "type" : "number", "format" : "double" }, "name" : { "type" : "string" }, "nonParametricSkew" : { "type" : "number", "format" : "double" }, "nullCount" : { "type" : "number", "format" : "double" }, "nullProportion" : { "type" : "number", "format" : "double" }, "stddev" : { "type" : "number", "format" : "double" }, "sum" : { "type" : "number", "format" : "double" }, "thirdQuartile" : { "type" : "number", "format" : "double" }, "timestamp" : { "type" : "integer", "format" : "int64" }, "uniqueCount" : { "type" : "number", "format" : "double" }, "uniqueProportion" : { "type" : "number", "format" : "double" }, "validCount" : { "type" : "number", "format" : "double" }, "valuesCount" : { "type" : "number", "format" : "double" }, "valuesPercentage" : { "type" : "number", "format" : "double" }, "variance" : { "type" : "number", "format" : "double" } } }, "ColumnProfileList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ColumnProfile" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ColumnProfilerConfig" : { "type" : "object", "properties" : { "columnName" : { "type" : "string" }, "metrics" : { "type" : "array", "items" : { "type" : "string" } } } }, "ColumnTestSummaryDefinition" : { "type" : "object", "properties" : { "aborted" : { "type" : "integer", "format" : "int32" }, "entityLink" : { "pattern" : "(?U)^<#E::\\w+::(?:[^:<>|]|:[^:<>|])+(?:::(?:[^:<>|]|:[^:<>|])+)*>$", "type" : "string" }, "failed" : { "type" : "integer", "format" : "int32" }, "queued" : { "type" : "integer", "format" : "int32" }, "success" : { "type" : "integer", "format" : "int32" }, "total" : { "type" : "integer", "format" : "int32" } } }, "ComponentConfig" : { "type" : "object" }, "Container" : { "required" : [ "id", "name", "service" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataModel" : { "$ref" : "#/components/schemas/ContainerDataModel" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "fileFormats" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "zip", "gz", "zstd", "csv", "tsv", "json", "parquet", "avro" ] } }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullPath" : { "type" : "string" }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "numberOfObjects" : { "type" : "number", "format" : "double" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parent" : { "$ref" : "#/components/schemas/EntityReference" }, "prefix" : { "type" : "string" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "retentionPeriod" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "S3", "ADLS", "GCS", "CustomStorage" ] }, "size" : { "type" : "number", "format" : "double" }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "ContainerDataModel" : { "required" : [ "columns" ], "type" : "object", "properties" : { "columns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Column" } }, "isPartitioned" : { "type" : "boolean" } } }, "ContainerList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Container" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "CreateAPICollection" : { "required" : [ "name", "service" ], "type" : "object", "properties" : { "apiEndpoints" : { "type" : "array", "items" : { "type" : "string" } }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "endpointURL" : { "type" : "string", "format" : "uri" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateAPIEndpoint" : { "required" : [ "apiCollection", "endpointURL", "name" ], "type" : "object", "properties" : { "apiCollection" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "endpointURL" : { "type" : "string", "format" : "uri" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "requestMethod" : { "type" : "string", "enum" : [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "requestSchema" : { "$ref" : "#/components/schemas/APISchema" }, "responseSchema" : { "$ref" : "#/components/schemas/APISchema" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateApiService" : { "required" : [ "name", "serviceType" ], "type" : "object", "properties" : { "connection" : { "$ref" : "#/components/schemas/ApiConnection" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "Rest", "WEBHOOK" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateApp" : { "type" : "object", "properties" : { "appConfiguration" : { "type" : "object" }, "appSchedule" : { "$ref" : "#/components/schemas/AppSchedule" }, "bot" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "supportsInterrupt" : { "type" : "boolean" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateAppMarketPlaceDefinitionReq" : { "required" : [ "appType", "className", "name", "permission", "scheduleType" ], "type" : "object", "properties" : { "allowConfiguration" : { "type" : "boolean" }, "appConfiguration" : { "type" : "object" }, "appLogoUrl" : { "type" : "string", "format" : "uri" }, "appScreenshots" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "appType" : { "type" : "string", "enum" : [ "internal", "external" ] }, "className" : { "type" : "string" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "developer" : { "type" : "string" }, "developerUrl" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "features" : { "type" : "string" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "permission" : { "type" : "string", "enum" : [ "All" ] }, "privacyPolicyUrl" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "runtime" : { "type" : "object" }, "scheduleType" : { "type" : "string", "enum" : [ "Live", "Scheduled", "ScheduledOrManual", "NoSchedule" ] }, "sourcePythonClass" : { "type" : "string" }, "supportEmail" : { "type" : "string" }, "supportsInterrupt" : { "type" : "boolean" }, "system" : { "type" : "boolean" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateBot" : { "required" : [ "botUser", "name" ], "type" : "object", "properties" : { "botUser" : { "type" : "string" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateChart" : { "required" : [ "name", "service" ], "type" : "object", "properties" : { "chartType" : { "type" : "string", "enum" : [ "Line", "Table", "Bar", "Area", "Pie", "Histogram", "Scatter", "Text", "BoxPlot", "Other" ] }, "dashboards" : { "type" : "array", "items" : { "type" : "string" } }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateClassification" : { "required" : [ "description", "name" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "mutuallyExclusive" : { "type" : "boolean" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateContainer" : { "required" : [ "name", "service" ], "type" : "object", "properties" : { "dataModel" : { "$ref" : "#/components/schemas/ContainerDataModel" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "fileFormats" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "zip", "gz", "zstd", "csv", "tsv", "json", "parquet", "avro" ] } }, "fullPath" : { "type" : "string" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "numberOfObjects" : { "type" : "number", "format" : "double" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parent" : { "$ref" : "#/components/schemas/EntityReference" }, "prefix" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "size" : { "type" : "number", "format" : "double" }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateCustomMetric" : { "required" : [ "expression", "name" ], "type" : "object", "properties" : { "columnName" : { "type" : "string" }, "description" : { "type" : "string" }, "expression" : { "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" } } }, "CreateDashboard" : { "required" : [ "name", "service" ], "type" : "object", "properties" : { "charts" : { "type" : "array", "items" : { "type" : "string" } }, "dashboardType" : { "type" : "string", "enum" : [ "Dashboard", "Report" ] }, "dataModels" : { "type" : "array", "items" : { "type" : "string" } }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "project" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateDashboardDataModel" : { "required" : [ "columns", "dataModelType", "name", "service" ], "type" : "object", "properties" : { "columns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Column" } }, "dataModelType" : { "type" : "string", "enum" : [ "TableauDataModel", "TableauPublishedDatasource", "TableauEmbeddedDatasource", "SupersetDataModel", "MetabaseDataModel", "LookMlView", "LookMlExplore", "PowerBIDataModel", "QlikDataModel", "QuickSightDataModel", "SigmaDataModel" ] }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "project" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "serviceType" : { "type" : "string", "enum" : [ "Superset", "Looker", "Tableau", "Redash", "Metabase", "PowerBI", "PowerBIReportServer", "Mode", "CustomDashboard", "DomoDashboard", "QuickSight", "QlikSense", "Lightdash", "MicroStrategy", "QlikCloud", "Sigma" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sql" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateDashboardService" : { "required" : [ "name", "serviceType" ], "type" : "object", "properties" : { "connection" : { "$ref" : "#/components/schemas/DashboardConnection" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "Superset", "Looker", "Tableau", "Redash", "Metabase", "PowerBI", "PowerBIReportServer", "Mode", "CustomDashboard", "DomoDashboard", "QuickSight", "QlikSense", "Lightdash", "MicroStrategy", "QlikCloud", "Sigma" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateDataProduct" : { "required" : [ "description", "name" ], "type" : "object", "properties" : { "assets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "experts" : { "type" : "array", "items" : { "type" : "string" } }, "extension" : { "type" : "object" }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateDatabase" : { "required" : [ "name", "service" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "default" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "retentionPeriod" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateDatabaseSchema" : { "required" : [ "database", "name" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "database" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "retentionPeriod" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateDatabaseService" : { "required" : [ "name", "serviceType" ], "type" : "object", "properties" : { "connection" : { "$ref" : "#/components/schemas/DatabaseConnection" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "BigQuery", "BigTable", "Mysql", "Redshift", "Snowflake", "Postgres", "Mssql", "Oracle", "Athena", "Hive", "Impala", "Presto", "Trino", "Vertica", "Glue", "MariaDB", "Druid", "Db2", "Clickhouse", "Databricks", "AzureSQL", "DynamoDB", "SingleStore", "SQLite", "DeltaLake", "Salesforce", "PinotDB", "Datalake", "DomoDatabase", "QueryLog", "CustomDatabase", "Dbt", "SapHana", "MongoDB", "Couchbase", "Greenplum", "Doris", "UnityCatalog", "SAS", "Iceberg", "Teradata", "SapErp", "Synapse", "Exasol" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateDocument" : { "required" : [ "data", "entityType", "fullyQualifiedName", "name" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/Data" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "entityType" : { "type" : "string" }, "extension" : { "type" : "object" }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateDomain" : { "required" : [ "description", "domainType", "name" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "domainType" : { "type" : "string", "enum" : [ "Source-aligned", "Consumer-aligned", "Aggregate" ] }, "experts" : { "type" : "array", "items" : { "type" : "string" } }, "extension" : { "type" : "object" }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parent" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateEventSubscription" : { "required" : [ "alertType", "name" ], "type" : "object", "properties" : { "alertType" : { "type" : "string", "enum" : [ "Notification", "Observability", "ActivityFeed", "GovernanceWorkflowChangeEvent" ] }, "batchSize" : { "type" : "integer", "format" : "int32" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "destinations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubscriptionDestination" } }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "extension" : { "type" : "object" }, "input" : { "$ref" : "#/components/schemas/AlertFilteringInput" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pollInterval" : { "type" : "integer", "format" : "int32" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "resources" : { "type" : "array", "items" : { "type" : "string" } }, "retries" : { "type" : "integer", "format" : "int32" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "trigger" : { "$ref" : "#/components/schemas/TriggerConfig" } } }, "CreateGlossary" : { "required" : [ "description", "name" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "mutuallyExclusive" : { "type" : "boolean" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateGlossaryTerm" : { "required" : [ "description", "glossary", "name" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "glossary" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "mutuallyExclusive" : { "type" : "boolean" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parent" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "references" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TermReference" } }, "relatedTerms" : { "type" : "array", "items" : { "type" : "string" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "synonyms" : { "type" : "array", "items" : { "type" : "string" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateIngestionPipeline" : { "required" : [ "airflowConfig", "name", "pipelineType", "service", "sourceConfig" ], "type" : "object", "properties" : { "airflowConfig" : { "$ref" : "#/components/schemas/AirflowConfig" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "loggerLevel" : { "type" : "string", "enum" : [ "DEBUG", "INFO", "WARN", "ERROR" ] }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelineType" : { "type" : "string", "enum" : [ "metadata", "usage", "lineage", "profiler", "autoClassification", "TestSuite", "dataInsight", "elasticSearchReindex", "dbt", "application" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "sourceConfig" : { "$ref" : "#/components/schemas/SourceConfig" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateLogicalTestCases" : { "required" : [ "testCaseIds", "testSuiteId" ], "type" : "object", "properties" : { "testCaseIds" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } }, "testSuiteId" : { "type" : "string", "format" : "uuid" } } }, "CreateMessagingService" : { "required" : [ "name", "serviceType" ], "type" : "object", "properties" : { "connection" : { "$ref" : "#/components/schemas/MessagingConnection" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "Kafka", "Redpanda", "Kinesis", "CustomMessaging" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateMetadataService" : { "required" : [ "name", "serviceType" ], "type" : "object", "properties" : { "connection" : { "$ref" : "#/components/schemas/MetadataConnection" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "Amundsen", "MetadataES", "OpenMetadata", "Atlas", "Alation", "AlationSink" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateMetric" : { "required" : [ "name" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "granularity" : { "type" : "string", "enum" : [ "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "metricExpression" : { "$ref" : "#/components/schemas/MetricExpression" }, "metricType" : { "type" : "string", "enum" : [ "COUNT", "SUM", "AVERAGE", "RATIO", "PERCENTAGE", "MIN", "MAX", "MEDIAN", "MODE", "STANDARD_DEVIATION", "VARIANCE", "OTHER" ] }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "relatedMetrics" : { "type" : "array", "items" : { "type" : "string" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "unitOfMeasurement" : { "type" : "string", "enum" : [ "COUNT", "DOLLARS", "PERCENTAGE", "TIMESTAMP", "SIZE", "REQUESTS", "EVENTS", "TRANSACTIONS" ] } } }, "CreateMlModel" : { "required" : [ "name", "service" ], "type" : "object", "properties" : { "algorithm" : { "type" : "string" }, "dashboard" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "mlFeatures" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MlFeature" } }, "mlHyperParameters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MlHyperParameter" } }, "mlStore" : { "$ref" : "#/components/schemas/MlStore" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "server" : { "type" : "string", "format" : "uri" }, "service" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "target" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" } } }, "CreateMlModelService" : { "required" : [ "name", "serviceType" ], "type" : "object", "properties" : { "connection" : { "$ref" : "#/components/schemas/MlModelConnection" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "Mlflow", "Sklearn", "CustomMlModel", "SageMaker", "VertexAI" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreatePersona" : { "required" : [ "name" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "users" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } } } }, "CreatePersonalToken" : { "required" : [ "JWTTokenExpiry", "tokenName" ], "type" : "object", "properties" : { "JWTTokenExpiry" : { "type" : "string", "enum" : [ "OneHour", "1", "7", "30", "60", "90", "Unlimited" ] }, "tokenName" : { "type" : "string" } } }, "CreatePipeline" : { "required" : [ "name", "service" ], "type" : "object", "properties" : { "concurrency" : { "type" : "integer", "format" : "int32" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelineLocation" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "scheduleInterval" : { "type" : "string" }, "service" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "startDate" : { "type" : "string", "format" : "date-time" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "tasks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Task" } } } }, "CreatePipelineService" : { "required" : [ "name", "serviceType" ], "type" : "object", "properties" : { "connection" : { "$ref" : "#/components/schemas/PipelineConnection" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "scheduleInterval" : { "type" : "string" }, "serviceType" : { "type" : "string", "enum" : [ "Airflow", "GluePipeline", "Airbyte", "Fivetran", "Flink", "Dagster", "Nifi", "DomoPipeline", "CustomPipeline", "DatabricksPipeline", "Spline", "Spark", "OpenLineage", "KafkaConnect", "DBTCloud", "Matillion", "Stitch", "DataFactory" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreatePolicy" : { "required" : [ "name", "rules" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "location" : { "type" : "string", "format" : "uuid" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "rules" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Rule" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreatePost" : { "required" : [ "from", "message" ], "type" : "object", "properties" : { "from" : { "type" : "string" }, "message" : { "type" : "string" } } }, "CreateQuery" : { "required" : [ "query", "service" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "dialect" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "duration" : { "type" : "number", "format" : "double" }, "exclude_usage" : { "type" : "boolean" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "processedLineage" : { "type" : "boolean" }, "query" : { "type" : "string" }, "queryDate" : { "type" : "integer", "format" : "int64" }, "queryUsedIn" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "query_type" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "triggeredBy" : { "$ref" : "#/components/schemas/EntityReference" }, "usedBy" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "users" : { "type" : "array", "items" : { "type" : "string" } } } }, "CreateRole" : { "required" : [ "name", "policies" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "policies" : { "type" : "array", "items" : { "type" : "string" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateSearchIndex" : { "required" : [ "fields", "name", "service" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "extension" : { "type" : "object" }, "fields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchIndexField" } }, "indexType" : { "type" : "string", "enum" : [ "Index", "IndexTemplate" ] }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "searchIndexSettings" : { "$ref" : "#/components/schemas/SearchIndexSettings" }, "service" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateSearchService" : { "required" : [ "name", "serviceType" ], "type" : "object", "properties" : { "connection" : { "$ref" : "#/components/schemas/SearchConnection" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "ElasticSearch", "OpenSearch", "CustomSearch" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateStorageService" : { "required" : [ "name", "serviceType" ], "type" : "object", "properties" : { "connection" : { "$ref" : "#/components/schemas/StorageConnection" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "S3", "ADLS", "GCS", "CustomStorage" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateStoredProcedure" : { "required" : [ "name", "storedProcedureCode" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "databaseSchema" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "storedProcedureCode" : { "$ref" : "#/components/schemas/StoredProcedureCode" }, "storedProcedureType" : { "type" : "string", "enum" : [ "StoredProcedure", "UDF" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateSuggestion" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "entityLink" : { "pattern" : "(?U)^<#E::\\w+::(?:[^:<>|]|:[^:<>|])+(?:::(?:[^:<>|]|:[^:<>|])+)*>$", "type" : "string" }, "tagLabels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "type" : { "type" : "string", "enum" : [ "SuggestDescription", "SuggestTagLabel" ] } } }, "CreateTable" : { "required" : [ "columns", "databaseSchema", "name" ], "type" : "object", "properties" : { "columns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Column" } }, "dataModel" : { "$ref" : "#/components/schemas/DataModel" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "databaseSchema" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "fileFormat" : { "type" : "string", "enum" : [ "csv", "tsv", "avro", "parquet", "json", "json.gz", "json.zip", "jsonl", "jsonl.gz", "jsonl.zip" ] }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "locationPath" : { "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "retentionPeriod" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "schemaDefinition" : { "type" : "string" }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "tableConstraints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TableConstraint" } }, "tablePartition" : { "$ref" : "#/components/schemas/TablePartition" }, "tableProfilerConfig" : { "$ref" : "#/components/schemas/TableProfilerConfig" }, "tableType" : { "type" : "string", "enum" : [ "Regular", "External", "Dynamic", "View", "SecureView", "MaterializedView", "Iceberg", "Local", "Partitioned", "Foreign", "Transient" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateTableProfile" : { "required" : [ "tableProfile" ], "type" : "object", "properties" : { "columnProfile" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ColumnProfile" } }, "systemProfile" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SystemProfile" } }, "tableProfile" : { "$ref" : "#/components/schemas/TableProfile" } } }, "CreateTag" : { "required" : [ "description", "name" ], "type" : "object", "properties" : { "associatedTags" : { "type" : "array", "items" : { "type" : "string" } }, "classification" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "mutuallyExclusive" : { "type" : "boolean" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parent" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateTaskDetails" : { "required" : [ "assignees", "type" ], "type" : "object", "properties" : { "assignees" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "oldValue" : { "type" : "string" }, "suggestion" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "RequestDescription", "UpdateDescription", "RequestTag", "UpdateTag", "RequestApproval", "RequestTestCaseFailureResolution", "Generic" ] } } }, "CreateTeam" : { "required" : [ "name", "teamType" ], "type" : "object", "properties" : { "children" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "defaultRoles" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "domains" : { "type" : "array", "items" : { "type" : "string" } }, "email" : { "maxLength" : 127, "minLength" : 6, "pattern" : "^[\\S.!#$%&’*+/=?^_`{|}~-]+@\\S+\\.\\S+$", "type" : "string" }, "extension" : { "type" : "object" }, "isJoinable" : { "type" : "boolean" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parents" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } }, "policies" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } }, "profile" : { "$ref" : "#/components/schemas/Profile" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "teamType" : { "type" : "string", "enum" : [ "Group", "Department", "Division", "BusinessUnit", "Organization" ] }, "users" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } } } }, "CreateTestCase" : { "required" : [ "entityLink", "name", "testDefinition", "testSuite" ], "type" : "object", "properties" : { "computePassedFailedRowCount" : { "type" : "boolean" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "entityLink" : { "pattern" : "(?U)^<#E::\\w+::(?:[^:<>|]|:[^:<>|])+(?:::(?:[^:<>|]|:[^:<>|])+)*>$", "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 2147483647, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parameterValues" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestCaseParameterValue" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testDefinition" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "testSuite" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "useDynamicAssertion" : { "type" : "boolean" } } }, "CreateTestCaseResolutionStatus" : { "required" : [ "testCaseReference", "testCaseResolutionStatusType" ], "type" : "object", "properties" : { "severity" : { "type" : "string", "enum" : [ "Severity1", "Severity2", "Severity3", "Severity4", "Severity5" ] }, "testCaseReference" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "testCaseResolutionStatusDetails" : { "type" : "object" }, "testCaseResolutionStatusType" : { "type" : "string", "enum" : [ "New", "Ack", "Assigned", "Resolved" ] } } }, "CreateTestCaseResult" : { "required" : [ "testCaseStatus", "testResultValue", "timestamp" ], "type" : "object", "properties" : { "failedRows" : { "type" : "integer", "format" : "int32" }, "failedRowsPercentage" : { "type" : "number", "format" : "double" }, "fqn" : { "type" : "string" }, "incidentId" : { "type" : "string", "format" : "uuid" }, "maxBound" : { "type" : "number", "format" : "double" }, "minBound" : { "type" : "number", "format" : "double" }, "passedRows" : { "type" : "integer", "format" : "int32" }, "passedRowsPercentage" : { "type" : "number", "format" : "double" }, "result" : { "type" : "string" }, "sampleData" : { "type" : "string" }, "testCaseStatus" : { "type" : "string", "enum" : [ "Success", "Failed", "Aborted", "Queued" ] }, "testResultValue" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestResultValue" } }, "timestamp" : { "type" : "integer", "format" : "int64" } } }, "CreateTestDefinition" : { "required" : [ "description", "entityType", "name", "testPlatforms" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "entityType" : { "type" : "string", "enum" : [ "TABLE", "COLUMN" ] }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 2147483647, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parameterDefinition" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestCaseParameter" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "supportedDataTypes" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "NUMBER", "TINYINT", "SMALLINT", "INT", "BIGINT", "BYTEINT", "BYTES", "FLOAT", "DOUBLE", "DECIMAL", "NUMERIC", "TIMESTAMP", "TIMESTAMPZ", "TIME", "DATE", "DATETIME", "INTERVAL", "STRING", "MEDIUMTEXT", "TEXT", "CHAR", "LONG", "VARCHAR", "BOOLEAN", "BINARY", "VARBINARY", "ARRAY", "BLOB", "LONGBLOB", "MEDIUMBLOB", "MAP", "STRUCT", "UNION", "SET", "GEOGRAPHY", "ENUM", "JSON", "UUID", "VARIANT", "GEOMETRY", "BYTEA", "AGGREGATEFUNCTION", "ERROR", "FIXED", "RECORD", "NULL", "SUPER", "HLLSKETCH", "PG_LSN", "PG_SNAPSHOT", "TSQUERY", "TXID_SNAPSHOT", "XML", "MACADDR", "TSVECTOR", "UNKNOWN", "CIDR", "INET", "CLOB", "ROWID", "LOWCARDINALITY", "YEAR", "POINT", "POLYGON", "TUPLE", "SPATIAL", "TABLE", "NTEXT", "IMAGE", "IPV4", "IPV6", "DATETIMERANGE", "HLL", "LARGEINT", "QUANTILE_STATE", "AGG_STATE", "BITMAP", "UINT", "BIT", "MONEY" ] } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testPlatforms" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "OpenMetadata", "GreatExpectations", "DBT", "Deequ", "Soda", "Other" ] } } } }, "CreateTestSuite" : { "required" : [ "name" ], "type" : "object", "properties" : { "basicEntityReference" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "executableEntityReference" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateThread" : { "required" : [ "about", "from", "message" ], "type" : "object", "properties" : { "about" : { "pattern" : "(?U)^<#E::\\w+::(?:[^:<>|]|:[^:<>|])+(?:::(?:[^:<>|]|:[^:<>|])+)*>$", "type" : "string" }, "addressedTo" : { "pattern" : "(?U)^<#E::\\w+::(?:[^:<>|]|:[^:<>|])+(?:::(?:[^:<>|]|:[^:<>|])+)*>$", "type" : "string" }, "announcementDetails" : { "$ref" : "#/components/schemas/AnnouncementDetails" }, "chatbotDetails" : { "$ref" : "#/components/schemas/ChatbotDetails" }, "from" : { "type" : "string" }, "message" : { "type" : "string" }, "taskDetails" : { "$ref" : "#/components/schemas/CreateTaskDetails" }, "type" : { "type" : "string", "enum" : [ "Conversation", "Task", "Announcement", "Chatbot" ] } } }, "CreateTopic" : { "required" : [ "name", "partitions", "service" ], "type" : "object", "properties" : { "cleanupPolicies" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "delete", "compact" ] } }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "maximumMessageSize" : { "type" : "integer", "format" : "int32" }, "messageSchema" : { "$ref" : "#/components/schemas/MessageSchema" }, "minimumInSyncReplicas" : { "type" : "integer", "format" : "int32" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "partitions" : { "type" : "integer", "format" : "int32" }, "replicationFactor" : { "type" : "integer", "format" : "int32" }, "retentionSize" : { "type" : "number", "format" : "double" }, "retentionTime" : { "type" : "number", "format" : "double" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "topicConfig" : { "$ref" : "#/components/schemas/TopicConfig" } } }, "CreateType" : { "required" : [ "description", "name", "nameSpace", "schema" ], "type" : "object", "properties" : { "category" : { "type" : "string", "enum" : [ "field", "entity" ] }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "pattern" : "(?U)^[\\w]+$", "type" : "string" }, "nameSpace" : { "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "schema" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "CreateUser" : { "required" : [ "email", "name" ], "type" : "object", "properties" : { "authenticationMechanism" : { "$ref" : "#/components/schemas/AuthenticationMechanism" }, "botName" : { "type" : "string" }, "confirmPassword" : { "type" : "string" }, "createPasswordType" : { "type" : "string", "enum" : [ "ADMIN_CREATE", "USER_CREATE" ] }, "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "defaultPersona" : { "$ref" : "#/components/schemas/EntityReference" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "domains" : { "type" : "array", "items" : { "type" : "string" } }, "email" : { "maxLength" : 127, "minLength" : 6, "pattern" : "^[\\S.!#$%&’*+/=?^_`{|}~-]+@\\S+\\.\\S+$", "type" : "string" }, "extension" : { "type" : "object" }, "isAdmin" : { "type" : "boolean" }, "isBot" : { "type" : "boolean" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "password" : { "type" : "string" }, "personas" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "profile" : { "$ref" : "#/components/schemas/Profile" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "roles" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "teams" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } }, "timezone" : { "type" : "string" } } }, "CreateWorkflowDefinition" : { "required" : [ "description", "name" ], "type" : "object", "properties" : { "dataProducts" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "type" : "string" }, "edges" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EdgeDefinition" } }, "extension" : { "type" : "object" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "nodes" : { "type" : "array", "items" : { "type" : "object" } }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "trigger" : { "type" : "object" }, "type" : { "type" : "string", "enum" : [ "eventBasedEntityWorkflow", "periodicBatchEntityWorkflow" ] } } }, "CsvImportResult" : { "type" : "object", "properties" : { "abortReason" : { "type" : "string" }, "dryRun" : { "type" : "boolean" }, "importResultsCsv" : { "type" : "string" }, "numberOfRowsFailed" : { "type" : "integer", "format" : "int32" }, "numberOfRowsPassed" : { "type" : "integer", "format" : "int32" }, "numberOfRowsProcessed" : { "type" : "integer", "format" : "int32" }, "status" : { "type" : "string", "enum" : [ "success", "failure", "aborted", "partialSuccess" ] } } }, "CustomMetric" : { "required" : [ "expression", "name" ], "type" : "object", "properties" : { "columnName" : { "type" : "string" }, "description" : { "type" : "string" }, "expression" : { "type" : "string" }, "id" : { "type" : "string", "format" : "uuid" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" } } }, "CustomMetricProfile" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "value" : { "type" : "number", "format" : "double" } } }, "CustomProperty" : { "required" : [ "description", "name", "propertyType" ], "type" : "object", "properties" : { "customPropertyConfig" : { "$ref" : "#/components/schemas/CustomPropertyConfig" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "propertyType" : { "$ref" : "#/components/schemas/EntityReference" } } }, "CustomPropertyConfig" : { "type" : "object", "properties" : { "config" : { "type" : "object" } } }, "DailyCount" : { "required" : [ "count", "date" ], "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32" }, "date" : { "type" : "string" } } }, "Dashboard" : { "required" : [ "id", "name", "service" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "charts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dashboardType" : { "type" : "string", "enum" : [ "Dashboard", "Report" ] }, "dataModels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "project" : { "type" : "string" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "Superset", "Looker", "Tableau", "Redash", "Metabase", "PowerBI", "PowerBIReportServer", "Mode", "CustomDashboard", "DomoDashboard", "QuickSight", "QlikSense", "Lightdash", "MicroStrategy", "QlikCloud", "Sigma" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "usageSummary" : { "$ref" : "#/components/schemas/UsageDetails" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "DashboardConnection" : { "type" : "object", "properties" : { "config" : { "type" : "object" } } }, "DashboardDataModel" : { "required" : [ "columns", "dataModelType", "id", "name" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "columns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Column" } }, "dataModelType" : { "type" : "string", "enum" : [ "TableauDataModel", "TableauPublishedDatasource", "TableauEmbeddedDatasource", "SupersetDataModel", "MetabaseDataModel", "LookMlView", "LookMlExplore", "PowerBIDataModel", "QlikDataModel", "QuickSightDataModel", "SigmaDataModel" ] }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "project" : { "type" : "string" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "Superset", "Looker", "Tableau", "Redash", "Metabase", "PowerBI", "PowerBIReportServer", "Mode", "CustomDashboard", "DomoDashboard", "QuickSight", "QlikSense", "Lightdash", "MicroStrategy", "QlikCloud", "Sigma" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sql" : { "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "DashboardDataModelList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DashboardDataModel" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "DashboardList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Dashboard" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "DashboardService" : { "required" : [ "id", "name", "serviceType" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "connection" : { "$ref" : "#/components/schemas/DashboardConnection" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelines" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "Superset", "Looker", "Tableau", "Redash", "Metabase", "PowerBI", "PowerBIReportServer", "Mode", "CustomDashboard", "DomoDashboard", "QuickSight", "QlikSense", "Lightdash", "MicroStrategy", "QlikCloud", "Sigma" ] }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testConnectionResult" : { "$ref" : "#/components/schemas/TestConnectionResult" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "DashboardServiceList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DashboardService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "Data" : { "type" : "object" }, "DataModel" : { "required" : [ "modelType" ], "type" : "object", "properties" : { "columns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Column" } }, "description" : { "type" : "string" }, "generatedAt" : { "type" : "string", "format" : "date-time" }, "modelType" : { "type" : "string", "enum" : [ "DBT", "DDL" ] }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "path" : { "type" : "string" }, "rawSql" : { "type" : "string" }, "resourceType" : { "type" : "string" }, "sql" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "upstream" : { "type" : "array", "items" : { "type" : "string" } } } }, "DataProduct" : { "required" : [ "description", "id", "name" ], "type" : "object", "properties" : { "assets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "DataProductList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DataProduct" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "DataQualityReport" : { "required" : [ "data", "metadata" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Datum" } }, "metadata" : { "$ref" : "#/components/schemas/DataQualityReportMetadata" } } }, "DataQualityReportMetadata" : { "type" : "object", "properties" : { "dimensions" : { "type" : "array", "items" : { "type" : "string" } }, "keys" : { "type" : "array", "items" : { "type" : "string" } }, "metrics" : { "type" : "array", "items" : { "type" : "string" } } } }, "Database" : { "required" : [ "id", "name", "service" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "databaseProfilerConfig" : { "$ref" : "#/components/schemas/DatabaseProfilerConfig" }, "databaseSchemas" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "default" : { "type" : "boolean" }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "location" : { "$ref" : "#/components/schemas/EntityReference" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "retentionPeriod" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "BigQuery", "BigTable", "Mysql", "Redshift", "Snowflake", "Postgres", "Mssql", "Oracle", "Athena", "Hive", "Impala", "Presto", "Trino", "Vertica", "Glue", "MariaDB", "Druid", "Db2", "Clickhouse", "Databricks", "AzureSQL", "DynamoDB", "SingleStore", "SQLite", "DeltaLake", "Salesforce", "PinotDB", "Datalake", "DomoDatabase", "QueryLog", "CustomDatabase", "Dbt", "SapHana", "MongoDB", "Couchbase", "Greenplum", "Doris", "UnityCatalog", "SAS", "Iceberg", "Teradata", "SapErp", "Synapse", "Exasol" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "usageSummary" : { "$ref" : "#/components/schemas/UsageDetails" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "DatabaseConnection" : { "type" : "object", "properties" : { "config" : { "type" : "object" } } }, "DatabaseList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Database" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "DatabaseProfilerConfig" : { "type" : "object", "properties" : { "profileSample" : { "type" : "number", "format" : "double" }, "profileSampleType" : { "type" : "string", "enum" : [ "PERCENTAGE", "ROWS" ] }, "sampleDataCount" : { "type" : "integer", "format" : "int32" }, "sampleDataStorageConfig" : { "$ref" : "#/components/schemas/SampleDataStorageConfig" }, "samplingMethodType" : { "type" : "string", "enum" : [ "BERNOULLI", "SYSTEM" ] } } }, "DatabaseSchema" : { "required" : [ "database", "name", "service" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "database" : { "$ref" : "#/components/schemas/EntityReference" }, "databaseSchemaProfilerConfig" : { "$ref" : "#/components/schemas/DatabaseSchemaProfilerConfig" }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "retentionPeriod" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "BigQuery", "BigTable", "Mysql", "Redshift", "Snowflake", "Postgres", "Mssql", "Oracle", "Athena", "Hive", "Impala", "Presto", "Trino", "Vertica", "Glue", "MariaDB", "Druid", "Db2", "Clickhouse", "Databricks", "AzureSQL", "DynamoDB", "SingleStore", "SQLite", "DeltaLake", "Salesforce", "PinotDB", "Datalake", "DomoDatabase", "QueryLog", "CustomDatabase", "Dbt", "SapHana", "MongoDB", "Couchbase", "Greenplum", "Doris", "UnityCatalog", "SAS", "Iceberg", "Teradata", "SapErp", "Synapse", "Exasol" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tables" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "usageSummary" : { "$ref" : "#/components/schemas/UsageDetails" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "DatabaseSchemaList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DatabaseSchema" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "DatabaseSchemaProfilerConfig" : { "type" : "object", "properties" : { "profileSample" : { "type" : "number", "format" : "double" }, "profileSampleType" : { "type" : "string", "enum" : [ "PERCENTAGE", "ROWS" ] }, "sampleDataCount" : { "type" : "integer", "format" : "int32" }, "sampleDataStorageConfig" : { "$ref" : "#/components/schemas/SampleDataStorageConfig" }, "samplingMethodType" : { "type" : "string", "enum" : [ "BERNOULLI", "SYSTEM" ] } } }, "DatabaseService" : { "required" : [ "id", "name", "serviceType" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "connection" : { "$ref" : "#/components/schemas/DatabaseConnection" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelines" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "BigQuery", "BigTable", "Mysql", "Redshift", "Snowflake", "Postgres", "Mssql", "Oracle", "Athena", "Hive", "Impala", "Presto", "Trino", "Vertica", "Glue", "MariaDB", "Druid", "Db2", "Clickhouse", "Databricks", "AzureSQL", "DynamoDB", "SingleStore", "SQLite", "DeltaLake", "Salesforce", "PinotDB", "Datalake", "DomoDatabase", "QueryLog", "CustomDatabase", "Dbt", "SapHana", "MongoDB", "Couchbase", "Greenplum", "Doris", "UnityCatalog", "SAS", "Iceberg", "Teradata", "SapErp", "Synapse", "Exasol" ] }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testConnectionResult" : { "$ref" : "#/components/schemas/TestConnectionResult" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "DatabaseServiceList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DatabaseService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "Datum" : { "type" : "object" }, "Document" : { "required" : [ "data", "entityType", "fullyQualifiedName", "name" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "data" : { "$ref" : "#/components/schemas/Data" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "entityType" : { "type" : "string" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "DocumentField" : { "type" : "object", "properties" : { "ignoredValues" : { "type" : "array", "items" : { "type" : "object" } }, "ignoredValuesWriter" : { "$ref" : "#/components/schemas/ToXContentFragment" }, "name" : { "type" : "string" }, "validValuesWriter" : { "$ref" : "#/components/schemas/ToXContentFragment" }, "value" : { "type" : "object" }, "values" : { "type" : "array", "items" : { "type" : "object" } } } }, "DocumentList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Document" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "Domain" : { "required" : [ "description", "domainType", "id", "name" ], "type" : "object", "properties" : { "assets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "domainType" : { "type" : "string", "enum" : [ "Source-aligned", "Consumer-aligned", "Aggregate" ] }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parent" : { "$ref" : "#/components/schemas/EntityReference" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "DomainList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Domain" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "Edge" : { "required" : [ "fromEntity", "toEntity" ], "type" : "object", "properties" : { "description" : { "type" : "string" }, "fromEntity" : { "type" : "string", "format" : "uuid" }, "lineageDetails" : { "$ref" : "#/components/schemas/LineageDetails" }, "toEntity" : { "type" : "string", "format" : "uuid" } } }, "EdgeDefinition" : { "required" : [ "from", "to" ], "type" : "object", "properties" : { "condition" : { "type" : "boolean" }, "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "ElasticsSearch" : { "required" : [ "type" ], "type" : "object", "properties" : { "config" : { "$ref" : "#/components/schemas/ComponentConfig" }, "type" : { "type" : "string" } } }, "EmailRequest" : { "required" : [ "email" ], "type" : "object", "properties" : { "email" : { "maxLength" : 127, "minLength" : 6, "pattern" : "^[\\S.!#$%&’*+/=?^_`{|}~-]+@\\S+\\.\\S+$", "type" : "string" } } }, "EmailTemplate" : { "required" : [ "placeHolders", "template" ], "type" : "object", "properties" : { "placeHolders" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/EmailTemplatePlaceholder" } }, "template" : { "type" : "string" } } }, "EmailTemplatePlaceholder" : { "required" : [ "description", "name" ], "type" : "object", "properties" : { "description" : { "type" : "string" }, "name" : { "type" : "string" } } }, "EntitiesEdge" : { "required" : [ "fromEntity", "toEntity" ], "type" : "object", "properties" : { "description" : { "type" : "string" }, "fromEntity" : { "$ref" : "#/components/schemas/EntityReference" }, "lineageDetails" : { "$ref" : "#/components/schemas/LineageDetails" }, "toEntity" : { "$ref" : "#/components/schemas/EntityReference" } } }, "EntityError" : { "type" : "object", "properties" : { "entity" : { "type" : "object" }, "message" : { "type" : "string" } } }, "EntityHierarchy" : { "required" : [ "description", "id", "name" ], "type" : "object", "properties" : { "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityHierarchy" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "id" : { "type" : "string", "format" : "uuid" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" } } }, "EntityHierarchyList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityHierarchy" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "EntityHistory" : { "required" : [ "entityType", "versions" ], "type" : "object", "properties" : { "entityType" : { "type" : "string" }, "versions" : { "type" : "array", "items" : { "type" : "object" } } } }, "EntityLineage" : { "required" : [ "entity" ], "type" : "object", "properties" : { "downstreamEdges" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Edge" } }, "entity" : { "$ref" : "#/components/schemas/EntityReference" }, "nodes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "upstreamEdges" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Edge" } } } }, "EntityReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "fullyQualifiedName" : { "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "inherited" : { "type" : "boolean" }, "name" : { "type" : "string" }, "type" : { "type" : "string" } } }, "EntityUsage" : { "required" : [ "entity", "usage" ], "type" : "object", "properties" : { "entity" : { "$ref" : "#/components/schemas/EntityReference" }, "usage" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UsageDetails" } } } }, "EventFilterRule" : { "required" : [ "condition", "effect" ], "type" : "object", "properties" : { "arguments" : { "type" : "array", "items" : { "type" : "string" } }, "condition" : { "type" : "string" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "effect" : { "type" : "string", "enum" : [ "include", "exclude" ] }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "inputType" : { "type" : "string", "enum" : [ "static", "runtime", "none" ] }, "name" : { "type" : "string" }, "prefixCondition" : { "type" : "string", "enum" : [ "AND", "OR" ] } } }, "EventList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ChangeEvent" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "EventSubscription" : { "required" : [ "alertType", "destinations", "id", "name" ], "type" : "object", "properties" : { "alertType" : { "type" : "string", "enum" : [ "Notification", "Observability", "ActivityFeed", "GovernanceWorkflowChangeEvent" ] }, "batchSize" : { "type" : "integer", "format" : "int32" }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "destinations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubscriptionDestination" } }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "enabled" : { "type" : "boolean" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "filteringRules" : { "$ref" : "#/components/schemas/FilteringRules" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "input" : { "$ref" : "#/components/schemas/AlertFilteringInput" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pollInterval" : { "type" : "integer", "format" : "int32" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "retries" : { "type" : "integer", "format" : "int32" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "trigger" : { "$ref" : "#/components/schemas/TriggerConfig" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "EventSubscriptionDestinationTestRequest" : { "type" : "object", "properties" : { "destinations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubscriptionDestination" } } } }, "EventSubscriptionDiagnosticInfo" : { "type" : "object", "properties" : { "currentOffset" : { "type" : "integer", "format" : "int64" }, "failedEventsCount" : { "type" : "integer", "format" : "int64" }, "hasProcessedAllEvents" : { "type" : "boolean" }, "latestOffset" : { "type" : "integer", "format" : "int64" }, "relevantUnprocessedEventsCount" : { "type" : "integer", "format" : "int64" }, "relevantUnprocessedEventsList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ChangeEvent" } }, "startingOffset" : { "type" : "integer", "format" : "int64" }, "successfulEventsCount" : { "type" : "integer", "format" : "int64" }, "totalUnprocessedEventsCount" : { "type" : "integer", "format" : "int64" }, "totalUnprocessedEventsList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ChangeEvent" } } } }, "EventSubscriptionList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventSubscription" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "EventsRecord" : { "type" : "object", "properties" : { "failedEventsCount" : { "type" : "integer", "format" : "int64" }, "pendingEventsCount" : { "type" : "integer", "format" : "int64" }, "successfulEventsCount" : { "type" : "integer", "format" : "int64" }, "totalEventsCount" : { "type" : "integer", "format" : "int64" } } }, "Explanation" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "details" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Explanation" } }, "match" : { "type" : "boolean" }, "value" : { "type" : "number" } } }, "ExtraHeaders" : { "type" : "object" }, "FailureContext" : { "type" : "object" }, "FeedInfo" : { "type" : "object", "properties" : { "entitySpecificInfo" : { "type" : "object" }, "fieldName" : { "type" : "string" }, "headerMessage" : { "type" : "string" } } }, "Field" : { "required" : [ "dataType", "name" ], "type" : "object", "properties" : { "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Field" } }, "dataType" : { "type" : "string", "enum" : [ "RECORD", "NULL", "BOOLEAN", "INT", "LONG", "BYTES", "FLOAT", "DOUBLE", "TIMESTAMP", "TIMESTAMPZ", "TIME", "DATE", "STRING", "ARRAY", "MAP", "ENUM", "UNION", "FIXED", "ERROR", "UNKNOWN" ] }, "dataTypeDisplay" : { "type" : "string" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "name" : { "maxLength" : 128, "minLength" : 1, "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "FieldChange" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "newValue" : { "type" : "object" }, "oldValue" : { "type" : "object" } } }, "FieldComparatorSource" : { "type" : "object" }, "FilterResourceDescriptor" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "supportedActions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventFilterRule" } }, "supportedFilters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventFilterRule" } } } }, "FilteringRules" : { "required" : [ "resources" ], "type" : "object", "properties" : { "actions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventFilterRule" } }, "resources" : { "type" : "array", "items" : { "type" : "string" } }, "rules" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventFilterRule" } } } }, "Function" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "examples" : { "type" : "array", "items" : { "type" : "object" } }, "input" : { "type" : "string" }, "name" : { "type" : "string" }, "paramAdditionalContext" : { "$ref" : "#/components/schemas/ParamAdditionalContext" }, "parameterInputType" : { "type" : "string", "enum" : [ "NotRequired", "AllIndexElasticSearch", "SpecificIndexElasticSearch", "ReadFromParamContext", "ReadFromParamContextPerEntity" ] } } }, "GenerateTokenRequest" : { "required" : [ "JWTTokenExpiry" ], "type" : "object", "properties" : { "JWTTokenExpiry" : { "type" : "string", "enum" : [ "OneHour", "1", "7", "30", "60", "90", "Unlimited" ] } } }, "Glossary" : { "required" : [ "description", "id", "name" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "disabled" : { "type" : "boolean" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "mutuallyExclusive" : { "type" : "boolean" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "termCount" : { "type" : "integer", "format" : "int32" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "usageCount" : { "type" : "integer", "format" : "int32" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "GlossaryList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Glossary" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "GlossaryTerm" : { "required" : [ "description", "glossary", "id", "name" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "childrenCount" : { "type" : "integer", "format" : "int32" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "disabled" : { "type" : "boolean" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "glossary" : { "$ref" : "#/components/schemas/EntityReference" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "mutuallyExclusive" : { "type" : "boolean" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parent" : { "$ref" : "#/components/schemas/EntityReference" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "references" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TermReference" } }, "relatedTerms" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "status" : { "type" : "string", "enum" : [ "Draft", "In Review", "Approved", "Deprecated", "Rejected" ] }, "style" : { "$ref" : "#/components/schemas/Style" }, "synonyms" : { "type" : "array", "items" : { "type" : "string" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "usageCount" : { "type" : "integer", "format" : "int32" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "GlossaryTermList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GlossaryTerm" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "HighlightField" : { "type" : "object", "properties" : { "fragment" : { "type" : "boolean" }, "fragments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Text" } }, "name" : { "type" : "string" } } }, "Histogram" : { "type" : "object", "properties" : { "boundaries" : { "type" : "array", "items" : { "type" : "object" } }, "frequencies" : { "type" : "array", "items" : { "type" : "object" } } } }, "ImageList" : { "type" : "object", "properties" : { "image" : { "type" : "string", "format" : "uri" }, "image192" : { "type" : "string", "format" : "uri" }, "image24" : { "type" : "string", "format" : "uri" }, "image32" : { "type" : "string", "format" : "uri" }, "image48" : { "type" : "string", "format" : "uri" }, "image512" : { "type" : "string", "format" : "uri" }, "image72" : { "type" : "string", "format" : "uri" } } }, "Index" : { "type" : "object", "properties" : { "fragment" : { "type" : "boolean" }, "name" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "IndexSorter" : { "type" : "object", "properties" : { "providerName" : { "type" : "string" } } }, "IngestionPipeline" : { "required" : [ "airflowConfig", "name", "pipelineType", "sourceConfig" ], "type" : "object", "properties" : { "airflowConfig" : { "$ref" : "#/components/schemas/AirflowConfig" }, "applicationType" : { "type" : "string" }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "deployed" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "enabled" : { "type" : "boolean" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "loggerLevel" : { "type" : "string", "enum" : [ "DEBUG", "INFO", "WARN", "ERROR" ] }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "openMetadataServerConnection" : { "$ref" : "#/components/schemas/OpenMetadataConnection" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelineStatuses" : { "$ref" : "#/components/schemas/PipelineStatus" }, "pipelineType" : { "type" : "string", "enum" : [ "metadata", "usage", "lineage", "profiler", "autoClassification", "TestSuite", "dataInsight", "elasticSearchReindex", "dbt", "application" ] }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "sourceConfig" : { "$ref" : "#/components/schemas/SourceConfig" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "JWTAuthMechanism" : { "required" : [ "JWTTokenExpiry" ], "type" : "object", "properties" : { "JWTToken" : { "type" : "string" }, "JWTTokenExpiresAt" : { "type" : "integer", "format" : "int64" }, "JWTTokenExpiry" : { "type" : "string", "enum" : [ "OneHour", "1", "7", "30", "60", "90", "Unlimited" ] } } }, "JoinedWith" : { "required" : [ "fullyQualifiedName", "joinCount" ], "type" : "object", "properties" : { "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "joinCount" : { "type" : "integer", "format" : "int32" } } }, "JwtResponse" : { "type" : "object", "properties" : { "accessToken" : { "type" : "string" }, "expiryDuration" : { "type" : "integer", "format" : "int64" }, "refreshToken" : { "type" : "string" }, "tokenType" : { "type" : "string" } } }, "LifeCycle" : { "type" : "object", "properties" : { "accessed" : { "$ref" : "#/components/schemas/AccessDetails" }, "created" : { "$ref" : "#/components/schemas/AccessDetails" }, "updated" : { "$ref" : "#/components/schemas/AccessDetails" } } }, "LineageDetails" : { "type" : "object", "properties" : { "columnsLineage" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ColumnLineage" } }, "description" : { "type" : "string" }, "pipeline" : { "$ref" : "#/components/schemas/EntityReference" }, "source" : { "type" : "string", "enum" : [ "Manual", "ViewLineage", "QueryLineage", "PipelineLineage", "DashboardLineage", "DbtLineage", "SparkLineage", "OpenLineage", "ExternalTableLineage" ] }, "sqlQuery" : { "type" : "string" } } }, "LoginRequest" : { "required" : [ "email", "password" ], "type" : "object", "properties" : { "email" : { "type" : "string" }, "password" : { "type" : "string" } } }, "LogoutRequest" : { "required" : [ "token" ], "type" : "object", "properties" : { "logoutTime" : { "type" : "string", "format" : "date-time" }, "refreshToken" : { "type" : "string" }, "token" : { "type" : "string" }, "username" : { "type" : "string" } } }, "MessageSchema" : { "type" : "object", "properties" : { "schemaFields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Field" } }, "schemaText" : { "type" : "string" }, "schemaType" : { "type" : "string", "enum" : [ "Avro", "Protobuf", "JSON", "Other", "None" ] } } }, "MessagingConnection" : { "type" : "object", "properties" : { "config" : { "type" : "object" } } }, "MessagingService" : { "required" : [ "id", "name", "serviceType" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "connection" : { "$ref" : "#/components/schemas/MessagingConnection" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelines" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "Kafka", "Redpanda", "Kinesis", "CustomMessaging" ] }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testConnectionResult" : { "$ref" : "#/components/schemas/TestConnectionResult" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "MessagingServiceList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MessagingService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "MetadataConnection" : { "type" : "object", "properties" : { "config" : { "type" : "object" } } }, "MetadataService" : { "required" : [ "id", "name", "serviceType" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "connection" : { "$ref" : "#/components/schemas/MetadataConnection" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelines" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "Amundsen", "MetadataES", "OpenMetadata", "Atlas", "Alation", "AlationSink" ] }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testConnectionResult" : { "$ref" : "#/components/schemas/TestConnectionResult" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "MetadataServiceList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "Metric" : { "required" : [ "id", "name" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "granularity" : { "type" : "string", "enum" : [ "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "metricExpression" : { "$ref" : "#/components/schemas/MetricExpression" }, "metricType" : { "type" : "string", "enum" : [ "COUNT", "SUM", "AVERAGE", "RATIO", "PERCENTAGE", "MIN", "MAX", "MEDIAN", "MODE", "STANDARD_DEVIATION", "VARIANCE", "OTHER" ] }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "relatedMetrics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "unitOfMeasurement" : { "type" : "string", "enum" : [ "COUNT", "DOLLARS", "PERCENTAGE", "TIMESTAMP", "SIZE", "REQUESTS", "EVENTS", "TRANSACTIONS" ] }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "MetricExpression" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "language" : { "type" : "string", "enum" : [ "SQL", "Java", "JavaScript", "Python", "External" ] } } }, "MetricsList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Metric" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "MlFeature" : { "type" : "object", "properties" : { "dataType" : { "type" : "string", "enum" : [ "numerical", "categorical" ] }, "description" : { "type" : "string" }, "featureAlgorithm" : { "type" : "string" }, "featureSources" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MlFeatureSource" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "MlFeatureSource" : { "type" : "object", "properties" : { "dataSource" : { "$ref" : "#/components/schemas/EntityReference" }, "dataType" : { "type" : "string", "enum" : [ "integer", "number", "string", "array", "date", "timestamp", "object", "boolean" ] }, "description" : { "type" : "string" }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "MlHyperParameter" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "name" : { "type" : "string" }, "value" : { "type" : "string" } } }, "MlModel" : { "required" : [ "algorithm", "id", "name", "service" ], "type" : "object", "properties" : { "algorithm" : { "type" : "string" }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dashboard" : { "$ref" : "#/components/schemas/EntityReference" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "mlFeatures" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MlFeature" } }, "mlHyperParameters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MlHyperParameter" } }, "mlStore" : { "$ref" : "#/components/schemas/MlStore" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "server" : { "type" : "string", "format" : "uri" }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "Mlflow", "Sklearn", "CustomMlModel", "SageMaker", "VertexAI" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "target" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "usageSummary" : { "$ref" : "#/components/schemas/UsageDetails" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "MlModelConnection" : { "type" : "object", "properties" : { "config" : { "type" : "object" } } }, "MlModelList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MlModel" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "MlModelService" : { "required" : [ "id", "name", "serviceType" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "connection" : { "$ref" : "#/components/schemas/MlModelConnection" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelines" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "Mlflow", "Sklearn", "CustomMlModel", "SageMaker", "VertexAI" ] }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testConnectionResult" : { "$ref" : "#/components/schemas/TestConnectionResult" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "MlModelServiceList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MlModelService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "MlStore" : { "type" : "object", "properties" : { "imageRepository" : { "type" : "string" }, "storage" : { "type" : "string" } } }, "NestedIdentity" : { "type" : "object", "properties" : { "child" : { "$ref" : "#/components/schemas/NestedIdentity" }, "field" : { "$ref" : "#/components/schemas/Text" }, "fragment" : { "type" : "boolean" }, "offset" : { "type" : "integer", "format" : "int32" } } }, "OpenMetadataConnection" : { "required" : [ "hostPort" ], "type" : "object", "properties" : { "apiVersion" : { "type" : "string" }, "authProvider" : { "type" : "string", "enum" : [ "basic", "azure", "google", "okta", "auth0", "aws-cognito", "custom-oidc", "ldap", "saml", "openmetadata" ] }, "clusterName" : { "type" : "string" }, "elasticsSearch" : { "$ref" : "#/components/schemas/ElasticsSearch" }, "enableVersionValidation" : { "type" : "boolean" }, "extraHeaders" : { "$ref" : "#/components/schemas/ExtraHeaders" }, "forceEntityOverwriting" : { "type" : "boolean" }, "hostPort" : { "type" : "string" }, "includeDashboards" : { "type" : "boolean" }, "includeDatabaseServices" : { "type" : "boolean" }, "includeGlossaryTerms" : { "type" : "boolean" }, "includeMessagingServices" : { "type" : "boolean" }, "includeMlModels" : { "type" : "boolean" }, "includePipelineServices" : { "type" : "boolean" }, "includePipelines" : { "type" : "boolean" }, "includePolicy" : { "type" : "boolean" }, "includeTables" : { "type" : "boolean" }, "includeTags" : { "type" : "boolean" }, "includeTeams" : { "type" : "boolean" }, "includeTopics" : { "type" : "boolean" }, "includeUsers" : { "type" : "boolean" }, "limitRecords" : { "type" : "integer", "format" : "int32" }, "secretsManagerLoader" : { "type" : "string", "enum" : [ "noop", "airflow", "env" ] }, "secretsManagerProvider" : { "type" : "string", "enum" : [ "db", "managed-aws", "aws", "managed-aws-ssm", "aws-ssm", "managed-azure-kv", "azure-kv", "in-memory", "gcp" ] }, "securityConfig" : { "$ref" : "#/components/schemas/OpenMetadataJWTClientConfig" }, "sslConfig" : { "type" : "object" }, "storeServiceConnection" : { "type" : "boolean" }, "supportsDataInsightExtraction" : { "type" : "boolean" }, "supportsElasticSearchReindexingExtraction" : { "type" : "boolean" }, "type" : { "type" : "string", "enum" : [ "OpenMetadata" ] }, "verifySSL" : { "type" : "string", "enum" : [ "no-ssl", "ignore", "validate" ] } } }, "OpenMetadataJWTClientConfig" : { "required" : [ "jwtToken" ], "type" : "object", "properties" : { "jwtToken" : { "type" : "string" } } }, "OpenMetadataServerVersion" : { "type" : "object", "properties" : { "revision" : { "type" : "string" }, "timestamp" : { "type" : "integer", "format" : "int64" }, "version" : { "type" : "string" } } }, "Paging" : { "required" : [ "total" ], "type" : "object", "properties" : { "after" : { "type" : "string" }, "before" : { "type" : "string" }, "limit" : { "type" : "integer", "format" : "int32" }, "offset" : { "type" : "integer", "format" : "int32" }, "total" : { "type" : "integer", "format" : "int32" } } }, "ParamAdditionalContext" : { "type" : "object", "properties" : { "data" : { "type" : "object" } } }, "PartitionColumnDetails" : { "type" : "object", "properties" : { "columnName" : { "type" : "string" }, "interval" : { "type" : "string" }, "intervalType" : { "type" : "string", "enum" : [ "TIME-UNIT", "INTEGER-RANGE", "INGESTION-TIME", "COLUMN-VALUE", "INJECTED", "ENUM", "OTHER" ] } } }, "PartitionProfilerConfig" : { "type" : "object", "properties" : { "enablePartitioning" : { "type" : "boolean" }, "partitionColumnName" : { "type" : "string" }, "partitionIntegerRangeEnd" : { "type" : "integer", "format" : "int32" }, "partitionIntegerRangeStart" : { "type" : "integer", "format" : "int32" }, "partitionInterval" : { "type" : "integer", "format" : "int32" }, "partitionIntervalType" : { "type" : "string", "enum" : [ "TIME-UNIT", "INTEGER-RANGE", "INGESTION-TIME", "COLUMN-VALUE", "INJECTED", "ENUM", "OTHER" ] }, "partitionIntervalUnit" : { "type" : "string", "enum" : [ "YEAR", "MONTH", "DAY", "HOUR" ] }, "partitionValues" : { "type" : "array", "items" : { "type" : "object" } } } }, "PasswordResetRequest" : { "required" : [ "username" ], "type" : "object", "properties" : { "confirmPassword" : { "maxLength" : 56, "minLength" : 8, "type" : "string" }, "password" : { "maxLength" : 56, "minLength" : 8, "type" : "string" }, "token" : { "type" : "string" }, "username" : { "type" : "string" } } }, "Permission" : { "type" : "object", "properties" : { "access" : { "type" : "string", "enum" : [ "deny", "allow", "conditionalDeny", "conditionalAllow", "notAllow" ] }, "operation" : { "type" : "string", "enum" : [ "All", "Create", "CreateIngestionPipelineAutomator", "Delete", "ViewAll", "ViewBasic", "ViewUsage", "ViewTests", "ViewQueries", "ViewDataProfile", "ViewProfilerGlobalConfiguration", "ViewSampleData", "ViewTestCaseFailedRowsSample", "EditAll", "EditCustomFields", "EditDataProfile", "EditDescription", "EditDisplayName", "EditLineage", "EditEntityRelationship", "EditPolicy", "EditOwners", "EditQueries", "EditReviewers", "EditRole", "EditSampleData", "EditStatus", "EditTags", "EditGlossaryTerms", "EditTeams", "EditTier", "EditTests", "EditUsage", "EditUsers", "EditLifeCycle", "EditKnowledgePanel", "EditPage", "EditIngestionPipelineStatus", "DeleteTestCaseFailedRowsSample", "Deploy", "Trigger", "Kill", "GenerateToken" ] }, "policy" : { "type" : "string" }, "role" : { "type" : "string" }, "rule" : { "$ref" : "#/components/schemas/Rule" } } }, "Persona" : { "required" : [ "id", "name" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "users" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "PersonaList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Persona" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "PersonalAccessToken" : { "required" : [ "expiryDate", "token", "userId" ], "type" : "object", "properties" : { "expiryDate" : { "type" : "integer", "format" : "int64" }, "jwtToken" : { "type" : "string" }, "token" : { "type" : "string", "format" : "uuid" }, "tokenName" : { "type" : "string" }, "tokenType" : { "type" : "string", "enum" : [ "REFRESH_TOKEN", "EMAIL_VERIFICATION", "PASSWORD_RESET", "PERSONAL_ACCESS_TOKEN" ] }, "userId" : { "type" : "string", "format" : "uuid" } } }, "PersonalAccessTokenList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PersonalAccessToken" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "Pipeline" : { "required" : [ "id", "name", "service" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "concurrency" : { "type" : "integer", "format" : "int32" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelineLocation" : { "type" : "string" }, "pipelineStatus" : { "$ref" : "#/components/schemas/PipelineStatus" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "scheduleInterval" : { "type" : "string" }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "Airflow", "GluePipeline", "Airbyte", "Fivetran", "Flink", "Dagster", "Nifi", "DomoPipeline", "CustomPipeline", "DatabricksPipeline", "Spline", "Spark", "OpenLineage", "KafkaConnect", "DBTCloud", "Matillion", "Stitch", "DataFactory" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "startDate" : { "type" : "string", "format" : "date-time" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "tasks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Task" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "PipelineConnection" : { "type" : "object", "properties" : { "config" : { "type" : "object" } } }, "PipelineList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Pipeline" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "PipelineService" : { "required" : [ "id", "name", "serviceType" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "connection" : { "$ref" : "#/components/schemas/PipelineConnection" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelines" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "Airflow", "GluePipeline", "Airbyte", "Fivetran", "Flink", "Dagster", "Nifi", "DomoPipeline", "CustomPipeline", "DatabricksPipeline", "Spline", "Spark", "OpenLineage", "KafkaConnect", "DBTCloud", "Matillion", "Stitch", "DataFactory" ] }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testConnectionResult" : { "$ref" : "#/components/schemas/TestConnectionResult" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "PipelineServiceClientResponse" : { "required" : [ "code", "platform" ], "type" : "object", "properties" : { "code" : { "type" : "integer", "format" : "int32" }, "platform" : { "type" : "string" }, "reason" : { "type" : "string" }, "version" : { "type" : "string" } } }, "PipelineServiceList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PipelineService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "PipelineStatus" : { "type" : "object", "properties" : { "config" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "endDate" : { "type" : "integer", "format" : "int64" }, "pipelineState" : { "type" : "string", "enum" : [ "queued", "success", "failed", "running", "partialSuccess" ] }, "runId" : { "type" : "string" }, "startDate" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StepSummary" } }, "timestamp" : { "type" : "integer", "format" : "int64" } } }, "PipelineStatusList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PipelineStatus" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "Policy" : { "required" : [ "id", "name", "rules" ], "type" : "object", "properties" : { "allowDelete" : { "type" : "boolean" }, "allowEdit" : { "type" : "boolean" }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "disabled" : { "type" : "boolean" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "enabled" : { "type" : "boolean" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "location" : { "$ref" : "#/components/schemas/EntityReference" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "roles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "rules" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Rule" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "teams" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "PolicyList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Policy" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "Post" : { "required" : [ "from", "id", "message" ], "type" : "object", "properties" : { "from" : { "type" : "string" }, "id" : { "type" : "string", "format" : "uuid" }, "message" : { "type" : "string" }, "postTs" : { "type" : "integer", "format" : "int64" }, "reactions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Reaction" } } } }, "PostList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Post" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "Profile" : { "type" : "object", "properties" : { "images" : { "$ref" : "#/components/schemas/ImageList" }, "subscription" : { "$ref" : "#/components/schemas/SubscriptionConfig" } } }, "ProfileResult" : { "type" : "object", "properties" : { "debugInfo" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "fragment" : { "type" : "boolean" }, "luceneDescription" : { "type" : "string" }, "profiledChildren" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProfileResult" } }, "queryName" : { "type" : "string" }, "time" : { "type" : "integer", "format" : "int64" }, "timeBreakdown" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int64" } } } }, "PutResponseListSuggestion" : { "type" : "object", "properties" : { "changeType" : { "type" : "string", "enum" : [ "entityCreated", "entityUpdated", "entityFieldsChanged", "entityNoChange", "entitySoftDeleted", "entityDeleted", "entityRestored", "threadCreated", "threadUpdated", "postCreated", "postUpdated", "taskResolved", "taskClosed", "logicalTestCaseAdded", "suggestionCreated", "suggestionUpdated", "suggestionAccepted", "suggestionRejected", "suggestionDeleted" ] }, "entity" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Suggestion" } }, "status" : { "type" : "string", "enum" : [ "OK", "Created", "Accepted", "No Content", "Reset Content", "Partial Content", "Moved Permanently", "Found", "See Other", "Not Modified", "Use Proxy", "Temporary Redirect", "Bad Request", "Unauthorized", "Payment Required", "Forbidden", "Not Found", "Method Not Allowed", "Not Acceptable", "Proxy Authentication Required", "Request Timeout", "Conflict", "Gone", "Length Required", "Precondition Failed", "Request Entity Too Large", "Request-URI Too Long", "Unsupported Media Type", "Requested Range Not Satisfiable", "Expectation Failed", "Precondition Required", "Too Many Requests", "Request Header Fields Too Large", "Internal Server Error", "Not Implemented", "Bad Gateway", "Service Unavailable", "Gateway Timeout", "HTTP Version Not Supported", "Network Authentication Required" ] } } }, "Query" : { "required" : [ "id", "name", "query", "service" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "checksum" : { "type" : "string" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "duration" : { "type" : "number", "format" : "double" }, "exclude_usage" : { "type" : "boolean" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "processedLineage" : { "type" : "boolean" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "query" : { "type" : "string" }, "queryDate" : { "type" : "integer", "format" : "int64" }, "queryUsedIn" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "query_type" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "triggeredBy" : { "$ref" : "#/components/schemas/EntityReference" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "usedBy" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "users" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "QueryList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Query" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "QueryProfileShardResult" : { "type" : "object", "properties" : { "collectorResult" : { "$ref" : "#/components/schemas/CollectorResult" }, "fragment" : { "type" : "boolean" }, "queryResults" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProfileResult" } }, "rewriteTime" : { "type" : "integer", "format" : "int64" } } }, "Reaction" : { "required" : [ "reactionType", "user" ], "type" : "object", "properties" : { "reactionType" : { "type" : "string", "enum" : [ "thumbsUp", "thumbsDown", "hooray", "laugh", "confused", "heart", "rocket", "eyes" ] }, "user" : { "$ref" : "#/components/schemas/EntityReference" } } }, "RegistrationRequest" : { "required" : [ "email", "firstName", "lastName", "password" ], "type" : "object", "properties" : { "email" : { "maxLength" : 127, "minLength" : 6, "pattern" : "^[\\S.!#$%&’*+/=?^_`{|}~-]+@\\S+\\.\\S+$", "type" : "string" }, "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "password" : { "maxLength" : 56, "minLength" : 8, "type" : "string" } } }, "Report" : { "required" : [ "id", "name", "service" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "usageSummary" : { "$ref" : "#/components/schemas/UsageDetails" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "ReportList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Report" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResolveTask" : { "required" : [ "newValue" ], "type" : "object", "properties" : { "newValue" : { "type" : "string" }, "testCaseFQN" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "testCaseFailureReason" : { "type" : "string", "enum" : [ "FalsePositive", "MissingData", "Duplicates", "OutOfBounds", "Other" ] } } }, "ResourceDescriptor" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "operations" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "All", "Create", "CreateIngestionPipelineAutomator", "Delete", "ViewAll", "ViewBasic", "ViewUsage", "ViewTests", "ViewQueries", "ViewDataProfile", "ViewProfilerGlobalConfiguration", "ViewSampleData", "ViewTestCaseFailedRowsSample", "EditAll", "EditCustomFields", "EditDataProfile", "EditDescription", "EditDisplayName", "EditLineage", "EditEntityRelationship", "EditPolicy", "EditOwners", "EditQueries", "EditReviewers", "EditRole", "EditSampleData", "EditStatus", "EditTags", "EditGlossaryTerms", "EditTeams", "EditTier", "EditTests", "EditUsage", "EditUsers", "EditLifeCycle", "EditKnowledgePanel", "EditPage", "EditIngestionPipelineStatus", "DeleteTestCaseFailedRowsSample", "Deploy", "Trigger", "Kill", "GenerateToken" ] } } } }, "ResourcePermission" : { "required" : [ "permissions", "resource" ], "type" : "object", "properties" : { "permissions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Permission" } }, "resource" : { "type" : "string" } } }, "ResourcePermissionList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourcePermission" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "RestoreEntity" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" } } }, "ResultListAPICollection" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/APICollection" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListAPIEndpoint" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/APIEndpoint" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListApiService" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListApp" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/App" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListAppMarketPlaceDefinition" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AppMarketPlaceDefinition" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListAppRunRecord" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AppRunRecord" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListBot" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Bot" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListChangeEvent" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ChangeEvent" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListChart" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Chart" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListClassification" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Classification" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListColumnProfile" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ColumnProfile" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListContainer" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Container" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListDashboard" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Dashboard" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListDashboardDataModel" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DashboardDataModel" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListDashboardService" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DashboardService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListDataProduct" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DataProduct" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListDatabase" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Database" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListDatabaseSchema" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DatabaseSchema" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListDatabaseService" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DatabaseService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListDocument" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Document" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListDomain" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Domain" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListEntityHierarchy" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityHierarchy" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListEventSubscription" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventSubscription" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListFilterResourceDescriptor" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FilterResourceDescriptor" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListFunction" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Function" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListGlossary" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Glossary" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListGlossaryTerm" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GlossaryTerm" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListIngestionPipeline" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IngestionPipeline" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListMessagingService" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MessagingService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListMetadataService" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListMetric" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Metric" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListMlModel" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MlModel" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListMlModelService" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MlModelService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListPersona" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Persona" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListPipeline" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Pipeline" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListPipelineService" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PipelineService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListPipelineStatus" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PipelineStatus" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListPolicy" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Policy" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListPost" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Post" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListQuery" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Query" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListReport" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Report" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListResourceDescriptor" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceDescriptor" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListResourcePermission" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourcePermission" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListRole" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Role" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListSearchIndex" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchIndex" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListSearchService" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListStorageService" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StorageService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListStoredProcedure" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StoredProcedure" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListSuggestion" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Suggestion" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListSystemProfile" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SystemProfile" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListTable" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Table" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListTag" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Tag" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListTeam" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Team" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListTeamHierarchy" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TeamHierarchy" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListTestCase" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestCase" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListTestCaseResolutionStatus" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestCaseResolutionStatus" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListTestCaseResult" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestCaseResult" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListTestDefinition" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestDefinition" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListTestSuite" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestSuite" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListThread" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Thread" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListThreadCount" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ThreadCount" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListTopic" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Topic" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListType" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Type" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListUser" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/User" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListWorkflowDefinition" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WorkflowDefinition" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListWorkflowInstance" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WorkflowInstance" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultListWorkflowInstanceState" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WorkflowInstanceState" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ResultSummary" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "Success", "Failed", "Aborted", "Queued" ] }, "testCaseName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "timestamp" : { "type" : "integer", "format" : "int64" } } }, "RevokePersonalTokenRequest" : { "type" : "object", "properties" : { "tokenIds" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } } } }, "RevokeTokenRequest" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" } } }, "Role" : { "required" : [ "id", "name" ], "type" : "object", "properties" : { "allowDelete" : { "type" : "boolean" }, "allowEdit" : { "type" : "boolean" }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "disabled" : { "type" : "boolean" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "policies" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "teams" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "users" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "RoleList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Role" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "Rule" : { "required" : [ "effect", "name", "operations", "resources" ], "type" : "object", "properties" : { "condition" : { "type" : "string" }, "description" : { "type" : "string" }, "effect" : { "type" : "string", "enum" : [ "allow", "deny" ] }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "name" : { "type" : "string" }, "operations" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "All", "Create", "CreateIngestionPipelineAutomator", "Delete", "ViewAll", "ViewBasic", "ViewUsage", "ViewTests", "ViewQueries", "ViewDataProfile", "ViewProfilerGlobalConfiguration", "ViewSampleData", "ViewTestCaseFailedRowsSample", "EditAll", "EditCustomFields", "EditDataProfile", "EditDescription", "EditDisplayName", "EditLineage", "EditEntityRelationship", "EditPolicy", "EditOwners", "EditQueries", "EditReviewers", "EditRole", "EditSampleData", "EditStatus", "EditTags", "EditGlossaryTerms", "EditTeams", "EditTier", "EditTests", "EditUsage", "EditUsers", "EditLifeCycle", "EditKnowledgePanel", "EditPage", "EditIngestionPipelineStatus", "DeleteTestCaseFailedRowsSample", "Deploy", "Trigger", "Kill", "GenerateToken" ] } }, "resources" : { "type" : "array", "items" : { "type" : "string" } } } }, "SampleDataStorageConfig" : { "type" : "object", "properties" : { "config" : { "type" : "object" } } }, "SearchConnection" : { "type" : "object", "properties" : { "config" : { "type" : "object" } } }, "SearchHit" : { "type" : "object", "properties" : { "clusterAlias" : { "type" : "string" }, "documentFields" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DocumentField" } }, "explanation" : { "$ref" : "#/components/schemas/Explanation" }, "fields" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DocumentField" } }, "fragment" : { "type" : "boolean" }, "highlightFields" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/HighlightField" } }, "id" : { "type" : "string" }, "index" : { "type" : "string" }, "innerHits" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/SearchHits" } }, "matchedQueries" : { "type" : "array", "items" : { "type" : "string" } }, "metadataFields" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DocumentField" } }, "nestedIdentity" : { "$ref" : "#/components/schemas/NestedIdentity" }, "primaryTerm" : { "type" : "integer", "format" : "int64" }, "rawSortValues" : { "type" : "array", "items" : { "type" : "object" } }, "score" : { "type" : "number", "format" : "float" }, "seqNo" : { "type" : "integer", "format" : "int64" }, "shard" : { "$ref" : "#/components/schemas/SearchShardTarget" }, "sortValues" : { "type" : "array", "items" : { "type" : "object" } }, "sourceAsMap" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "sourceAsString" : { "type" : "string" }, "sourceRef" : { "$ref" : "#/components/schemas/BytesReference" }, "type" : { "type" : "string" }, "version" : { "type" : "integer", "format" : "int64" } } }, "SearchHits" : { "type" : "object", "properties" : { "collapseField" : { "type" : "string" }, "collapseValues" : { "type" : "array", "items" : { "type" : "object" } }, "fragment" : { "type" : "boolean" }, "hits" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchHit" } }, "maxScore" : { "type" : "number", "format" : "float" }, "sortFields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortField" } }, "totalHits" : { "$ref" : "#/components/schemas/TotalHits" } } }, "SearchIndex" : { "required" : [ "fields", "id", "name", "service" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "fields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchIndexField" } }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "indexType" : { "type" : "string", "enum" : [ "Index", "IndexTemplate" ] }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "sampleData" : { "$ref" : "#/components/schemas/SearchIndexSampleData" }, "searchIndexSettings" : { "$ref" : "#/components/schemas/SearchIndexSettings" }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "ElasticSearch", "OpenSearch", "CustomSearch" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "SearchIndexField" : { "required" : [ "dataType", "name" ], "type" : "object", "properties" : { "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchIndexField" } }, "dataType" : { "type" : "string", "enum" : [ "NUMBER", "TEXT", "BINARY", "TIMESTAMP", "TIMESTAMPZ", "TIME", "DATE", "DATETIME", "KEYWORD", "ARRAY", "OBJECT", "FLATTENED", "NESTED", "JOIN", "RANGE", "IP", "VERSION", "MURMUR3", "AGGREGATE_METRIC_DOUBLE", "HISTOGRAM", "ANNOTATED-TEXT", "COMPLETION", "SEARCH_AS_YOU_TYPE", "DENSE_VECTOR", "RANK_FEATURE", "RANK_FEATURES", "GEO_POINT", "GEO_SHAPE", "POINT", "SHAPE", "PERCOLATOR", "BOOLEAN", "CONSTANT_KEYWORD", "WILDCARD", "LONG", "INTEGER", "SHORT", "BYTE", "DOUBLE", "FLOAT", "HALF_FLOAT", "SCALED_FLOAT", "UNSIGNED_LONG", "UNKNOWN" ] }, "dataTypeDisplay" : { "type" : "string" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } } } }, "SearchIndexList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchIndex" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "SearchIndexSampleData" : { "type" : "object", "properties" : { "messages" : { "type" : "array", "items" : { "type" : "string" } } } }, "SearchIndexSettings" : { "type" : "object" }, "SearchProfileQueryPhaseResult" : { "type" : "object", "properties" : { "aggregationProfileResults" : { "$ref" : "#/components/schemas/AggregationProfileShardResult" }, "queryProfileResults" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/QueryProfileShardResult" } } } }, "SearchProfileShardResult" : { "type" : "object", "properties" : { "aggregationProfileResults" : { "$ref" : "#/components/schemas/AggregationProfileShardResult" }, "fetchPhase" : { "$ref" : "#/components/schemas/ProfileResult" }, "fragment" : { "type" : "boolean" }, "queryPhase" : { "$ref" : "#/components/schemas/SearchProfileQueryPhaseResult" }, "queryProfileResults" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/QueryProfileShardResult" } } } }, "SearchResponse" : { "type" : "object", "properties" : { "aggregations" : { "$ref" : "#/components/schemas/Aggregations" }, "clusters" : { "$ref" : "#/components/schemas/Clusters" }, "failedShards" : { "type" : "integer", "format" : "int32" }, "fragment" : { "type" : "boolean" }, "hits" : { "$ref" : "#/components/schemas/SearchHits" }, "internalResponse" : { "$ref" : "#/components/schemas/SearchResponseSections" }, "numReducePhases" : { "type" : "integer", "format" : "int32" }, "profileResults" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/SearchProfileShardResult" } }, "scrollId" : { "type" : "string" }, "shardFailures" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShardSearchFailure" } }, "skippedShards" : { "type" : "integer", "format" : "int32" }, "successfulShards" : { "type" : "integer", "format" : "int32" }, "suggest" : { "$ref" : "#/components/schemas/Suggest" }, "terminatedEarly" : { "type" : "boolean" }, "timedOut" : { "type" : "boolean" }, "took" : { "$ref" : "#/components/schemas/TimeValue" }, "totalShards" : { "type" : "integer", "format" : "int32" } } }, "SearchResponseSections" : { "type" : "object", "properties" : { "fragment" : { "type" : "boolean" }, "numReducePhases" : { "type" : "integer", "format" : "int32" } } }, "SearchService" : { "required" : [ "id", "name", "serviceType" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "connection" : { "$ref" : "#/components/schemas/SearchConnection" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelines" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "ElasticSearch", "OpenSearch", "CustomSearch" ] }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testConnectionResult" : { "$ref" : "#/components/schemas/TestConnectionResult" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "SearchServiceList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "SearchShardTarget" : { "type" : "object", "properties" : { "clusterAlias" : { "type" : "string" }, "fullyQualifiedIndexName" : { "type" : "string" }, "index" : { "type" : "string" }, "nodeId" : { "type" : "string" }, "nodeIdText" : { "$ref" : "#/components/schemas/Text" }, "shardId" : { "$ref" : "#/components/schemas/ShardId" } } }, "ShardId" : { "type" : "object", "properties" : { "fragment" : { "type" : "boolean" }, "id" : { "type" : "integer", "format" : "int32" }, "index" : { "$ref" : "#/components/schemas/Index" }, "indexName" : { "type" : "string" } } }, "ShardSearchFailure" : { "type" : "object", "properties" : { "cause" : { "type" : "object", "properties" : { "localizedMessage" : { "type" : "string" }, "message" : { "type" : "string" }, "stackTrace" : { "type" : "array", "items" : { "type" : "object", "properties" : { "classLoaderName" : { "type" : "string" }, "moduleName" : { "type" : "string" }, "moduleVersion" : { "type" : "string" }, "methodName" : { "type" : "string" }, "fileName" : { "type" : "string" }, "lineNumber" : { "type" : "integer", "format" : "int32" }, "nativeMethod" : { "type" : "boolean" }, "className" : { "type" : "string" } } } }, "suppressed" : { "type" : "array", "items" : { "type" : "object", "properties" : { "stackTrace" : { "type" : "array", "items" : { "type" : "object", "properties" : { "classLoaderName" : { "type" : "string" }, "moduleName" : { "type" : "string" }, "moduleVersion" : { "type" : "string" }, "methodName" : { "type" : "string" }, "fileName" : { "type" : "string" }, "lineNumber" : { "type" : "integer", "format" : "int32" }, "nativeMethod" : { "type" : "boolean" }, "className" : { "type" : "string" } } } }, "message" : { "type" : "string" }, "localizedMessage" : { "type" : "string" } } } } } }, "fragment" : { "type" : "boolean" }, "localizedMessage" : { "type" : "string" }, "message" : { "type" : "string" }, "stackTrace" : { "type" : "array", "items" : { "type" : "object", "properties" : { "classLoaderName" : { "type" : "string" }, "moduleName" : { "type" : "string" }, "moduleVersion" : { "type" : "string" }, "methodName" : { "type" : "string" }, "fileName" : { "type" : "string" }, "lineNumber" : { "type" : "integer", "format" : "int32" }, "nativeMethod" : { "type" : "boolean" }, "className" : { "type" : "string" } } } }, "suppressed" : { "type" : "array", "items" : { "type" : "object", "properties" : { "stackTrace" : { "type" : "array", "items" : { "type" : "object", "properties" : { "classLoaderName" : { "type" : "string" }, "moduleName" : { "type" : "string" }, "moduleVersion" : { "type" : "string" }, "methodName" : { "type" : "string" }, "fileName" : { "type" : "string" }, "lineNumber" : { "type" : "integer", "format" : "int32" }, "nativeMethod" : { "type" : "boolean" }, "className" : { "type" : "string" } } } }, "message" : { "type" : "string" }, "localizedMessage" : { "type" : "string" } } } } } }, "SortField" : { "type" : "object", "properties" : { "bytesComparator" : { "type" : "object" }, "canUsePoints" : { "type" : "boolean" }, "comparatorSource" : { "$ref" : "#/components/schemas/FieldComparatorSource" }, "field" : { "type" : "string" }, "indexSorter" : { "$ref" : "#/components/schemas/IndexSorter" }, "missingValue" : { "type" : "object" }, "reverse" : { "type" : "boolean" }, "type" : { "type" : "string", "enum" : [ "SCORE", "DOC", "STRING", "INT", "FLOAT", "LONG", "DOUBLE", "CUSTOM", "STRING_VAL", "REWRITEABLE" ] } } }, "SourceConfig" : { "type" : "object", "properties" : { "config" : { "type" : "object" } } }, "StackTraceError" : { "required" : [ "error", "name" ], "type" : "object", "properties" : { "error" : { "type" : "string" }, "name" : { "type" : "string" }, "stackTrace" : { "type" : "string" } } }, "Stage" : { "type" : "object", "properties" : { "endedAt" : { "type" : "integer", "format" : "int64" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "startedAt" : { "type" : "integer", "format" : "int64" }, "tasks" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } }, "variables" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "Status" : { "required" : [ "executionStatus", "name" ], "type" : "object", "properties" : { "endTime" : { "type" : "integer", "format" : "int64" }, "executionStatus" : { "type" : "string", "enum" : [ "Successful", "Failed", "Pending", "Skipped" ] }, "logLink" : { "type" : "string", "format" : "uri" }, "name" : { "type" : "string" }, "startTime" : { "type" : "integer", "format" : "int64" } } }, "StepSummary" : { "required" : [ "name" ], "type" : "object", "properties" : { "errors" : { "type" : "integer", "format" : "int32" }, "failures" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StackTraceError" } }, "filtered" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "records" : { "type" : "integer", "format" : "int32" }, "updated_records" : { "type" : "integer", "format" : "int32" }, "warnings" : { "type" : "integer", "format" : "int32" } } }, "StorageConnection" : { "type" : "object", "properties" : { "config" : { "type" : "object" } } }, "StorageService" : { "required" : [ "id", "name", "serviceType" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "connection" : { "$ref" : "#/components/schemas/StorageConnection" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelines" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "S3", "ADLS", "GCS", "CustomStorage" ] }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testConnectionResult" : { "$ref" : "#/components/schemas/TestConnectionResult" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "StorageServiceList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StorageService" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "StoredProcedure" : { "required" : [ "id", "name", "storedProcedureCode" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "code" : { "type" : "string" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "database" : { "$ref" : "#/components/schemas/EntityReference" }, "databaseSchema" : { "$ref" : "#/components/schemas/EntityReference" }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "BigQuery", "BigTable", "Mysql", "Redshift", "Snowflake", "Postgres", "Mssql", "Oracle", "Athena", "Hive", "Impala", "Presto", "Trino", "Vertica", "Glue", "MariaDB", "Druid", "Db2", "Clickhouse", "Databricks", "AzureSQL", "DynamoDB", "SingleStore", "SQLite", "DeltaLake", "Salesforce", "PinotDB", "Datalake", "DomoDatabase", "QueryLog", "CustomDatabase", "Dbt", "SapHana", "MongoDB", "Couchbase", "Greenplum", "Doris", "UnityCatalog", "SAS", "Iceberg", "Teradata", "SapErp", "Synapse", "Exasol" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "storedProcedureCode" : { "$ref" : "#/components/schemas/StoredProcedureCode" }, "storedProcedureType" : { "type" : "string", "enum" : [ "StoredProcedure", "UDF" ] }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "StoredProcedureCode" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "language" : { "type" : "string", "enum" : [ "SQL", "Java", "JavaScript", "Python", "External" ] } } }, "StoredProcedureList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StoredProcedure" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "Style" : { "type" : "object", "properties" : { "color" : { "type" : "string" }, "iconURL" : { "type" : "string" } } }, "SubscriptionConfig" : { "type" : "object", "properties" : { "gChat" : { "$ref" : "#/components/schemas/Webhook" }, "generic" : { "$ref" : "#/components/schemas/Webhook" }, "msTeams" : { "$ref" : "#/components/schemas/Webhook" }, "slack" : { "$ref" : "#/components/schemas/Webhook" } } }, "SubscriptionDestination" : { "required" : [ "category", "type" ], "type" : "object", "properties" : { "category" : { "type" : "string", "enum" : [ "Users", "Teams", "Admins", "Assignees", "Owners", "Mentions", "Followers", "External" ] }, "config" : { "type" : "object" }, "enabled" : { "type" : "boolean" }, "id" : { "type" : "string", "format" : "uuid" }, "readTimeout" : { "type" : "integer", "format" : "int32" }, "statusDetails" : { "type" : "object" }, "timeout" : { "type" : "integer", "format" : "int32" }, "type" : { "type" : "string", "enum" : [ "Webhook", "Slack", "MsTeams", "GChat", "Email", "ActivityFeed", "GovernanceWorkflowChangeEvent" ] } } }, "SubscriptionStatus" : { "type" : "object", "properties" : { "lastFailedAt" : { "type" : "integer", "format" : "int64" }, "lastFailedReason" : { "type" : "string" }, "lastFailedStatusCode" : { "type" : "integer", "format" : "int32" }, "lastSuccessfulAt" : { "type" : "integer", "format" : "int64" }, "nextAttempt" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "string", "enum" : [ "disabled", "failed", "retryLimitReached", "awaitingRetry", "active" ] }, "timestamp" : { "type" : "integer", "format" : "int64" } } }, "SuccessContext" : { "type" : "object" }, "Suggest" : { "type" : "object", "properties" : { "fragment" : { "type" : "boolean" } } }, "Suggestion" : { "type" : "object", "properties" : { "createdAt" : { "type" : "integer", "format" : "int64" }, "createdBy" : { "$ref" : "#/components/schemas/EntityReference" }, "description" : { "type" : "string" }, "entityLink" : { "pattern" : "(?U)^<#E::\\w+::(?:[^:<>|]|:[^:<>|])+(?:::(?:[^:<>|]|:[^:<>|])+)*>$", "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "status" : { "type" : "string", "enum" : [ "Open", "Accepted", "Rejected" ] }, "tagLabels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "type" : { "type" : "string", "enum" : [ "SuggestDescription", "SuggestTagLabel" ] }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" } } }, "SuggestionList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Suggestion" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "SystemProfile" : { "type" : "object", "properties" : { "operation" : { "type" : "string", "enum" : [ "UPDATE", "INSERT", "DELETE" ] }, "rowsAffected" : { "type" : "integer", "format" : "int32" }, "timestamp" : { "type" : "integer", "format" : "int64" } } }, "SystemProfileList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SystemProfile" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "Table" : { "required" : [ "columns", "id", "name" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "columns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Column" } }, "customMetrics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CustomMetric" } }, "dataModel" : { "$ref" : "#/components/schemas/DataModel" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "database" : { "$ref" : "#/components/schemas/EntityReference" }, "databaseSchema" : { "$ref" : "#/components/schemas/EntityReference" }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "fileFormat" : { "type" : "string", "enum" : [ "csv", "tsv", "avro", "parquet", "json", "json.gz", "json.zip", "jsonl", "jsonl.gz", "jsonl.zip" ] }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "joins" : { "$ref" : "#/components/schemas/TableJoins" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "location" : { "$ref" : "#/components/schemas/EntityReference" }, "locationPath" : { "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "profile" : { "$ref" : "#/components/schemas/TableProfile" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "retentionPeriod" : { "type" : "string" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "sampleData" : { "$ref" : "#/components/schemas/TableData" }, "schemaDefinition" : { "type" : "string" }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "BigQuery", "BigTable", "Mysql", "Redshift", "Snowflake", "Postgres", "Mssql", "Oracle", "Athena", "Hive", "Impala", "Presto", "Trino", "Vertica", "Glue", "MariaDB", "Druid", "Db2", "Clickhouse", "Databricks", "AzureSQL", "DynamoDB", "SingleStore", "SQLite", "DeltaLake", "Salesforce", "PinotDB", "Datalake", "DomoDatabase", "QueryLog", "CustomDatabase", "Dbt", "SapHana", "MongoDB", "Couchbase", "Greenplum", "Doris", "UnityCatalog", "SAS", "Iceberg", "Teradata", "SapErp", "Synapse", "Exasol" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tableConstraints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TableConstraint" } }, "tablePartition" : { "$ref" : "#/components/schemas/TablePartition" }, "tableProfilerConfig" : { "$ref" : "#/components/schemas/TableProfilerConfig" }, "tableType" : { "type" : "string", "enum" : [ "Regular", "External", "Dynamic", "View", "SecureView", "MaterializedView", "Iceberg", "Local", "Partitioned", "Foreign", "Transient" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testSuite" : { "$ref" : "#/components/schemas/EntityReference" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "usageSummary" : { "$ref" : "#/components/schemas/UsageDetails" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "TableConstraint" : { "type" : "object", "properties" : { "columns" : { "type" : "array", "items" : { "type" : "string" } }, "constraintType" : { "type" : "string", "enum" : [ "UNIQUE", "PRIMARY_KEY", "FOREIGN_KEY", "SORT_KEY", "DIST_KEY", "CLUSTER_KEY" ] }, "referredColumns" : { "type" : "array", "items" : { "type" : "string" } }, "relationshipType" : { "type" : "string", "enum" : [ "ONE_TO_ONE", "ONE_TO_MANY", "MANY_TO_ONE", "MANY_TO_MANY" ] } } }, "TableData" : { "type" : "object", "properties" : { "columns" : { "type" : "array", "items" : { "type" : "string" } }, "rows" : { "type" : "array", "items" : { "type" : "array", "items" : { "type" : "object" } } } } }, "TableJoins" : { "type" : "object", "properties" : { "columnJoins" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ColumnJoin" } }, "dayCount" : { "type" : "integer", "format" : "int32" }, "directTableJoins" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JoinedWith" } }, "startDate" : { "type" : "string" } } }, "TableList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Table" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "TablePartition" : { "type" : "object", "properties" : { "columns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PartitionColumnDetails" } } } }, "TableProfile" : { "required" : [ "timestamp" ], "type" : "object", "properties" : { "columnCount" : { "type" : "number", "format" : "double" }, "createDateTime" : { "type" : "string", "format" : "date-time" }, "customMetrics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CustomMetricProfile" } }, "profileSample" : { "type" : "number", "format" : "double" }, "profileSampleType" : { "type" : "string", "enum" : [ "PERCENTAGE", "ROWS" ] }, "rowCount" : { "type" : "number", "format" : "double" }, "samplingMethodType" : { "type" : "string", "enum" : [ "BERNOULLI", "SYSTEM" ] }, "sizeInByte" : { "type" : "number", "format" : "double" }, "timestamp" : { "type" : "integer", "format" : "int64" } } }, "TableProfileList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TableProfile" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "TableProfilerConfig" : { "type" : "object", "properties" : { "computeColumnMetrics" : { "type" : "boolean" }, "computeTableMetrics" : { "type" : "boolean" }, "excludeColumns" : { "type" : "array", "items" : { "type" : "string" } }, "includeColumns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ColumnProfilerConfig" } }, "partitioning" : { "$ref" : "#/components/schemas/PartitionProfilerConfig" }, "profileQuery" : { "type" : "string" }, "profileSample" : { "type" : "number", "format" : "double" }, "profileSampleType" : { "type" : "string", "enum" : [ "PERCENTAGE", "ROWS" ] }, "sampleDataCount" : { "type" : "integer", "format" : "int32" }, "samplingMethodType" : { "type" : "string", "enum" : [ "BERNOULLI", "SYSTEM" ] } } }, "Tag" : { "required" : [ "description", "name" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "classification" : { "$ref" : "#/components/schemas/EntityReference" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "deprecated" : { "type" : "boolean" }, "description" : { "type" : "string" }, "disabled" : { "type" : "boolean" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "mutuallyExclusive" : { "type" : "boolean" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parent" : { "$ref" : "#/components/schemas/EntityReference" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "usageCount" : { "type" : "integer", "format" : "int32" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "TagLabel" : { "required" : [ "labelType", "source", "state", "tagFQN" ], "type" : "object", "properties" : { "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "labelType" : { "type" : "string", "enum" : [ "Manual", "Propagated", "Automated", "Derived" ] }, "name" : { "type" : "string" }, "source" : { "type" : "string", "enum" : [ "Classification", "Glossary" ] }, "state" : { "type" : "string", "enum" : [ "Suggested", "Confirmed" ] }, "style" : { "$ref" : "#/components/schemas/Style" }, "tagFQN" : { "type" : "string" } } }, "TagList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Tag" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "Task" : { "required" : [ "name" ], "type" : "object", "properties" : { "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "downstreamTasks" : { "type" : "array", "items" : { "type" : "string" } }, "endDate" : { "type" : "string" }, "fullyQualifiedName" : { "type" : "string" }, "name" : { "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "sourceUrl" : { "type" : "string" }, "startDate" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "taskSQL" : { "type" : "string" }, "taskType" : { "type" : "string" } } }, "TaskDetails" : { "required" : [ "assignees", "id", "type" ], "type" : "object", "properties" : { "assignees" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "closedAt" : { "type" : "integer", "format" : "int64" }, "closedBy" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int32" }, "newValue" : { "type" : "string" }, "oldValue" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "Open", "Closed" ] }, "suggestion" : { "type" : "string" }, "testCaseResolutionStatusId" : { "type" : "string", "format" : "uuid" }, "type" : { "type" : "string", "enum" : [ "RequestDescription", "UpdateDescription", "RequestTag", "UpdateTag", "RequestApproval", "RequestTestCaseFailureResolution", "Generic" ] } } }, "Team" : { "required" : [ "id", "name" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "childrenCount" : { "type" : "integer", "format" : "int32" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "defaultRoles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "domains" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "email" : { "maxLength" : 127, "minLength" : 6, "pattern" : "^[\\S.!#$%&’*+/=?^_`{|}~-]+@\\S+\\.\\S+$", "type" : "string" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "inheritedRoles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "isJoinable" : { "type" : "boolean" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "owns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "policies" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "profile" : { "$ref" : "#/components/schemas/Profile" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "teamType" : { "type" : "string", "enum" : [ "Group", "Department", "Division", "BusinessUnit", "Organization" ] }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "userCount" : { "type" : "integer", "format" : "int32" }, "users" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "TeamHierarchy" : { "required" : [ "id", "name" ], "type" : "object", "properties" : { "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TeamHierarchy" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "isJoinable" : { "type" : "boolean" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "teamType" : { "type" : "string", "enum" : [ "Group", "Department", "Division", "BusinessUnit", "Organization" ] } } }, "TeamList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Team" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "TemplateValidationResponse" : { "type" : "object", "properties" : { "additionalPlaceholder" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "isValid" : { "type" : "boolean" }, "message" : { "type" : "string" }, "missingPlaceholder" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "TermReference" : { "type" : "object", "properties" : { "endpoint" : { "type" : "string", "format" : "uri" }, "name" : { "type" : "string" } } }, "TestCase" : { "required" : [ "entityLink", "name", "testDefinition", "testSuite" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "computePassedFailedRowCount" : { "type" : "boolean" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "entityFQN" : { "type" : "string" }, "entityLink" : { "pattern" : "(?U)^<#E::\\w+::(?:[^:<>|]|:[^:<>|])+(?:::(?:[^:<>|]|:[^:<>|])+)*>$", "type" : "string" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "failedRowsSample" : { "$ref" : "#/components/schemas/TableData" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "incidentId" : { "type" : "string", "format" : "uuid" }, "inspectionQuery" : { "type" : "string" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 2147483647, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parameterValues" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestCaseParameterValue" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testCaseResult" : { "$ref" : "#/components/schemas/TestCaseResult" }, "testCaseStatus" : { "type" : "string", "enum" : [ "Success", "Failed", "Aborted", "Queued" ] }, "testDefinition" : { "$ref" : "#/components/schemas/EntityReference" }, "testSuite" : { "$ref" : "#/components/schemas/EntityReference" }, "testSuites" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestSuite" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "useDynamicAssertion" : { "type" : "boolean" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "TestCaseList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestCase" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "TestCaseParameter" : { "type" : "object", "properties" : { "dataType" : { "type" : "string", "enum" : [ "NUMBER", "INT", "FLOAT", "DOUBLE", "DECIMAL", "TIMESTAMP", "TIME", "DATE", "DATETIME", "ARRAY", "MAP", "SET", "STRING", "BOOLEAN" ] }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "name" : { "type" : "string" }, "optionValues" : { "type" : "array", "items" : { "type" : "object" } }, "required" : { "type" : "boolean" }, "validationRule" : { "$ref" : "#/components/schemas/TestCaseParameterValidationRule" } } }, "TestCaseParameterValidationRule" : { "type" : "object", "properties" : { "parameterField" : { "type" : "string" }, "rule" : { "type" : "string", "enum" : [ "EQUALS", "NOT_EQUALS", "GREATER_THAN_OR_EQUALS", "LESS_THAN_OR_EQUALS" ] } } }, "TestCaseParameterValue" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "value" : { "type" : "string" } } }, "TestCaseResolutionStatus" : { "required" : [ "testCaseResolutionStatusType" ], "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "metrics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Metric" } }, "severity" : { "type" : "string", "enum" : [ "Severity1", "Severity2", "Severity3", "Severity4", "Severity5" ] }, "stateId" : { "type" : "string", "format" : "uuid" }, "testCaseReference" : { "$ref" : "#/components/schemas/EntityReference" }, "testCaseResolutionStatusDetails" : { "type" : "object" }, "testCaseResolutionStatusType" : { "type" : "string", "enum" : [ "New", "Ack", "Assigned", "Resolved" ] }, "timestamp" : { "type" : "integer", "format" : "int64" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "$ref" : "#/components/schemas/EntityReference" } } }, "TestCaseResolutionStatusResultList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestCaseResolutionStatus" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "TestCaseResult" : { "required" : [ "timestamp" ], "type" : "object", "properties" : { "failedRows" : { "type" : "integer", "format" : "int32" }, "failedRowsPercentage" : { "type" : "number", "format" : "double" }, "id" : { "type" : "string", "format" : "uuid" }, "incidentId" : { "type" : "string", "format" : "uuid" }, "maxBound" : { "type" : "number", "format" : "double" }, "minBound" : { "type" : "number", "format" : "double" }, "passedRows" : { "type" : "integer", "format" : "int32" }, "passedRowsPercentage" : { "type" : "number", "format" : "double" }, "result" : { "type" : "string" }, "sampleData" : { "type" : "string" }, "testCase" : { "$ref" : "#/components/schemas/EntityReference" }, "testCaseFQN" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "testCaseStatus" : { "type" : "string", "enum" : [ "Success", "Failed", "Aborted", "Queued" ] }, "testDefinition" : { "$ref" : "#/components/schemas/EntityReference" }, "testResultValue" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestResultValue" } }, "timestamp" : { "type" : "integer", "format" : "int64" } } }, "TestCaseResultList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestCaseResult" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "TestConnectionResult" : { "required" : [ "steps" ], "type" : "object", "properties" : { "lastUpdatedAt" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "string", "enum" : [ "Successful", "Failed", "Running" ] }, "steps" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestConnectionStepResult" } } } }, "TestConnectionStepResult" : { "required" : [ "mandatory", "name", "passed" ], "type" : "object", "properties" : { "errorLog" : { "type" : "string" }, "mandatory" : { "type" : "boolean" }, "message" : { "type" : "string" }, "name" : { "type" : "string" }, "passed" : { "type" : "boolean" } } }, "TestDefinition" : { "required" : [ "description", "name", "testPlatforms" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataQualityDimension" : { "type" : "string", "enum" : [ "Completeness", "Accuracy", "Consistency", "Validity", "Uniqueness", "Integrity", "SQL" ] }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "entityType" : { "type" : "string", "enum" : [ "TABLE", "COLUMN" ] }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 2147483647, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "parameterDefinition" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestCaseParameter" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "supportedDataTypes" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "NUMBER", "TINYINT", "SMALLINT", "INT", "BIGINT", "BYTEINT", "BYTES", "FLOAT", "DOUBLE", "DECIMAL", "NUMERIC", "TIMESTAMP", "TIMESTAMPZ", "TIME", "DATE", "DATETIME", "INTERVAL", "STRING", "MEDIUMTEXT", "TEXT", "CHAR", "LONG", "VARCHAR", "BOOLEAN", "BINARY", "VARBINARY", "ARRAY", "BLOB", "LONGBLOB", "MEDIUMBLOB", "MAP", "STRUCT", "UNION", "SET", "GEOGRAPHY", "ENUM", "JSON", "UUID", "VARIANT", "GEOMETRY", "BYTEA", "AGGREGATEFUNCTION", "ERROR", "FIXED", "RECORD", "NULL", "SUPER", "HLLSKETCH", "PG_LSN", "PG_SNAPSHOT", "TSQUERY", "TXID_SNAPSHOT", "XML", "MACADDR", "TSVECTOR", "UNKNOWN", "CIDR", "INET", "CLOB", "ROWID", "LOWCARDINALITY", "YEAR", "POINT", "POLYGON", "TUPLE", "SPATIAL", "TABLE", "NTEXT", "IMAGE", "IPV4", "IPV6", "DATETIMERANGE", "HLL", "LARGEINT", "QUANTILE_STATE", "AGG_STATE", "BITMAP", "UINT", "BIT", "MONEY" ] } }, "supportsDynamicAssertion" : { "type" : "boolean" }, "supportsRowLevelPassedFailed" : { "type" : "boolean" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testPlatforms" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "OpenMetadata", "GreatExpectations", "DBT", "Deequ", "Soda", "Other" ] } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "TestDefinitionList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestDefinition" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "TestResultValue" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "predictedValue" : { "type" : "string" }, "value" : { "type" : "string" } } }, "TestSuite" : { "required" : [ "name" ], "type" : "object", "properties" : { "basic" : { "type" : "boolean" }, "basicEntityReference" : { "$ref" : "#/components/schemas/EntityReference" }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "connection" : { "$ref" : "#/components/schemas/TestSuiteConnection" }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "executable" : { "type" : "boolean" }, "executableEntityReference" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "inherited" : { "type" : "boolean" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "pipelines" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "serviceType" : { "type" : "string", "enum" : [ "TestSuite" ] }, "style" : { "$ref" : "#/components/schemas/Style" }, "summary" : { "$ref" : "#/components/schemas/TestSummary" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "testCaseResultSummary" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResultSummary" } }, "testConnectionResult" : { "$ref" : "#/components/schemas/TestConnectionResult" }, "tests" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "TestSuiteConnection" : { "type" : "object", "properties" : { "config" : { "type" : "object" } } }, "TestSuiteList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TestSuite" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "TestSummary" : { "type" : "object", "properties" : { "aborted" : { "type" : "integer", "format" : "int32" }, "columnTestSummary" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ColumnTestSummaryDefinition" } }, "failed" : { "type" : "integer", "format" : "int32" }, "queued" : { "type" : "integer", "format" : "int32" }, "success" : { "type" : "integer", "format" : "int32" }, "total" : { "type" : "integer", "format" : "int32" } } }, "Text" : { "type" : "object", "properties" : { "fragment" : { "type" : "boolean" } } }, "Thread" : { "required" : [ "about", "id", "message" ], "type" : "object", "properties" : { "about" : { "pattern" : "(?U)^<#E::\\w+::(?:[^:<>|]|:[^:<>|])+(?:::(?:[^:<>|]|:[^:<>|])+)*>$", "type" : "string" }, "addressedTo" : { "pattern" : "(?U)^<#E::\\w+::(?:[^:<>|]|:[^:<>|])+(?:::(?:[^:<>|]|:[^:<>|])+)*>$", "type" : "string" }, "announcement" : { "$ref" : "#/components/schemas/AnnouncementDetails" }, "cardStyle" : { "type" : "string", "enum" : [ "default", "logicalTestCaseAdded", "entityCreated", "entityDeleted", "entitySoftDeleted", "description", "tags", "owner", "testCaseResult", "customProperties", "assets", "domain" ] }, "chatbot" : { "$ref" : "#/components/schemas/ChatbotDetails" }, "createdBy" : { "type" : "string" }, "domain" : { "type" : "string", "format" : "uuid" }, "entityRef" : { "$ref" : "#/components/schemas/EntityReference" }, "entityUrlLink" : { "type" : "string" }, "feedInfo" : { "$ref" : "#/components/schemas/FeedInfo" }, "fieldOperation" : { "type" : "string", "enum" : [ "added", "updated", "deleted", "none" ] }, "generatedBy" : { "type" : "string", "enum" : [ "user", "system" ] }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "message" : { "type" : "string" }, "posts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Post" } }, "postsCount" : { "type" : "integer", "format" : "int32" }, "reactions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Reaction" } }, "resolved" : { "type" : "boolean" }, "task" : { "$ref" : "#/components/schemas/TaskDetails" }, "threadTs" : { "type" : "integer", "format" : "int64" }, "type" : { "type" : "string", "enum" : [ "Conversation", "Task", "Announcement", "Chatbot" ] }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" } } }, "ThreadCount" : { "type" : "object", "properties" : { "closedTaskCount" : { "type" : "integer", "format" : "int32" }, "conversationCount" : { "type" : "integer", "format" : "int32" }, "entityLink" : { "pattern" : "(?U)^<#E::\\w+::(?:[^:<>|]|:[^:<>|])+(?:::(?:[^:<>|]|:[^:<>|])+)*>$", "type" : "string" }, "mentionCount" : { "type" : "integer", "format" : "int32" }, "openTaskCount" : { "type" : "integer", "format" : "int32" }, "totalTaskCount" : { "type" : "integer", "format" : "int32" } } }, "ThreadCountList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ThreadCount" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "ThreadList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Thread" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "TimeValue" : { "type" : "object", "properties" : { "days" : { "type" : "integer", "format" : "int64" }, "daysFrac" : { "type" : "number", "format" : "double" }, "hours" : { "type" : "integer", "format" : "int64" }, "hoursFrac" : { "type" : "number", "format" : "double" }, "micros" : { "type" : "integer", "format" : "int64" }, "microsFrac" : { "type" : "number", "format" : "double" }, "millis" : { "type" : "integer", "format" : "int64" }, "millisFrac" : { "type" : "number", "format" : "double" }, "minutes" : { "type" : "integer", "format" : "int64" }, "minutesFrac" : { "type" : "number", "format" : "double" }, "nanos" : { "type" : "integer", "format" : "int64" }, "seconds" : { "type" : "integer", "format" : "int64" }, "secondsFrac" : { "type" : "number", "format" : "double" }, "stringRep" : { "type" : "string" } } }, "ToXContentFragment" : { "type" : "object", "properties" : { "fragment" : { "type" : "boolean" } } }, "TokenRefreshRequest" : { "required" : [ "refreshToken" ], "type" : "object", "properties" : { "refreshToken" : { "type" : "string" } } }, "Topic" : { "required" : [ "id", "name", "partitions", "service" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "cleanupPolicies" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "delete", "compact" ] } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "maximumMessageSize" : { "type" : "integer", "format" : "int32" }, "messageSchema" : { "$ref" : "#/components/schemas/MessageSchema" }, "minimumInSyncReplicas" : { "type" : "integer", "format" : "int32" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "partitions" : { "type" : "integer", "format" : "int32" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "replicationFactor" : { "type" : "integer", "format" : "int32" }, "retentionSize" : { "type" : "number", "format" : "double" }, "retentionTime" : { "type" : "number", "format" : "double" }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "sampleData" : { "$ref" : "#/components/schemas/TopicSampleData" }, "service" : { "$ref" : "#/components/schemas/EntityReference" }, "serviceType" : { "type" : "string", "enum" : [ "Kafka", "Redpanda", "Kinesis", "CustomMessaging" ] }, "sourceHash" : { "maxLength" : 32, "minLength" : 1, "type" : "string" }, "sourceUrl" : { "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "topicConfig" : { "$ref" : "#/components/schemas/TopicConfig" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "TopicConfig" : { "type" : "object" }, "TopicList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Topic" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "TopicSampleData" : { "type" : "object", "properties" : { "messages" : { "type" : "array", "items" : { "type" : "string" } } } }, "TotalHits" : { "type" : "object", "properties" : { "relation" : { "type" : "string", "enum" : [ "EQUAL_TO", "GREATER_THAN_OR_EQUAL_TO" ] }, "value" : { "type" : "integer", "format" : "int64" } } }, "TriggerConfig" : { "required" : [ "triggerType" ], "type" : "object", "properties" : { "cronExpression" : { "type" : "string" }, "scheduleInfo" : { "type" : "string", "enum" : [ "Daily", "Weekly", "Monthly", "Custom" ] }, "triggerType" : { "type" : "string", "enum" : [ "RealTime", "Scheduled" ] } } }, "Type" : { "required" : [ "description", "name" ], "type" : "object", "properties" : { "category" : { "type" : "string", "enum" : [ "field", "entity" ] }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "customProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CustomProperty" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "pattern" : "(?U)^[\\w]+$", "type" : "string" }, "nameSpace" : { "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "schema" : { "type" : "string" }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "TypeList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Type" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "UsageDetails" : { "required" : [ "dailyStats", "date" ], "type" : "object", "properties" : { "dailyStats" : { "$ref" : "#/components/schemas/UsageStats" }, "date" : { "type" : "string" }, "monthlyStats" : { "$ref" : "#/components/schemas/UsageStats" }, "weeklyStats" : { "$ref" : "#/components/schemas/UsageStats" } } }, "UsageStats" : { "required" : [ "count" ], "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32" }, "percentileRank" : { "type" : "number", "format" : "double" } } }, "User" : { "required" : [ "email", "id", "name" ], "type" : "object", "properties" : { "authenticationMechanism" : { "$ref" : "#/components/schemas/AuthenticationMechanism" }, "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "defaultPersona" : { "$ref" : "#/components/schemas/EntityReference" }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "domains" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "email" : { "maxLength" : 127, "minLength" : 6, "pattern" : "^[\\S.!#$%&’*+/=?^_`{|}~-]+@\\S+\\.\\S+$", "type" : "string" }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "follows" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "inheritedRoles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "isAdmin" : { "type" : "boolean" }, "isBot" : { "type" : "boolean" }, "isEmailVerified" : { "type" : "boolean" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "owns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "personas" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "profile" : { "$ref" : "#/components/schemas/Profile" }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "roles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "teams" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "timezone" : { "type" : "string" }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "UserList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/User" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "VoteRequest" : { "type" : "object", "properties" : { "updatedVoteType" : { "type" : "string", "enum" : [ "votedUp", "votedDown", "unVoted" ] } } }, "Votes" : { "type" : "object", "properties" : { "downVoters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "downVotes" : { "type" : "integer", "format" : "int32" }, "upVoters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "upVotes" : { "type" : "integer", "format" : "int32" } } }, "Webhook" : { "type" : "object", "properties" : { "endpoint" : { "type" : "string", "format" : "uri" }, "headers" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "httpMethod" : { "type" : "string", "enum" : [ "POST", "PUT" ] }, "receivers" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "secretKey" : { "type" : "string" }, "sendToAdmins" : { "type" : "boolean" }, "sendToFollowers" : { "type" : "boolean" }, "sendToOwners" : { "type" : "boolean" } } }, "WorkflowDefinition" : { "required" : [ "description", "name" ], "type" : "object", "properties" : { "certification" : { "$ref" : "#/components/schemas/AssetCertification" }, "changeDescription" : { "$ref" : "#/components/schemas/ChangeDescription" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "dataProducts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "domain" : { "$ref" : "#/components/schemas/EntityReference" }, "edges" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EdgeDefinition" } }, "experts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "extension" : { "type" : "object" }, "followers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "fullyQualifiedName" : { "maxLength" : 3072, "minLength" : 1, "type" : "string" }, "href" : { "type" : "string", "format" : "uri" }, "id" : { "type" : "string", "format" : "uuid" }, "lifeCycle" : { "$ref" : "#/components/schemas/LifeCycle" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^((?!::).)*$", "type" : "string" }, "nodes" : { "type" : "object" }, "owners" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "provider" : { "type" : "string", "enum" : [ "system", "user" ] }, "reviewers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityReference" } }, "style" : { "$ref" : "#/components/schemas/Style" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TagLabel" } }, "trigger" : { "type" : "object" }, "type" : { "type" : "string", "enum" : [ "eventBasedEntityWorkflow", "periodicBatchEntityWorkflow" ] }, "updatedAt" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "number", "format" : "double" }, "votes" : { "$ref" : "#/components/schemas/Votes" } } }, "WorkflowDefinitionList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WorkflowDefinition" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "WorkflowInstance" : { "type" : "object", "properties" : { "endedAt" : { "type" : "integer", "format" : "int64" }, "exception" : { "type" : "boolean" }, "id" : { "type" : "string", "format" : "uuid" }, "startedAt" : { "type" : "integer", "format" : "int64" }, "timestamp" : { "type" : "integer", "format" : "int64" }, "variables" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "workflowDefinitionId" : { "type" : "string", "format" : "uuid" } } }, "WorkflowInstanceResultList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WorkflowInstanceState" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } }, "WorkflowInstanceState" : { "type" : "object", "properties" : { "exception" : { "type" : "boolean" }, "id" : { "type" : "string", "format" : "uuid" }, "stage" : { "$ref" : "#/components/schemas/Stage" }, "timestamp" : { "type" : "integer", "format" : "int64" }, "workflowDefinitionId" : { "type" : "string", "format" : "uuid" }, "workflowInstanceExecutionId" : { "type" : "string", "format" : "uuid" }, "workflowInstanceId" : { "type" : "string", "format" : "uuid" } } }, "WorkflowInstanceStateResultList" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WorkflowInstanceState" } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntityError" } }, "paging" : { "$ref" : "#/components/schemas/Paging" } } } }, "securitySchemes" : { "BearerAuth" : { "type" : "http", "description" : "Provide Token from Bots settings section in OMD or your Authorization Provider", "scheme" : "bearer" } } } }