yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-28 17:23:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

[BACKEND][BUG] Fix the issue between the Code and Generated Swagger Definition #4960 (#5120)

Browse Source
This commit is contained in:
mohitdeuex 2022-05-24 21:21:02 +05:30 committed by GitHub
parent b8f3e42e58
commit 8ce574342d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
37 changed files with 581 additions and 157 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/CatalogResource.java
View File

@ -59,8 +59,9 @@ public class CatalogResource {
@GET
@Operation(
operationId = "listCollections",
summary = "List all collections",
tags = "general",
tags = "catalog",
description =
"List all the collections supported by OpenMetadata. This list provides all the collections "
+ "and resource REST endpoints.",
@ -68,8 +69,7 @@ public class CatalogResource {
@ApiResponse(
responseCode = "200",
description = "All collections",
content =
@Content(mediaType = "application/json", schema = @Schema(implementation = CollectionDescriptor.class)))
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CollectionList.class)))
})
public CollectionList getCollections(@Context UriInfo uriInfo) {
return getCollectionList(uriInfo);

11
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/bots/BotResource.java
View File

@ -90,6 +90,7 @@ public class BotResource extends EntityResource<Bot, BotRepository> {
@GET
@Operation(
operationId = "listBots",
summary = "List Bot",
tags = "bots",
description = "Get a list of Bot.",
@ -122,6 +123,7 @@ public class BotResource extends EntityResource<Bot, BotRepository> {
@GET
@Path("/{id}")
@Operation(
operationId = "getBotByID",
summary = "Get a bot",
tags = "bots",
description = "Get a bot by `id`.",
@ -144,6 +146,7 @@ public class BotResource extends EntityResource<Bot, BotRepository> {
@GET
@Path("/name/{fqn}")
@Operation(
operationId = "getBotByFQN",
summary = "Get a bot by name",
tags = "bots",
description = "Get a bot by name.",
@ -172,6 +175,7 @@ public class BotResource extends EntityResource<Bot, BotRepository> {
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllBotVersion",
summary = "List bot versions",
tags = "bots",
description = "Get a list of all the versions of a bot identified by `id`",
@ -192,6 +196,7 @@ public class BotResource extends EntityResource<Bot, BotRepository> {
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "listSpecificBotVersion",
summary = "Get a version of the bot",
tags = "bots",
description = "Get a version of the bot by given `id`",
@ -219,6 +224,7 @@ public class BotResource extends EntityResource<Bot, BotRepository> {
@POST
@Operation(
operationId = "createBot",
summary = "Create a bot",
tags = "bots",
description = "Create a new bot.",
@ -237,6 +243,7 @@ public class BotResource extends EntityResource<Bot, BotRepository> {
@PUT
@Operation(
operationId = "createOrUpdateBot",
summary = "Create or update a bot",
tags = "bots",
description = "Create a bot, if it does not exist. If a bot already exists, update the bot.",
@ -244,7 +251,7 @@ public class BotResource extends EntityResource<Bot, BotRepository> {
@ApiResponse(
responseCode = "200",
description = "The bot",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateBot.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Bot.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createOrUpdate(
@ -256,6 +263,7 @@ public class BotResource extends EntityResource<Bot, BotRepository> {
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchBot",
summary = "Update a bot",
tags = "bots",
description = "Update an existing bot using JsonPatch.",
@ -281,6 +289,7 @@ public class BotResource extends EntityResource<Bot, BotRepository> {
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteBot",
summary = "Delete a bot",
tags = "bots",
description = "Delete a bot by `id`. Bot is not immediately deleted and is only marked as deleted.",

15
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/charts/ChartResource.java
View File

@ -99,6 +99,7 @@ public class ChartResource extends EntityResource<Chart, ChartRepository> {
@GET
@Operation(
operationId = "listCharts",
summary = "List charts",
tags = "charts",
description =
@ -148,6 +149,7 @@ public class ChartResource extends EntityResource<Chart, ChartRepository> {
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllChartVersions",
summary = "List chart versions",
tags = "charts",
description = "Get a list of all the versions of a chart identified by `id`",
@ -168,6 +170,7 @@ public class ChartResource extends EntityResource<Chart, ChartRepository> {
@GET
@Path("/{id}")
@Operation(
operationId = "getChartByID",
summary = "Get a Chart",
tags = "charts",
description = "Get a chart by `id`.",
@ -200,6 +203,7 @@ public class ChartResource extends EntityResource<Chart, ChartRepository> {
@GET
@Path("/name/{fqn}")
@Operation(
operationId = "getChartByFQN",
summary = "Get a chart by name",
tags = "charts",
description = "Get a chart by fully qualified name.",
@ -232,6 +236,7 @@ public class ChartResource extends EntityResource<Chart, ChartRepository> {
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificChartVersion",
summary = "Get a version of the chart",
tags = "charts",
description = "Get a version of the chart by given `id`",
@ -259,6 +264,7 @@ public class ChartResource extends EntityResource<Chart, ChartRepository> {
@POST
@Operation(
operationId = "createChart",
summary = "Create a chart",
tags = "charts",
description = "Create a chart under an existing `service`.",
@ -266,7 +272,7 @@ public class ChartResource extends EntityResource<Chart, ChartRepository> {
@ApiResponse(
responseCode = "200",
description = "The chart",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateChart.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Chart.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(@Context UriInfo uriInfo, @Context SecurityContext securityContext, @Valid CreateChart create)
@ -278,6 +284,7 @@ public class ChartResource extends EntityResource<Chart, ChartRepository> {
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchChart",
summary = "Update a chart",
tags = "charts",
description = "Update an existing chart using JsonPatch.",
@ -302,6 +309,7 @@ public class ChartResource extends EntityResource<Chart, ChartRepository> {
@PUT
@Operation(
operationId = "createOrUpdateChart",
summary = "Create or update chart",
tags = "charts",
description = "Create a chart, it it does not exist or update an existing chart.",
@ -309,7 +317,7 @@ public class ChartResource extends EntityResource<Chart, ChartRepository> {
@ApiResponse(
responseCode = "200",
description = "The updated chart ",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateChart.class)))
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Chart.class)))
})
public Response createOrUpdate(
@Context UriInfo uriInfo, @Context SecurityContext securityContext, @Valid CreateChart create)
@ -321,6 +329,7 @@ public class ChartResource extends EntityResource<Chart, ChartRepository> {
@PUT
@Path("/{id}/followers")
@Operation(
operationId = "addFollowerToChart",
summary = "Add a follower",
tags = "charts",
description = "Add a user identified by `userId` as followed of this chart",
@ -342,6 +351,7 @@ public class ChartResource extends EntityResource<Chart, ChartRepository> {
@DELETE
@Path("/{id}/followers/{userId}")
@Operation(
operationId = "deleteFollowerFromChart",
summary = "Remove a follower",
tags = "charts",
description = "Remove the user identified `userId` as a follower of the chart.")
@ -361,6 +371,7 @@ public class ChartResource extends EntityResource<Chart, ChartRepository> {
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteChart",
summary = "Delete a Chart",
tags = "charts",
description = "Delete a chart by `id`.",

15
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/config/ConfigResource.java
View File

@ -47,8 +47,9 @@ public class ConfigResource {
@GET
@Path(("/auth"))
@Operation(
operationId = "getAuthConfiguration",
summary = "Get auth configuration",
tags = "general",
tags = "config",
responses = {
@ApiResponse(
responseCode = "200",
@ -69,8 +70,9 @@ public class ConfigResource {
@GET
@Path(("/authorizer"))
@Operation(
operationId = "getAuthorizerConfig",
summary = "Get authorizer configuration",
tags = "general",
tags = "config",
responses = {
@ApiResponse(
responseCode = "200",
@ -91,8 +93,9 @@ public class ConfigResource {
@GET
@Path(("/sandbox"))
@Operation(
operationId = "getSandboxConfiguration",
summary = "Get sandbox mode",
tags = "general",
tags = "config",
responses = {
@ApiResponse(
responseCode = "200",
@ -111,8 +114,9 @@ public class ConfigResource {
@GET
@Path(("/airflow"))
@Operation(
operationId = "getAirflowConfiguration",
summary = "Get airflow configuration",
tags = "general",
tags = "config",
responses = {
@ApiResponse(
responseCode = "200",
@ -133,8 +137,9 @@ public class ConfigResource {
@GET
@Path(("/jwks"))
@Operation(
operationId = "getJWKSResponse",
summary = "Get JWKS public key",
tags = "general",
tags = "config",
responses = {
@ApiResponse(
responseCode = "200",

17
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/dashboards/DashboardResource.java
View File

@ -99,6 +99,7 @@ public class DashboardResource extends EntityResource<Dashboard, DashboardReposi
@GET
@Valid
@Operation(
operationId = "listDashboards",
summary = "List Dashboards",
tags = "dashboards",
description =
@ -150,6 +151,7 @@ public class DashboardResource extends EntityResource<Dashboard, DashboardReposi
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllDashboardVersion",
summary = "List dashboard versions",
tags = "dashboards",
description = "Get a list of all the versions of a dashboard identified by `id`",
@ -170,6 +172,7 @@ public class DashboardResource extends EntityResource<Dashboard, DashboardReposi
@GET
@Path("/{id}")
@Operation(
operationId = "getDashboardByID",
summary = "Get a dashboard",
tags = "dashboards",
description = "Get a dashboard by `id`.",
@ -202,6 +205,7 @@ public class DashboardResource extends EntityResource<Dashboard, DashboardReposi
@GET
@Path("/name/{fqn}")
@Operation(
operationId = "getDashboardByFQN",
summary = "Get a dashboard by name",
tags = "dashboards",
description = "Get a dashboard by fully qualified name.",
@ -234,6 +238,7 @@ public class DashboardResource extends EntityResource<Dashboard, DashboardReposi
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificDashboardVersion",
summary = "Get a version of the dashboard",
tags = "dashboards",
description = "Get a version of the dashboard by given `id`",
@ -261,6 +266,7 @@ public class DashboardResource extends EntityResource<Dashboard, DashboardReposi
@POST
@Operation(
operationId = "createDashboard",
summary = "Create a dashboard",
tags = "dashboards",
description = "Create a new dashboard.",
@ -268,8 +274,7 @@ public class DashboardResource extends EntityResource<Dashboard, DashboardReposi
@ApiResponse(
responseCode = "200",
description = "The dashboard",
content =
@Content(mediaType = "application/json", schema = @Schema(implementation = CreateDashboard.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Dashboard.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@ -282,6 +287,7 @@ public class DashboardResource extends EntityResource<Dashboard, DashboardReposi
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchDashboard",
summary = "Update a Dashboard",
tags = "dashboards",
description = "Update an existing dashboard using JsonPatch.",
@ -306,6 +312,7 @@ public class DashboardResource extends EntityResource<Dashboard, DashboardReposi
@PUT
@Operation(
operationId = "createOrUpdateDashboard",
summary = "Create or update a dashboard",
tags = "dashboards",
description = "Create a new dashboard, if it does not exist or update an existing dashboard.",
@ -313,8 +320,7 @@ public class DashboardResource extends EntityResource<Dashboard, DashboardReposi
@ApiResponse(
responseCode = "200",
description = "The dashboard",
content =
@Content(mediaType = "application/json", schema = @Schema(implementation = CreateDashboard.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Dashboard.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createOrUpdate(
@ -327,6 +333,7 @@ public class DashboardResource extends EntityResource<Dashboard, DashboardReposi
@PUT
@Path("/{id}/followers")
@Operation(
operationId = "addFollowerToDashboard",
summary = "Add a follower",
tags = "dashboards",
description = "Add a user identified by `userId` as follower of this dashboard",
@ -348,6 +355,7 @@ public class DashboardResource extends EntityResource<Dashboard, DashboardReposi
@DELETE
@Path("/{id}/followers/{userId}")
@Operation(
operationId = "removeFollowerFromDashboard",
summary = "Remove a follower",
tags = "dashboards",
description = "Remove the user identified `userId` as a follower of the dashboard.")
@ -367,6 +375,7 @@ public class DashboardResource extends EntityResource<Dashboard, DashboardReposi
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteDashboard",
summary = "Delete a Dashboard",
tags = "dashboards",
description = "Delete a dashboard by `id`.",

20
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/databases/DatabaseResource.java
View File

@ -96,6 +96,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
@GET
@Operation(
operationId = "listDatabases",
summary = "List databases",
tags = "databases",
description =
@ -147,6 +148,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllDatabaseVersion",
summary = "List database versions",
tags = "databases",
description = "Get a list of all the versions of a database identified by `id`",
@ -167,6 +169,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
@GET
@Path("/{id}")
@Operation(
operationId = "getDatabaseByID",
summary = "Get a database",
tags = "databases",
description = "Get a database by `id`.",
@ -199,6 +202,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
@GET
@Path("/name/{fqn}")
@Operation(
operationId = "getDatabaseByFQN",
summary = "Get a database by name",
tags = "databases",
description = "Get a database by fully qualified name.",
@ -231,6 +235,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificDatabaseVersion",
summary = "Get a version of the database",
tags = "databases",
description = "Get a version of the database by given `id`",
@ -258,6 +263,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
@POST
@Operation(
operationId = "createDatabase",
summary = "Create a database",
tags = "databases",
description = "Create a database under an existing `service`.",
@ -265,8 +271,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
@ApiResponse(
responseCode = "200",
description = "The database",
content =
@Content(mediaType = "application/json", schema = @Schema(implementation = CreateDatabase.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Database.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@ -279,6 +284,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchDatabase",
summary = "Update a database",
tags = "databases",
description = "Update an existing database using JsonPatch.",
@ -303,6 +309,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
@PUT
@Operation(
operationId = "createOrUpdateDatabase",
summary = "Create or update database",
tags = "databases",
description = "Create a database, if it does not exist or update an existing database.",
@ -310,7 +317,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
@ApiResponse(
responseCode = "200",
description = "The updated database ",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateDatabase.class)))
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Database.class)))
})
public Response createOrUpdate(
@Context UriInfo uriInfo, @Context SecurityContext securityContext, @Valid CreateDatabase create)
@ -321,7 +328,11 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
@DELETE
@Path("/{id}/location")
@Operation(summary = "Remove the location", tags = "databases", description = "Remove the location")
@Operation(
operationId = "deleteLocation",
summary = "Remove the location",
tags = "databases",
description = "Remove the location")
public Database deleteLocation(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -335,6 +346,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteDatabase",
summary = "Delete a database",
tags = "databases",
description = "Delete a database by `id`. Database can only be deleted if it has no tables.",

16
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/databases/DatabaseSchemaResource.java
View File

@ -95,6 +95,7 @@ public class DatabaseSchemaResource extends EntityResource<DatabaseSchema, Datab
@GET
@Operation(
operationId = "listDBSchemas",
summary = "List database schemas",
tags = "databaseSchemas",
description =
@ -147,6 +148,7 @@ public class DatabaseSchemaResource extends EntityResource<DatabaseSchema, Datab
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllDBSchemaVersion",
summary = "List schema versions",
tags = "databaseSchemas",
description = "Get a list of all the versions of a schema identified by `id`",
@ -167,6 +169,7 @@ public class DatabaseSchemaResource extends EntityResource<DatabaseSchema, Datab
@GET
@Path("/{id}")
@Operation(
operationId = "getDBSchemaByID",
summary = "Get a schema",
tags = "databaseSchemas",
description = "Get a database schema by `id`.",
@ -200,6 +203,7 @@ public class DatabaseSchemaResource extends EntityResource<DatabaseSchema, Datab
@GET
@Path("/name/{fqn}")
@Operation(
operationId = "getDBSchemaByFQN",
summary = "Get a schema by name",
tags = "databaseSchemas",
description = "Get a database schema by fully qualified name.",
@ -233,6 +237,7 @@ public class DatabaseSchemaResource extends EntityResource<DatabaseSchema, Datab
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificDBSchemaVersion",
summary = "Get a version of the schema",
tags = "databaseSchemas",
description = "Get a version of the database schema by given `id`",
@ -261,6 +266,7 @@ public class DatabaseSchemaResource extends EntityResource<DatabaseSchema, Datab
@POST
@Operation(
operationId = "createDBSchema",
summary = "Create a schema",
tags = "databaseSchemas",
description = "Create a schema under an existing `service`.",
@ -269,9 +275,7 @@ public class DatabaseSchemaResource extends EntityResource<DatabaseSchema, Datab
responseCode = "200",
description = "The database schema",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = CreateDatabaseSchema.class))),
@Content(mediaType = "application/json", schema = @Schema(implementation = DatabaseSchema.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@ -284,6 +288,7 @@ public class DatabaseSchemaResource extends EntityResource<DatabaseSchema, Datab
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchDBSchema",
summary = "Update a database schema",
tags = "databaseSchemas",
description = "Update an existing database schema using JsonPatch.",
@ -308,6 +313,7 @@ public class DatabaseSchemaResource extends EntityResource<DatabaseSchema, Datab
@PUT
@Operation(
operationId = "createOrUpdateDBSchema",
summary = "Create or update schema",
tags = "databaseSchemas",
description = "Create a database schema, if it does not exist or update an existing database schema.",
@ -315,8 +321,7 @@ public class DatabaseSchemaResource extends EntityResource<DatabaseSchema, Datab
@ApiResponse(
responseCode = "200",
description = "The updated schema ",
content =
@Content(mediaType = "application/json", schema = @Schema(implementation = CreateDatabaseSchema.class)))
content = @Content(mediaType = "application/json", schema = @Schema(implementation = DatabaseSchema.class)))
})
public Response createOrUpdate(
@Context UriInfo uriInfo, @Context SecurityContext securityContext, @Valid CreateDatabaseSchema create)
@ -328,6 +333,7 @@ public class DatabaseSchemaResource extends EntityResource<DatabaseSchema, Datab
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteDBSchema",
summary = "Delete a schema",
tags = "databaseSchemas",
description = "Delete a schema by `id`. Schema can only be deleted if it has no tables.",

164
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/databases/TableResource.java
View File

@ -66,6 +66,7 @@ import org.openmetadata.catalog.security.SecurityUtil;
import org.openmetadata.catalog.tests.ColumnTest;
import org.openmetadata.catalog.tests.CustomMetric;
import org.openmetadata.catalog.tests.TableTest;
import org.openmetadata.catalog.type.ChangeEvent;
import org.openmetadata.catalog.type.DataModel;
import org.openmetadata.catalog.type.EntityHistory;
import org.openmetadata.catalog.type.Include;
@ -119,6 +120,7 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@GET
@Operation(
operationId = "listTables",
summary = "List tables",
tags = "tables",
description =
@ -170,6 +172,7 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@GET
@Path("/{id}")
@Operation(
operationId = "getTableByID",
summary = "Get a table",
tags = "tables",
description = "Get a table by `id`",
@ -202,6 +205,7 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@GET
@Path("/name/{fqn}")
@Operation(
operationId = "getTableByFQN",
summary = "Get a table by name",
tags = "tables",
description = "Get a table by fully qualified table name.",
@ -235,6 +239,7 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllTableVersion",
summary = "List table versions",
tags = "tables",
description = "Get a list of all the versions of a table identified by `id`",
@ -255,6 +260,7 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificDatabaseVersion",
summary = "Get a version of the table",
tags = "tables",
description = "Get a version of the table by given `id`",
@ -282,6 +288,7 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@POST
@Operation(
operationId = "createTable",
summary = "Create a table",
tags = "tables",
description = "Create a new table under an existing `database`.",
@ -289,7 +296,7 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@ApiResponse(
responseCode = "200",
description = "table",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateTable.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(@Context UriInfo uriInfo, @Context SecurityContext securityContext, @Valid CreateTable create)
@ -300,6 +307,7 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@PUT
@Operation(
operationId = "createOrUpdateTable",
summary = "Create or update a table",
tags = "tables",
description = "Create a table, if it does not exist. If a table already exists, update the table.",
@ -307,7 +315,7 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@ApiResponse(
responseCode = "200",
description = "The table",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateTable.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createOrUpdate(
@ -320,6 +328,7 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchTable",
summary = "Update a table",
tags = "tables",
description = "Update an existing table using JsonPatch.",
@ -345,6 +354,7 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteTable",
summary = "Delete a table",
tags = "tables",
description = "Delete a table by `id`. Table is not immediately deleted and is only marked as deleted.",
@ -367,11 +377,15 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@PUT
@Path("/{id}/followers")
@Operation(
operationId = "addFollowerToTable",
summary = "Add a follower",
tags = "tables",
description = "Add a user identified by `userId` as followed of this table",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ChangeEvent.class))),
@ApiResponse(responseCode = "404", description = "Table for instance {id} is not found")
})
public Response addFollower(
@ -388,13 +402,17 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@PUT
@Path("/{id}/joins")
@Operation(
operationId = "addTableJoinInfo",
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.",
tags = "tables",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),
@ApiResponse(
responseCode = "200",
description = "Successfully updated the Table",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class))),
@ApiResponse(responseCode = "404", description = "Table for instance {id} is not found"),
@ApiResponse(responseCode = "400", description = "Date range can only include past 30 days starting" + " today")
})
@ -411,7 +429,17 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@PUT
@Path("/{id}/sampleData")
@Operation(summary = "Add sample data", tags = "tables", description = "Add sample data to the table.")
@Operation(
operationId = "addSampleData",
summary = "Add sample data",
tags = "tables",
description = "Add sample data to the table.",
responses = {
@ApiResponse(
responseCode = "200",
description = "Successfully update the Table",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class)))
})
public Table addSampleData(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -425,7 +453,17 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@PUT
@Path("/{id}/tableProfile")
@Operation(summary = "Add table profile data", tags = "tables", description = "Add table profile data to the table.")
@Operation(
operationId = "addDataProfiler",
summary = "Add table profile data",
tags = "tables",
description = "Add table profile data to the table.",
responses = {
@ApiResponse(
responseCode = "200",
description = "Successfully updated the Table ",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class)))
})
public Table addDataProfiler(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -440,11 +478,15 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@PUT
@Path("/{id}/location")
@Operation(
operationId = "addLocationToTable",
summary = "Add a location",
tags = "tables",
description = "Add a location identified by `locationId` to this table",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class))),
@ApiResponse(responseCode = "404", description = "Table for instance {id} is not found")
})
public Response addLocation(
@ -459,7 +501,17 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@PUT
@Path("/{id}/tableQuery")
@Operation(summary = "Add table query data", tags = "tables", description = "Add table query data to the table.")
@Operation(
operationId = "addTableQuery",
summary = "Add table query data",
tags = "tables",
description = "Add table query data to the table.",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class)))
})
public Table addQuery(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -474,9 +526,16 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@PUT
@Path("/{id}/dataModel")
@Operation(
operationId = "addDataModel",
summary = "Add data modeling information to a table",
tags = "tables",
description = "Add data modeling (such as DBT model) information on how the table was created to the table.")
description = "Add data modeling (such as DBT model) information on how the table was created to the table.",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class)))
})
public Table addDataModel(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -490,7 +549,17 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@PUT
@Path("/{id}/tableTest")
@Operation(summary = "Add table test cases", tags = "tables", description = "Add test cases to the table.")
@Operation(
operationId = "addTableTest",
summary = "Add table test cases",
tags = "tables",
description = "Add test cases to the table.",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class)))
})
public Table addTableTest(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -505,7 +574,17 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@DELETE
@Path("/{id}/tableTest/{tableTestType}")
@Operation(summary = "delete table test case", tags = "tables", description = "Delete test case from the table.")
@Operation(
operationId = "deleteTableTest",
summary = "delete table test case",
tags = "tables",
description = "Delete test case from the table.",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class)))
})
public Table deleteTableTest(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -520,7 +599,17 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@PUT
@Path("/{id}/columnTest")
@Operation(summary = "Add column test cases", tags = "tables", description = "Add column test cases to the table.")
@Operation(
operationId = "addColumnTest",
summary = "Add column test cases",
tags = "tables",
description = "Add column test cases to the table.",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class)))
})
public Table addColumnTest(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -535,7 +624,17 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@PUT
@Path("/{id}/customMetric")
@Operation(summary = "Add column custom metrics", tags = "tables", description = "Add column custom metrics.")
@Operation(
operationId = "addCustomMetric",
summary = "Add column custom metrics",
tags = "tables",
description = "Add column custom metrics.",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class)))
})
public Table addCustomMetric(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -551,9 +650,16 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@DELETE
@Path("/{id}/columnTest/{columnName}/{columnTestType}")
@Operation(
operationId = "deleteColumnTest",
summary = "delete column test case",
tags = "tables",
description = "Delete column test case from the table.")
description = "Delete column test case from the table.",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class)))
})
public Table deleteColumnTest(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -571,9 +677,16 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@DELETE
@Path("/{id}/customMetric/{columnName}/{customMetricName}")
@Operation(
operationId = "deleteCustomMetric",
summary = "delete custom metric from a column",
tags = "tables",
description = "Delete a custom metric from a column.")
description = "Delete a custom metric from a column.",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class)))
})
public Table deleteCustomMetric(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -591,9 +704,16 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@DELETE
@Path("/{id}/followers/{userId}")
@Operation(
operationId = "deleteFollower",
summary = "Remove a follower",
tags = "tables",
description = "Remove the user identified `userId` as a follower of the table.")
description = "Remove the user identified `userId` as a follower of the table.",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ChangeEvent.class)))
})
public Response deleteFollower(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -609,7 +729,17 @@ public class TableResource extends EntityResource<Table, TableRepository> {
@DELETE
@Path("/{id}/location")
@Operation(summary = "Remove the location", tags = "tables", description = "Remove the location")
@Operation(
operationId = "deleteLocation",
summary = "Remove the location",
tags = "tables",
description = "Remove the location",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Table.class)))
})
public Table deleteLocation(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,

4
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/events/EventResource.java
View File

@ -68,6 +68,7 @@ public class EventResource {
@GET
@Valid
@Operation(
operationId = "listChangeEvents",
summary = "Get change events",
tags = "events",
description = "Get a list of change events matching event types, entity type, from a given date",
@ -75,7 +76,8 @@ public class EventResource {
@ApiResponse(
responseCode = "200",
description = "Entity events",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ChangeEvent.class))),
content =
@Content(mediaType = "application/json", schema = @Schema(implementation = ChangeEventList.class))),
@ApiResponse(responseCode = "404", description = "Entity for instance {id} is not found")
})
public ResultList<ChangeEvent> get(

12
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/events/WebhookResource.java
View File

@ -55,7 +55,6 @@ import org.openmetadata.catalog.jdbi3.WebhookRepository;
import org.openmetadata.catalog.resources.Collection;
import org.openmetadata.catalog.resources.EntityResource;
import org.openmetadata.catalog.security.Authorizer;
import org.openmetadata.catalog.type.ChangeEvent;
import org.openmetadata.catalog.type.EntityHistory;
import org.openmetadata.catalog.type.Include;
import org.openmetadata.catalog.type.Webhook;
@ -92,6 +91,7 @@ public class WebhookResource extends EntityResource<Webhook, WebhookRepository>
@GET
@Operation(
operationId = "listWebHooks",
summary = "List webhooks",
tags = "webhook",
description = "Get a list of webhook subscriptions",
@ -131,6 +131,7 @@ public class WebhookResource extends EntityResource<Webhook, WebhookRepository>
@Path("/{id}")
@Valid
@Operation(
operationId = "getWebHookByID",
summary = "Get a webhook",
tags = "webhook",
description = "Get a webhook by given Id",
@ -138,7 +139,7 @@ public class WebhookResource extends EntityResource<Webhook, WebhookRepository>
@ApiResponse(
responseCode = "200",
description = "Entity events",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ChangeEvent.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Webhook.class))),
@ApiResponse(responseCode = "404", description = "Entity for instance {id} is not found")
})
public Webhook get(
@ -158,6 +159,7 @@ public class WebhookResource extends EntityResource<Webhook, WebhookRepository>
@GET
@Path("/name/{name}")
@Operation(
operationId = "getWebHookByFQN",
summary = "Get a webhook by name",
tags = "webhook",
description = "Get a webhook by name.",
@ -185,6 +187,7 @@ public class WebhookResource extends EntityResource<Webhook, WebhookRepository>
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllWebHookVersion",
summary = "List webhook versions",
tags = "webhook",
description = "Get a list of all the versions of a webhook identified by `id`",
@ -205,6 +208,7 @@ public class WebhookResource extends EntityResource<Webhook, WebhookRepository>
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificWebhookVersion",
summary = "Get a version of the webhook",
tags = "webhook",
description = "Get a version of the webhook by given `id`",
@ -232,6 +236,7 @@ public class WebhookResource extends EntityResource<Webhook, WebhookRepository>
@POST
@Operation(
operationId = "createWebHook",
summary = "Subscribe to a new webhook",
tags = "webhook",
description = "Subscribe to a new webhook",
@ -253,6 +258,7 @@ public class WebhookResource extends EntityResource<Webhook, WebhookRepository>
@PUT
@Operation(
operationId = "createOrUpdateWebhook",
summary = "Updated an existing or create a new webhook",
tags = "webhook",
description = "Updated an existing or create a new webhook",
@ -275,6 +281,7 @@ public class WebhookResource extends EntityResource<Webhook, WebhookRepository>
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchWebHook",
summary = "Update a webhook",
tags = "webhook",
description = "Update an existing webhook using JsonPatch.",
@ -301,6 +308,7 @@ public class WebhookResource extends EntityResource<Webhook, WebhookRepository>
@Path("/{id}")
@Valid
@Operation(
operationId = "deleteWebHook",
summary = "Delete a webhook",
tags = "webhook",
description = "Get a webhook by given Id",

12
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/feeds/FeedResource.java
View File

@ -115,6 +115,7 @@ public class FeedResource {
@GET
@Operation(
operationId = "listThreads",
summary = "List threads",
tags = "feeds",
description = "Get a list of threads, optionally filtered by `entityLink`.",
@ -184,6 +185,7 @@ public class FeedResource {
@GET
@Path("/{id}")
@Operation(
operationId = "getThreadByID",
summary = "Get a thread",
tags = "feeds",
description = "Get a thread by `id`.",
@ -201,6 +203,7 @@ public class FeedResource {
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchThread",
summary = "Update a thread by `id`.",
tags = "feeds",
description = "Update an existing thread using JsonPatch.",
@ -228,6 +231,7 @@ public class FeedResource {
@GET
@Path("/count")
@Operation(
operationId = "countThreads",
summary = "count of threads",
tags = "feeds",
description = "Get a count of threads, optionally filtered by `entityLink` for each of the entities.",
@ -253,6 +257,7 @@ public class FeedResource {
@POST
@Operation(
operationId = "createThread",
summary = "Create a thread",
tags = "feeds",
description = "Create a new thread. A thread is created about a data asset when a user posts the first post.",
@ -260,7 +265,7 @@ public class FeedResource {
@ApiResponse(
responseCode = "200",
description = "The thread",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateThread.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Thread.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(@Context UriInfo uriInfo, @Context SecurityContext securityContext, @Valid CreateThread create)
@ -273,6 +278,7 @@ public class FeedResource {
@POST
@Path("/{id}/posts")
@Operation(
operationId = "addPostToThread",
summary = "Add post to a thread",
tags = "feeds",
description = "Add a post to an existing thread.",
@ -280,7 +286,7 @@ public class FeedResource {
@ApiResponse(
responseCode = "200",
description = "The post",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreatePost.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Thread.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response addPost(
@ -297,6 +303,7 @@ public class FeedResource {
@DELETE
@Path("/{threadId}/posts/{postId}")
@Operation(
operationId = "deletePostFromThread",
summary = "Delete a post from its thread",
tags = "feeds",
description = "Delete a post from an existing thread.",
@ -325,6 +332,7 @@ public class FeedResource {
@GET
@Path("/{id}/posts")
@Operation(
operationId = "getAllPostOfThread",
summary = "Get all the posts of a thread",
tags = "feeds",
description = "Get all the posts of an existing thread.",

12
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/glossary/GlossaryResource.java
View File

@ -100,6 +100,7 @@ public class GlossaryResource extends EntityResource<Glossary, GlossaryRepositor
@GET
@Valid
@Operation(
operationId = "listGlossaries",
summary = "List Glossaries",
tags = "glossaries",
description =
@ -146,6 +147,7 @@ public class GlossaryResource extends EntityResource<Glossary, GlossaryRepositor
@GET
@Path("/{id}")
@Operation(
operationId = "getGlossaryByID",
summary = "Get a glossary",
tags = "glossaries",
description = "Get a glossary by `id`.",
@ -178,6 +180,7 @@ public class GlossaryResource extends EntityResource<Glossary, GlossaryRepositor
@GET
@Path("/name/{name}")
@Operation(
operationId = "getGlossaryByFQN",
summary = "Get a glossary by name",
tags = "glossaries",
description = "Get a glossary by name.",
@ -210,6 +213,7 @@ public class GlossaryResource extends EntityResource<Glossary, GlossaryRepositor
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllGlossaryVersion",
summary = "List glossary versions",
tags = "glossaries",
description = "Get a list of all the versions of a glossary identified by `id`",
@ -230,6 +234,7 @@ public class GlossaryResource extends EntityResource<Glossary, GlossaryRepositor
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificGlossaryVersion",
summary = "Get a version of the glossaries",
tags = "glossaries",
description = "Get a version of the glossary by given `id`",
@ -257,6 +262,7 @@ public class GlossaryResource extends EntityResource<Glossary, GlossaryRepositor
@POST
@Operation(
operationId = "createGlossary",
summary = "Create a glossary",
tags = "glossaries",
description = "Create a new glossary.",
@ -264,8 +270,7 @@ public class GlossaryResource extends EntityResource<Glossary, GlossaryRepositor
@ApiResponse(
responseCode = "200",
description = "The glossary",
content =
@Content(mediaType = "application/json", schema = @Schema(implementation = CreateGlossary.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Glossary.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@ -278,6 +283,7 @@ public class GlossaryResource extends EntityResource<Glossary, GlossaryRepositor
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchGlossary",
summary = "Update a glossary",
tags = "glossaries",
description = "Update an existing glossary using JsonPatch.",
@ -302,6 +308,7 @@ public class GlossaryResource extends EntityResource<Glossary, GlossaryRepositor
@PUT
@Operation(
operationId = "createOrUpdateGlossary",
summary = "Create or update a glossary",
tags = "glossaries",
description = "Create a new glossary, if it does not exist or update an existing glossary.",
@ -322,6 +329,7 @@ public class GlossaryResource extends EntityResource<Glossary, GlossaryRepositor
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteGlossary",
summary = "Delete a Glossary",
tags = "glossaries",
description = "Delete a glossary by `id`.",

26
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/glossary/GlossaryTermResource.java
View File

@ -106,8 +106,9 @@ public class GlossaryTermResource extends EntityResource<GlossaryTerm, GlossaryT
@GET
@Valid
@Operation(
operationId = "listGlossaryTerm",
summary = "List glossary terms",
tags = "glossaries",
tags = "glossaryTerm",
description =
"Get a list of glossary terms. Use `fields` parameter to get only necessary fields. "
+ " Use cursor-based pagination to limit the number "
@ -195,8 +196,9 @@ public class GlossaryTermResource extends EntityResource<GlossaryTerm, GlossaryT
@GET
@Path("/{id}")
@Operation(
operationId = "getGlossaryTermByID",
summary = "Get a glossary term",
tags = "glossaries",
tags = "glossaryTerm",
description = "Get a glossary term by `id`.",
responses = {
@ApiResponse(
@ -227,8 +229,9 @@ public class GlossaryTermResource extends EntityResource<GlossaryTerm, GlossaryT
@GET
@Path("/name/{name}")
@Operation(
operationId = "getGlossaryTermByFQN",
summary = "Get a glossary term by name",
tags = "glossaries",
tags = "glossaryTerm",
description = "Get a glossary term by name.",
responses = {
@ApiResponse(
@ -259,8 +262,9 @@ public class GlossaryTermResource extends EntityResource<GlossaryTerm, GlossaryT
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllGlossaryTermVersion",
summary = "List glossary term versions",
tags = "glossaries",
tags = "glossaryTerm",
description = "Get a list of all the versions of a glossary terms identified by `id`",
responses = {
@ApiResponse(
@ -279,8 +283,9 @@ public class GlossaryTermResource extends EntityResource<GlossaryTerm, GlossaryT
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificGlossaryTermVersion",
summary = "Get a version of the glossary term",
tags = "glossaries",
tags = "glossaryTerm",
description = "Get a version of the glossary term by given `id`",
responses = {
@ApiResponse(
@ -306,8 +311,9 @@ public class GlossaryTermResource extends EntityResource<GlossaryTerm, GlossaryT
@POST
@Operation(
operationId = "createGlossaryTerm",
summary = "Create a glossary term",
tags = "glossaries",
tags = "glossaryTerm",
description = "Create a new glossary term.",
responses = {
@ApiResponse(
@ -326,8 +332,9 @@ public class GlossaryTermResource extends EntityResource<GlossaryTerm, GlossaryT
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchGlossaryTerm",
summary = "Update a glossary term",
tags = "glossaries",
tags = "glossaryTerm",
description = "Update an existing glossary term using JsonPatch.",
externalDocs = @ExternalDocumentation(description = "JsonPatch RFC", url = "https://tools.ietf.org/html/rfc6902"))
@Consumes(MediaType.APPLICATION_JSON_PATCH_JSON)
@ -350,8 +357,9 @@ public class GlossaryTermResource extends EntityResource<GlossaryTerm, GlossaryT
@PUT
@Operation(
operationId = "createOrUpdateGlossaryTerm",
summary = "Create or update a glossary term",
tags = "glossaries",
tags = "glossaryTerm",
description = "Create a new glossary term, if it does not exist or update an existing glossary term.",
responses = {
@ApiResponse(
@ -371,7 +379,7 @@ public class GlossaryTermResource extends EntityResource<GlossaryTerm, GlossaryT
@Path("/{id}")
@Operation(
summary = "Delete a glossary term",
tags = "glossaries",
tags = "glossaryTerm",
description = "Delete a glossary term by `id`.",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),

4
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/lineage/LineageResource.java
View File

@ -70,6 +70,7 @@ public class LineageResource {
@Valid
@Path("/{entity}/{id}")
@Operation(
operationId = "getLineage",
summary = "Get lineage",
tags = "lineage",
description = "Get lineage details for an entity identified by `id`.",
@ -110,6 +111,7 @@ public class LineageResource {
@Valid
@Path("/{entity}/name/{fqn}")
@Operation(
operationId = "getLineageByFQN",
summary = "Get lineage by name",
tags = "lineage",
description = "Get lineage details for an entity identified by fully qualified name.",
@ -152,6 +154,7 @@ public class LineageResource {
@PUT
@Operation(
operationId = "addLineageEdge",
summary = "Add a lineage edge",
tags = "lineage",
description = "Add a lineage edge with from entity as upstream node and to entity as downstream node.",
@ -171,6 +174,7 @@ public class LineageResource {
@DELETE
@Path("/{fromEntity}/{fromId}/{toEntity}/{toId}")
@Operation(
operationId = "deleteLineageEdge",
summary = "Delete a lineage edge",
tags = "lineage",
description = "Delete a lineage edge with from entity as upstream node and to entity as downstream node.",

26
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/locations/LocationResource.java
View File

@ -58,6 +58,7 @@ import org.openmetadata.catalog.jdbi3.LocationRepository;
import org.openmetadata.catalog.resources.Collection;
import org.openmetadata.catalog.resources.EntityResource;
import org.openmetadata.catalog.security.Authorizer;
import org.openmetadata.catalog.type.ChangeEvent;
import org.openmetadata.catalog.type.EntityHistory;
import org.openmetadata.catalog.type.Include;
import org.openmetadata.catalog.util.EntityUtil.Fields;
@ -97,6 +98,7 @@ public class LocationResource extends EntityResource<Location, LocationRepositor
@GET
@Operation(
operationId = "listLocations",
summary = "List locations",
tags = "locations",
description =
@ -148,6 +150,7 @@ public class LocationResource extends EntityResource<Location, LocationRepositor
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllLocationVersion",
summary = "List location versions",
tags = "locations",
description = "Get a list of all the versions of a location identified by `id`",
@ -168,6 +171,7 @@ public class LocationResource extends EntityResource<Location, LocationRepositor
@GET
@Path("/{id}")
@Operation(
operationId = "getLocationByID",
summary = "Get a location",
tags = "locations",
description = "Get a location by `id`.",
@ -200,6 +204,7 @@ public class LocationResource extends EntityResource<Location, LocationRepositor
@GET
@Path("prefixes/{fqn}")
@Operation(
operationId = "listLocationPrefixes",
summary = "List locations that are prefixes",
tags = "locations",
description =
@ -253,6 +258,7 @@ public class LocationResource extends EntityResource<Location, LocationRepositor
@GET
@Path("/name/{fqn}")
@Operation(
operationId = "getLocationByFQN",
summary = "Get a location by name",
tags = "locations",
description = "Get a location by fully qualified name.",
@ -289,6 +295,7 @@ public class LocationResource extends EntityResource<Location, LocationRepositor
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificLocationVersion",
summary = "Get a version of the location",
tags = "locations",
description = "Get a version of the location by given `id`",
@ -316,6 +323,7 @@ public class LocationResource extends EntityResource<Location, LocationRepositor
@POST
@Operation(
operationId = "createLocation",
summary = "Create a location",
tags = "locations",
description = "Create a location under an existing `service`.",
@ -335,6 +343,7 @@ public class LocationResource extends EntityResource<Location, LocationRepositor
@PUT
@Operation(
operationId = "createOrUpdateLocation",
summary = "Create or update location",
tags = "locations",
description = "Create a location, it it does not exist or update an existing location.",
@ -355,6 +364,7 @@ public class LocationResource extends EntityResource<Location, LocationRepositor
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchLocation",
summary = "Update a location",
tags = "locations",
description = "Update an existing location using JsonPatch.",
@ -380,6 +390,7 @@ public class LocationResource extends EntityResource<Location, LocationRepositor
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteLocation",
summary = "Delete a location",
tags = "locations",
description = "Delete a location by `id`.",
@ -402,11 +413,15 @@ public class LocationResource extends EntityResource<Location, LocationRepositor
@PUT
@Path("/{id}/followers")
@Operation(
operationId = "addFollower",
summary = "Add a follower",
tags = "locations",
description = "Add a user identified by `userId` as followed of this location",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ChangeEvent.class))),
@ApiResponse(responseCode = "404", description = "Location for instance {id} is not found")
})
public Response addFollower(
@ -423,9 +438,16 @@ public class LocationResource extends EntityResource<Location, LocationRepositor
@DELETE
@Path("/{id}/followers/{userId}")
@Operation(
operationId = "deleteFollower",
summary = "Remove a follower",
tags = "locations",
description = "Remove the user identified `userId` as a follower of the location.")
description = "Remove the user identified `userId` as a follower of the location.",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ChangeEvent.class))),
})
public Response deleteFollower(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,

4
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/metrics/MetricsResource.java
View File

@ -80,6 +80,7 @@ public class MetricsResource extends EntityResource<Metrics, MetricsRepository>
@GET
@Operation(
operationId = "listMetrics",
summary = "List metrics",
tags = "metrics",
description = "Get a list of metrics. Use `fields` parameter to get only necessary fields.",
@ -112,6 +113,7 @@ public class MetricsResource extends EntityResource<Metrics, MetricsRepository>
@GET
@Path("/{id}")
@Operation(
operationId = "getMetricByID",
summary = "Get a metric",
tags = "metrics",
description = "Get a metric by `id`.",
@ -143,6 +145,7 @@ public class MetricsResource extends EntityResource<Metrics, MetricsRepository>
@POST
@Operation(
operationId = "createMetric",
summary = "Create a metric",
tags = "metrics",
description = "Create a new metric.",
@ -161,6 +164,7 @@ public class MetricsResource extends EntityResource<Metrics, MetricsRepository>
@PUT
@Operation(
operationId = "createOrUpdateMetric",
summary = "Create or update a metric",
tags = "metrics",
description = "Create a new metric, if it does not exist or update an existing metric.",

27
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/mlmodels/MlModelResource.java
View File

@ -58,6 +58,7 @@ import org.openmetadata.catalog.jdbi3.MlModelRepository;
import org.openmetadata.catalog.resources.Collection;
import org.openmetadata.catalog.resources.EntityResource;
import org.openmetadata.catalog.security.Authorizer;
import org.openmetadata.catalog.type.ChangeEvent;
import org.openmetadata.catalog.type.EntityHistory;
import org.openmetadata.catalog.type.Include;
import org.openmetadata.catalog.util.RestUtil;
@ -100,6 +101,7 @@ public class MlModelResource extends EntityResource<MlModel, MlModelRepository>
@GET
@Valid
@Operation(
operationId = "listMlModels",
summary = "List ML Models",
tags = "mlModels",
description =
@ -146,6 +148,7 @@ public class MlModelResource extends EntityResource<MlModel, MlModelRepository>
@GET
@Path("/{id}")
@Operation(
operationId = "getMlModelByID",
summary = "Get an ML Model",
tags = "mlModels",
description = "Get an ML Model by `id`.",
@ -178,6 +181,7 @@ public class MlModelResource extends EntityResource<MlModel, MlModelRepository>
@GET
@Path("/name/{fqn}")
@Operation(
operationId = "getMlModelByFQN",
summary = "Get an ML Model by name",
tags = "mlModels",
description = "Get an ML Model by fully qualified name.",
@ -209,6 +213,7 @@ public class MlModelResource extends EntityResource<MlModel, MlModelRepository>
@POST
@Operation(
operationId = "createMlModel",
summary = "Create an ML Model",
tags = "mlModels",
description = "Create a new ML Model.",
@ -216,7 +221,7 @@ public class MlModelResource extends EntityResource<MlModel, MlModelRepository>
@ApiResponse(
responseCode = "200",
description = "ML Model",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateMlModel.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = MlModel.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@ -229,6 +234,7 @@ public class MlModelResource extends EntityResource<MlModel, MlModelRepository>
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchMlModel",
summary = "Update an ML Model",
tags = "mlModels",
description = "Update an existing ML Model using JsonPatch.",
@ -253,6 +259,7 @@ public class MlModelResource extends EntityResource<MlModel, MlModelRepository>
@PUT
@Operation(
operationId = "createOrUpdateMlModel",
summary = "Create or update an ML Model",
tags = "mlModels",
description = "Create a new ML Model, if it does not exist or update an existing model.",
@ -273,11 +280,15 @@ public class MlModelResource extends EntityResource<MlModel, MlModelRepository>
@PUT
@Path("/{id}/followers")
@Operation(
operationId = "addFollower",
summary = "Add a follower",
tags = "mlModels",
description = "Add a user identified by `userId` as follower of this model",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ChangeEvent.class))),
@ApiResponse(responseCode = "404", description = "model for instance {id} is not found")
})
public Response addFollower(
@ -294,9 +305,16 @@ public class MlModelResource extends EntityResource<MlModel, MlModelRepository>
@DELETE
@Path("/{id}/followers/{userId}")
@Operation(
operationId = "deleteFollower",
summary = "Remove a follower",
tags = "mlModels",
description = "Remove the user identified `userId` as a follower of the model.")
description = "Remove the user identified `userId` as a follower of the model.",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ChangeEvent.class))),
})
public Response deleteFollower(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -313,6 +331,7 @@ public class MlModelResource extends EntityResource<MlModel, MlModelRepository>
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllMlModelVersion",
summary = "List Ml Model versions",
tags = "mlModels",
description = "Get a list of all the versions of an Ml Model identified by `id`",
@ -333,6 +352,7 @@ public class MlModelResource extends EntityResource<MlModel, MlModelRepository>
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificMlModelVersion",
summary = "Get a version of the ML Model",
tags = "mlModels",
description = "Get a version of the ML Model by given `id`",
@ -361,6 +381,7 @@ public class MlModelResource extends EntityResource<MlModel, MlModelRepository>
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteMlModel",
summary = "Delete an ML Model",
tags = "mlModels",
description = "Delete an ML Model by `id`.",

2
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/permissions/PermissionsResource.java
View File

@ -46,7 +46,7 @@ public class PermissionsResource {
@GET
@Operation(
summary = "Get permissions for logged in user",
tags = "general",
tags = "permission",
responses = {
@ApiResponse(
responseCode = "200",

32
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/pipelines/PipelineResource.java
View File

@ -60,6 +60,7 @@ import org.openmetadata.catalog.resources.Collection;
import org.openmetadata.catalog.resources.EntityResource;
import org.openmetadata.catalog.security.Authorizer;
import org.openmetadata.catalog.security.SecurityUtil;
import org.openmetadata.catalog.type.ChangeEvent;
import org.openmetadata.catalog.type.EntityHistory;
import org.openmetadata.catalog.type.Include;
import org.openmetadata.catalog.util.RestUtil;
@ -102,6 +103,7 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@GET
@Valid
@Operation(
operationId = "listPipelines",
summary = "List Pipelines",
tags = "pipelines",
description =
@ -153,6 +155,7 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllPipelineVersion",
summary = "List pipeline versions",
tags = "pipelines",
description = "Get a list of all the versions of a pipeline identified by `id`",
@ -173,6 +176,7 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@GET
@Path("/{id}")
@Operation(
operationId = "getPipelineWithID",
summary = "Get a pipeline",
tags = "pipelines",
description = "Get a pipeline by `id`.",
@ -205,6 +209,7 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@GET
@Path("/name/{fqn}")
@Operation(
operationId = "getPipelineByFQN",
summary = "Get a pipeline by name",
tags = "pipelines",
description = "Get a pipeline by fully qualified name.",
@ -237,6 +242,7 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificPipelineVersion",
summary = "Get a version of the pipeline",
tags = "pipelines",
description = "Get a version of the pipeline by given `id`",
@ -264,6 +270,7 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@POST
@Operation(
operationId = "createPipeline",
summary = "Create a pipeline",
tags = "pipelines",
description = "Create a new pipeline.",
@ -271,8 +278,7 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@ApiResponse(
responseCode = "200",
description = "The pipeline",
content =
@Content(mediaType = "application/json", schema = @Schema(implementation = CreatePipeline.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Pipeline.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@ -285,6 +291,7 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchPipeline",
summary = "Update a Pipeline",
tags = "pipelines",
description = "Update an existing pipeline using JsonPatch.",
@ -309,6 +316,7 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@PUT
@Operation(
operationId = "createOrUpdatePipeline",
summary = "Create or update a pipeline",
tags = "pipelines",
description = "Create a new pipeline, if it does not exist or update an existing pipeline.",
@ -316,8 +324,7 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@ApiResponse(
responseCode = "200",
description = "The pipeline",
content =
@Content(mediaType = "application/json", schema = @Schema(implementation = CreatePipeline.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Pipeline.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createOrUpdate(
@ -330,6 +337,7 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@PUT
@Path("/{id}/status")
@Operation(
operationId = "addStatusData",
summary = "Add status data",
tags = "pipelines",
description = "Add status data to the pipeline.",
@ -354,11 +362,15 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@PUT
@Path("/{id}/followers")
@Operation(
operationId = "addFollower",
summary = "Add a follower",
tags = "pipelines",
description = "Add a user identified by `userId` as follower of this pipeline",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ChangeEvent.class))),
@ApiResponse(responseCode = "404", description = "Pipeline for instance {id} is not found")
})
public Response addFollower(
@ -375,9 +387,16 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@DELETE
@Path("/{id}/followers/{userId}")
@Operation(
operationId = "deleteFollower",
summary = "Remove a follower",
tags = "pipelines",
description = "Remove the user identified `userId` as a follower of the pipeline.")
description = "Remove the user identified `userId` as a follower of the pipeline.",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ChangeEvent.class)))
})
public Response deleteFollower(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -394,6 +413,7 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
@DELETE
@Path("/{id}")
@Operation(
operationId = "deletePipeline",
summary = "Delete a Pipeline",
tags = "pipelines",
description = "Delete a pipeline by `id`.",

11
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/policies/PolicyResource.java
View File

@ -108,6 +108,7 @@ public class PolicyResource extends EntityResource<Policy, PolicyRepository> {
@GET
@Valid
@Operation(
operationId = "listPolicies",
summary = "List Policies",
tags = "policies",
description =
@ -154,6 +155,7 @@ public class PolicyResource extends EntityResource<Policy, PolicyRepository> {
@GET
@Path("/{id}")
@Operation(
operationId = "getPolicyByID",
summary = "Get a policy",
tags = "policies",
description = "Get a policy by `id`.",
@ -186,6 +188,7 @@ public class PolicyResource extends EntityResource<Policy, PolicyRepository> {
@GET
@Path("/name/{fqn}")
@Operation(
operationId = "getPolicyByFQN",
summary = "Get a policy by name",
tags = "policies",
description = "Get a policy by fully qualified name.",
@ -218,6 +221,7 @@ public class PolicyResource extends EntityResource<Policy, PolicyRepository> {
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllPolicyVersion",
summary = "List policy versions",
tags = "policies",
description = "Get a list of all the versions of a policy identified by `id`",
@ -238,6 +242,7 @@ public class PolicyResource extends EntityResource<Policy, PolicyRepository> {
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificPolicyVersion",
summary = "Get a version of the policy",
tags = "policies",
description = "Get a version of the policy by given `id`",
@ -265,6 +270,7 @@ public class PolicyResource extends EntityResource<Policy, PolicyRepository> {
@POST
@Operation(
operationId = "createPolicy",
summary = "Create a policy",
tags = "policies",
description = "Create a new policy.",
@ -272,7 +278,7 @@ public class PolicyResource extends EntityResource<Policy, PolicyRepository> {
@ApiResponse(
responseCode = "200",
description = "The policy",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreatePolicy.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Policy.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(@Context UriInfo uriInfo, @Context SecurityContext securityContext, @Valid CreatePolicy create)
@ -286,6 +292,7 @@ public class PolicyResource extends EntityResource<Policy, PolicyRepository> {
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchPolicy",
summary = "Update a policy",
tags = "policies",
description = "Update an existing policy using JsonPatch.",
@ -312,6 +319,7 @@ public class PolicyResource extends EntityResource<Policy, PolicyRepository> {
@PUT
@Operation(
operationId = "createOrUpdatePolicy",
summary = "Create or update a policy",
tags = "policies",
description = "Create a new policy, if it does not exist or update an existing policy.",
@ -334,6 +342,7 @@ public class PolicyResource extends EntityResource<Policy, PolicyRepository> {
@DELETE
@Path("/{id}")
@Operation(
operationId = "deletePolicy",
summary = "Delete a Policy",
tags = "policies",
description = "Delete a policy by `id`.",

4
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/reports/ReportResource.java
View File

@ -79,6 +79,7 @@ public class ReportResource extends EntityResource<Report, ReportRepository> {
@GET
@Operation(
operationId = "listReports",
summary = "List reports",
tags = "reports",
description = "Get a list of reports. Use `fields` parameter to get only necessary fields.",
@ -104,6 +105,7 @@ public class ReportResource extends EntityResource<Report, ReportRepository> {
@GET
@Path("/{id}")
@Operation(
operationId = "getReportByID",
summary = "Get a report",
tags = "reports",
description = "Get a report by `id`.",
@ -135,6 +137,7 @@ public class ReportResource extends EntityResource<Report, ReportRepository> {
@POST
@Operation(
operationId = "getReportByFQN",
summary = "Create a report",
tags = "reports",
description = "Create a new report.",
@ -153,6 +156,7 @@ public class ReportResource extends EntityResource<Report, ReportRepository> {
@PUT
@Operation(
operationId = "createOrUpdateReport",
summary = "Create or update a report",
tags = "reports",
description = "Create a new report, it it does not exist or update an existing report.",

4
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/search/SearchResource.java
View File

@ -73,6 +73,7 @@ public class SearchResource {
@GET
@Path("/query")
@Operation(
operationId = "searchEntitiesWithQuery",
summary = "Search entities",
tags = "search",
description =
@ -182,6 +183,7 @@ public class SearchResource {
@GET
@Path("/suggest")
@Operation(
operationId = "getSuggestedEntities",
summary = "Suggest entities",
tags = "search",
description = "Get suggested entities used for auto-completion.",
@ -189,7 +191,7 @@ public class SearchResource {
@ApiResponse(
responseCode = "200",
description = "Table Suggestion API",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = SearchResponse.class)))
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Suggest.class)))
})
public Response suggest(
@Context UriInfo uriInfo,

4
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/services/ServiceResource.java
View File

@ -29,7 +29,6 @@ import org.openmetadata.catalog.resources.CatalogResource.CollectionList;
import org.openmetadata.catalog.resources.Collection;
import org.openmetadata.catalog.resources.CollectionRegistry;
import org.openmetadata.catalog.type.CollectionDescriptor;
import org.openmetadata.catalog.type.CollectionInfo;
@Path("/v1/services")
@Api(value = "Services collection", tags = "Services collection")
@ -48,6 +47,7 @@ public class ServiceResource {
@GET
@Operation(
operationId = "listServiceCollection",
summary = "List service collections",
tags = "services",
description = "Get a list of resources under service collection.",
@ -55,7 +55,7 @@ public class ServiceResource {
@ApiResponse(
responseCode = "200",
description = "List of serviceCollections",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CollectionInfo.class)))
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CollectionList.class)))
})
public CollectionList getCollections(@Context UriInfo uriInfo) {
return getServiceList(uriInfo);

32
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/services/dashboard/DashboardServiceResource.java
View File

@ -90,8 +90,9 @@ public class DashboardServiceResource extends EntityResource<DashboardService, D
@GET
@Operation(
operationId = "listDashboardsService",
summary = "List dashboard services",
tags = "services",
tags = "dashboardServices",
description = "Get a list of dashboard services.",
responses = {
@ApiResponse(
@ -133,8 +134,9 @@ public class DashboardServiceResource extends EntityResource<DashboardService, D
@GET
@Path("/{id}")
@Operation(
operationId = "getDashboardServiceByID",
summary = "Get a dashboard service",
tags = "services",
tags = "dashboardServices",
description = "Get a dashboard service by `id`.",
responses = {
@ApiResponse(
@ -166,8 +168,9 @@ public class DashboardServiceResource extends EntityResource<DashboardService, D
@GET
@Path("/name/{name}")
@Operation(
operationId = "getDashboardServiceByFQN",
summary = "Get dashboard service by name",
tags = "services",
tags = "dashboardServices",
description = "Get a dashboard service by the service `name`.",
responses = {
@ApiResponse(
@ -199,8 +202,9 @@ public class DashboardServiceResource extends EntityResource<DashboardService, D
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllDashboardServiceVersion",
summary = "List dashboard service versions",
tags = "services",
tags = "dashboardServices",
description = "Get a list of all the versions of a dashboard service identified by `id`",
responses = {
@ApiResponse(
@ -219,8 +223,9 @@ public class DashboardServiceResource extends EntityResource<DashboardService, D
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificDashboardServiceVersion",
summary = "Get a version of the dashboard service",
tags = "services",
tags = "dashboardServices",
description = "Get a version of the dashboard service by given `id`",
responses = {
@ApiResponse(
@ -247,17 +252,16 @@ public class DashboardServiceResource extends EntityResource<DashboardService, D
@POST
@Operation(
operationId = "createDashboardService",
summary = "Create a dashboard service",
tags = "services",
tags = "dashboardServices",
description = "Create a new dashboard service.",
responses = {
@ApiResponse(
responseCode = "200",
description = "Dashboard service instance",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = CreateDashboardService.class))),
@Content(mediaType = "application/json", schema = @Schema(implementation = DashboardService.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@ -269,17 +273,16 @@ public class DashboardServiceResource extends EntityResource<DashboardService, D
@PUT
@Operation(
operationId = "createOrUpdateDashboardService",
summary = "Update a Dashboard service",
tags = "services",
tags = "dashboardServices",
description = "Update an existing dashboard service identified by `id`.",
responses = {
@ApiResponse(
responseCode = "200",
description = "Dashboard service instance",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = CreateDashboardService.class))),
@Content(mediaType = "application/json", schema = @Schema(implementation = DashboardService.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createOrUpdate(
@ -292,8 +295,9 @@ public class DashboardServiceResource extends EntityResource<DashboardService, D
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteDashboardService",
summary = "Delete a Dashboard service",
tags = "services",
tags = "dashboardServices",
description =
"Delete a Dashboard services. If dashboard (and charts) belong to the service, it can't be " + "deleted.",
responses = {

32
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/services/database/DatabaseServiceResource.java
View File

@ -93,8 +93,9 @@ public class DatabaseServiceResource extends EntityResource<DatabaseService, Dat
@GET
@Operation(
operationId = "listDatabaseServices",
summary = "List database services",
tags = "services",
tags = "databaseService",
description = "Get a list of database services.",
responses = {
@ApiResponse(
@ -143,8 +144,9 @@ public class DatabaseServiceResource extends EntityResource<DatabaseService, Dat
@GET
@Path("/{id}")
@Operation(
operationId = "getDatabaseServiceByID",
summary = "Get a database service",
tags = "services",
tags = "databaseService",
description = "Get a database service by `id`.",
responses = {
@ApiResponse(
@ -176,8 +178,9 @@ public class DatabaseServiceResource extends EntityResource<DatabaseService, Dat
@GET
@Path("/name/{name}")
@Operation(
operationId = "getDatabaseServiceByFQN",
summary = "Get database service by name",
tags = "services",
tags = "databaseService",
description = "Get a database service by the service `name`.",
responses = {
@ApiResponse(
@ -209,8 +212,9 @@ public class DatabaseServiceResource extends EntityResource<DatabaseService, Dat
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllDatabaseServiceVersion",
summary = "List database service versions",
tags = "services",
tags = "databaseService",
description = "Get a list of all the versions of a database service identified by `id`",
responses = {
@ApiResponse(
@ -243,8 +247,9 @@ public class DatabaseServiceResource extends EntityResource<DatabaseService, Dat
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificDatabaseServiceVersion",
summary = "Get a version of the database service",
tags = "services",
tags = "databaseService",
description = "Get a version of the database service by given `id`",
responses = {
@ApiResponse(
@ -271,17 +276,16 @@ public class DatabaseServiceResource extends EntityResource<DatabaseService, Dat
@POST
@Operation(
operationId = "createDatabaseService",
summary = "Create database service",
tags = "services",
tags = "databaseService",
description = "Create a new database service.",
responses = {
@ApiResponse(
responseCode = "200",
description = "Database service instance",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = CreateDatabaseService.class))),
@Content(mediaType = "application/json", schema = @Schema(implementation = DatabaseService.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@ -293,17 +297,16 @@ public class DatabaseServiceResource extends EntityResource<DatabaseService, Dat
@PUT
@Operation(
operationId = "createOrUpdateDatabaseService",
summary = "Update database service",
tags = "services",
tags = "databaseService",
description = "Update an existing or create a new database service.",
responses = {
@ApiResponse(
responseCode = "200",
description = "Database service instance",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = CreateDatabaseService.class))),
@Content(mediaType = "application/json", schema = @Schema(implementation = DatabaseService.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createOrUpdate(
@ -316,8 +319,9 @@ public class DatabaseServiceResource extends EntityResource<DatabaseService, Dat
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteDatabaseService",
summary = "Delete a database service",
tags = "services",
tags = "databaseService",
description =
"Delete a database services. If databases (and tables) belong the service, it can't be " + "deleted.",
responses = {

16
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/services/ingestionpipelines/IngestionPipelineResource.java
View File

@ -123,6 +123,7 @@ public class IngestionPipelineResource extends EntityResource<IngestionPipeline,
@GET
@Valid
@Operation(
operationId = "listIngestionPipelines",
summary = "List Ingestion Pipelines for Metadata Operations",
tags = "IngestionPipelines",
description =
@ -180,6 +181,7 @@ public class IngestionPipelineResource extends EntityResource<IngestionPipeline,
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllIngestionPipelineVersion",
summary = "List ingestion workflow versions",
tags = "IngestionPipelines",
description = "Get a list of all the versions of a IngestionPipeline identified by `id`",
@ -200,6 +202,7 @@ public class IngestionPipelineResource extends EntityResource<IngestionPipeline,
@GET
@Path("/{id}")
@Operation(
operationId = "getIngestionPipelineByID",
summary = "Get a IngestionPipeline",
tags = "IngestionPipelines",
description = "Get a IngestionPipeline by `id`.",
@ -237,6 +240,7 @@ public class IngestionPipelineResource extends EntityResource<IngestionPipeline,
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificIngestionPipelineVersion",
summary = "Get a version of the IngestionPipeline",
tags = "IngestionPipelines",
description = "Get a version of the IngestionPipeline by given `id`",
@ -266,6 +270,7 @@ public class IngestionPipelineResource extends EntityResource<IngestionPipeline,
@GET
@Path("/name/{fqn}")
@Operation(
operationId = "getSpecificIngestionPipelineByFQN",
summary = "Get a IngestionPipeline by name",
tags = "IngestionPipelines",
description = "Get a ingestion by fully qualified name.",
@ -302,6 +307,7 @@ public class IngestionPipelineResource extends EntityResource<IngestionPipeline,
@POST
@Operation(
operationId = "createIngestionPipeline",
summary = "Create a Ingestion Pipeline",
tags = "IngestionPipelines",
description = "Create a new Ingestion Pipeline.",
@ -310,9 +316,7 @@ public class IngestionPipelineResource extends EntityResource<IngestionPipeline,
responseCode = "200",
description = "The Ingestion Pipeline",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = CreateIngestionPipeline.class))),
@Content(mediaType = "application/json", schema = @Schema(implementation = IngestionPipeline.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@ -325,6 +329,7 @@ public class IngestionPipelineResource extends EntityResource<IngestionPipeline,
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchIngestionPipeline",
summary = "Update a IngestionPipeline",
tags = "IngestionPipelines",
description = "Update an existing IngestionPipeline using JsonPatch.",
@ -349,6 +354,7 @@ public class IngestionPipelineResource extends EntityResource<IngestionPipeline,
@PUT
@Operation(
operationId = "createOrUpdateIngestionPipeline",
summary = "Create or update a IngestionPipeline",
tags = "IngestionPipelines",
description = "Create a new IngestionPipeline, if it does not exist or update an existing IngestionPipeline.",
@ -393,6 +399,7 @@ public class IngestionPipelineResource extends EntityResource<IngestionPipeline,
@POST
@Path("/trigger/{id}")
@Operation(
operationId = "triggerIngestionPipelineRun",
summary = "Trigger a ingestion pipeline run",
tags = "IngestionPipelines",
description = "Trigger a ingestion pipeline run by id.",
@ -416,6 +423,7 @@ public class IngestionPipelineResource extends EntityResource<IngestionPipeline,
@POST
@Path("/testConnection")
@Operation(
operationId = "testConnection",
summary = "Test Connection of a Service",
tags = "IngestionPipelines",
description = "Test Connection of a Service.",
@ -436,6 +444,7 @@ public class IngestionPipelineResource extends EntityResource<IngestionPipeline,
@GET
@Path("/status")
@Operation(
operationId = "checkRestAirflowStatus",
summary = "Check the Airflow REST status",
tags = "IngestionPipelines",
description = "Check that the Airflow REST endpoint is reachable and up and running",
@ -453,6 +462,7 @@ public class IngestionPipelineResource extends EntityResource<IngestionPipeline,
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteIngestionPipeline",
summary = "Delete a Ingestion",
tags = "IngestionPipelines",
description = "Delete a ingestion by `id`.",

32
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/services/messaging/MessagingServiceResource.java
View File

@ -90,8 +90,9 @@ public class MessagingServiceResource extends EntityResource<MessagingService, M
@GET
@Operation(
operationId = "listMessagingService",
summary = "List messaging services",
tags = "services",
tags = "MessagingService",
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.",
@ -136,8 +137,9 @@ public class MessagingServiceResource extends EntityResource<MessagingService, M
@GET
@Path("/{id}")
@Operation(
operationId = "getMessagingServiceByID",
summary = "Get a messaging service",
tags = "services",
tags = "MessagingService",
description = "Get a messaging service by `id`.",
responses = {
@ApiResponse(
@ -169,8 +171,9 @@ public class MessagingServiceResource extends EntityResource<MessagingService, M
@GET
@Path("/name/{name}")
@Operation(
operationId = "getMessagingServiceByFQN",
summary = "Get messaging service by name",
tags = "services",
tags = "MessagingService",
description = "Get a messaging service by the service `name`.",
responses = {
@ApiResponse(
@ -202,8 +205,9 @@ public class MessagingServiceResource extends EntityResource<MessagingService, M
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllMessagingServiceVersion",
summary = "List messaging service versions",
tags = "services",
tags = "MessagingService",
description = "Get a list of all the versions of a messaging service identified by `id`",
responses = {
@ApiResponse(
@ -222,8 +226,9 @@ public class MessagingServiceResource extends EntityResource<MessagingService, M
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificMessagingServiceVersion",
summary = "Get a version of the messaging service",
tags = "services",
tags = "MessagingService",
description = "Get a version of the messaging service by given `id`",
responses = {
@ApiResponse(
@ -250,17 +255,16 @@ public class MessagingServiceResource extends EntityResource<MessagingService, M
@POST
@Operation(
operationId = "createMessagingService",
summary = "Create a messaging service",
tags = "services",
tags = "MessagingService",
description = "Create a new messaging service.",
responses = {
@ApiResponse(
responseCode = "200",
description = "Messaging service instance",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = CreateMessagingService.class))),
@Content(mediaType = "application/json", schema = @Schema(implementation = MessagingService.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@ -272,17 +276,16 @@ public class MessagingServiceResource extends EntityResource<MessagingService, M
@PUT
@Operation(
operationId = "createOrUpdateMessagingService",
summary = "Update messaging service",
tags = "services",
tags = "MessagingService",
description = "Create a new messaging service or Update an existing messaging service identified by `id`.",
responses = {
@ApiResponse(
responseCode = "200",
description = "Messaging service instance",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = CreateMessagingService.class))),
@Content(mediaType = "application/json", schema = @Schema(implementation = MessagingService.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createOrUpdate(
@ -299,8 +302,9 @@ public class MessagingServiceResource extends EntityResource<MessagingService, M
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteMessagingService",
summary = "Delete a messaging service",
tags = "services",
tags = "MessagingService",
description = "Delete a messaging service. If topics belong the service, it can't be " + "deleted.",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),

32
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/services/pipeline/PipelineServiceResource.java
View File

@ -90,8 +90,9 @@ public class PipelineServiceResource extends EntityResource<PipelineService, Pip
@GET
@Operation(
operationId = "listPipelineService",
summary = "List pipeline services",
tags = "services",
tags = "pipelineService",
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.",
@ -136,8 +137,9 @@ public class PipelineServiceResource extends EntityResource<PipelineService, Pip
@GET
@Path("/{id}")
@Operation(
operationId = "getPipelineServiceByID",
summary = "Get a pipeline service",
tags = "services",
tags = "pipelineService",
description = "Get a pipeline service by `id`.",
responses = {
@ApiResponse(
@ -169,8 +171,9 @@ public class PipelineServiceResource extends EntityResource<PipelineService, Pip
@GET
@Path("/name/{name}")
@Operation(
operationId = "getPipelineServiceByFQN",
summary = "Get pipeline service by name",
tags = "services",
tags = "pipelineService",
description = "Get a pipeline service by the service `name`.",
responses = {
@ApiResponse(
@ -202,8 +205,9 @@ public class PipelineServiceResource extends EntityResource<PipelineService, Pip
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllPipelineServiceVersion",
summary = "List pipeline service versions",
tags = "services",
tags = "pipelineService",
description = "Get a list of all the versions of a pipeline service identified by `id`",
responses = {
@ApiResponse(
@ -222,8 +226,9 @@ public class PipelineServiceResource extends EntityResource<PipelineService, Pip
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificPipelineService",
summary = "Get a version of the pipeline service",
tags = "services",
tags = "pipelineService",
description = "Get a version of the pipeline service by given `id`",
responses = {
@ApiResponse(
@ -250,17 +255,16 @@ public class PipelineServiceResource extends EntityResource<PipelineService, Pip
@POST
@Operation(
operationId = "createPipelineService",
summary = "Create a pipeline service",
tags = "services",
tags = "pipelineService",
description = "Create a new pipeline service.",
responses = {
@ApiResponse(
responseCode = "200",
description = "Pipeline service instance",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = CreatePipelineService.class))),
@Content(mediaType = "application/json", schema = @Schema(implementation = PipelineService.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@ -272,17 +276,16 @@ public class PipelineServiceResource extends EntityResource<PipelineService, Pip
@PUT
@Operation(
operationId = "createOrUpdatePipelineService",
summary = "Update pipeline service",
tags = "services",
tags = "pipelineService",
description = "Create a new pipeline service or update an existing pipeline service identified by `id`.",
responses = {
@ApiResponse(
responseCode = "200",
description = "Pipeline service instance",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = CreatePipelineService.class))),
@Content(mediaType = "application/json", schema = @Schema(implementation = PipelineService.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createOrUpdate(
@ -295,8 +298,9 @@ public class PipelineServiceResource extends EntityResource<PipelineService, Pip
@DELETE
@Path("/{id}")
@Operation(
operationId = "deletePipelineService",
summary = "Delete a pipeline service",
tags = "services",
tags = "pipelineService",
description =
"Delete a pipeline services. If pipelines (and tasks) belong to the service, it can't be " + "deleted.",
responses = {

24
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/services/storage/StorageServiceResource.java
View File

@ -90,8 +90,9 @@ public class StorageServiceResource extends EntityResource<StorageService, Stora
@GET
@Operation(
operationId = "listStorageService",
summary = "List storage services",
tags = "services",
tags = "storageService",
description =
"Get a list of storage services. Use cursor-based pagination to limit the number "
+ "entries in the list using `limit` and `before` or `after` query params.",
@ -136,8 +137,9 @@ public class StorageServiceResource extends EntityResource<StorageService, Stora
@GET
@Path("/{id}")
@Operation(
operationId = "getStorageServiceByID",
summary = "Get a storage service",
tags = "services",
tags = "storageService",
description = "Get a storage service by `id`.",
responses = {
@ApiResponse(
@ -169,8 +171,9 @@ public class StorageServiceResource extends EntityResource<StorageService, Stora
@GET
@Path("/name/{name}")
@Operation(
operationId = "getStorageServiceByFQN",
summary = "Get storage service by name",
tags = "services",
tags = "storageService",
description = "Get a storage service by the service `name`.",
responses = {
@ApiResponse(
@ -202,8 +205,9 @@ public class StorageServiceResource extends EntityResource<StorageService, Stora
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllStorageServiceVersion",
summary = "List storage service versions",
tags = "services",
tags = "storageService",
description = "Get a list of all the versions of a storage service identified by `id`",
responses = {
@ApiResponse(
@ -222,8 +226,9 @@ public class StorageServiceResource extends EntityResource<StorageService, Stora
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificStorageServiceVersion",
summary = "Get a version of the storage service",
tags = "services",
tags = "storageService",
description = "Get a version of the storage service by given `id`",
responses = {
@ApiResponse(
@ -250,8 +255,9 @@ public class StorageServiceResource extends EntityResource<StorageService, Stora
@POST
@Operation(
operationId = "createStorageService",
summary = "Create storage service",
tags = "services",
tags = "storageService",
description = "Create a new storage service.",
responses = {
@ApiResponse(
@ -270,8 +276,9 @@ public class StorageServiceResource extends EntityResource<StorageService, Stora
@PUT
@Operation(
operationId = "createOrUpdateStorageService",
summary = "Update storage service",
tags = "services",
tags = "storageService",
description = "Update an existing storage service identified by `id`.",
responses = {
@ApiResponse(
@ -291,8 +298,9 @@ public class StorageServiceResource extends EntityResource<StorageService, Stora
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteStorageService",
summary = "Delete a storage service",
tags = "services",
tags = "storageService",
description = "Delete a storage services. If storages (and tables) belong the service, it can't be " + "deleted.",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),

24
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/tags/TagResource.java
View File

@ -128,6 +128,7 @@ public class TagResource {
@GET
@Operation(
operationId = "listTagCategories",
summary = "List tag categories",
tags = "tags",
description = "Get a list of tag categories.",
@ -156,6 +157,7 @@ public class TagResource {
@GET
@Path("{category}")
@Operation(
operationId = "getTagCategoryByName",
summary = "Get a tag category",
tags = "tags",
description =
@ -185,6 +187,7 @@ public class TagResource {
@GET
@Operation(
operationId = "getPrimaryTag",
summary = "Get a primary tag",
tags = "tags",
description =
@ -227,6 +230,7 @@ public class TagResource {
@GET
@Path("{category}/{primaryTag}/{secondaryTag}")
@Operation(
operationId = "getSecondaryTag",
summary = "Get a secondary tag",
tags = "tags",
description = "Get a secondary tag identified by name.",
@ -273,6 +277,7 @@ public class TagResource {
@POST
@Operation(
operationId = "createTagCategory",
summary = "Create a tag category",
tags = "tags",
description =
@ -282,8 +287,7 @@ public class TagResource {
@ApiResponse(
responseCode = "200",
description = "The user ",
content =
@Content(mediaType = "application/json", schema = @Schema(implementation = CreateTagCategory.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = TagCategory.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createCategory(
@ -298,6 +302,7 @@ public class TagResource {
@POST
@Path("{category}")
@Operation(
operationId = "createPrimaryTag",
summary = "Create a primary tag",
tags = "tags",
description = "Create a primary tag in the given tag category.",
@ -305,7 +310,7 @@ public class TagResource {
@ApiResponse(
responseCode = "200",
description = "The user ",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateTag.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Tag.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createPrimaryTag(
@ -325,6 +330,7 @@ public class TagResource {
@POST
@Path("{category}/{primaryTag}")
@Operation(
operationId = "createSecondaryTag",
summary = "Create a secondary tag",
tags = "tags",
description = "Create a secondary tag under the given primary tag.",
@ -332,7 +338,7 @@ public class TagResource {
@ApiResponse(
responseCode = "200",
description = "The user ",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateTag.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Tag.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createSecondaryTag(
@ -361,6 +367,7 @@ public class TagResource {
@PUT
@Path("{category}")
@Operation(
operationId = "createOrUpdateTagCategory",
summary = "Update a tag category",
tags = "tags",
description = "Update an existing category identify by category name")
@ -386,6 +393,7 @@ public class TagResource {
@PUT
@Path("{category}/{primaryTag}")
@Operation(
operationId = "createOrUpdatePrimaryTag",
summary = "Update a primaryTag",
tags = "tags",
description = "Update an existing primaryTag identify by name")
@ -420,6 +428,7 @@ public class TagResource {
@PUT
@Path("{category}/{primaryTag}/{secondaryTag}")
@Operation(
operationId = "createOrUpdateSecondaryTag",
summary = "Update a secondaryTag",
tags = "tags",
description = "Update an existing secondaryTag identify by name")
@ -465,6 +474,7 @@ public class TagResource {
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteTagCategory",
summary = "Delete tag category",
tags = "tags",
description = "Delete a tag category and all the tags under it.")
@ -480,7 +490,11 @@ public class TagResource {
@DELETE
@Path("/{category}/{id}")
@Operation(summary = "Delete tag", tags = "tags", description = "Delete a tag and all the tags under it.")
@Operation(
operationId = "deleteTags",
summary = "Delete tag",
tags = "tags",
description = "Delete a tag and all the tags under it.")
public Tag deleteTags(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,

13
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/teams/RoleResource.java
View File

@ -130,6 +130,7 @@ public class RoleResource extends EntityResource<Role, RoleRepository> {
@GET
@Valid
@Operation(
operationId = "listRoles",
summary = "List roles",
tags = "roles",
description =
@ -190,6 +191,7 @@ public class RoleResource extends EntityResource<Role, RoleRepository> {
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllRoleVersion",
summary = "List role versions",
tags = "roles",
description = "Get a list of all the versions of a role identified by `id`",
@ -211,6 +213,7 @@ public class RoleResource extends EntityResource<Role, RoleRepository> {
@Valid
@Path("/{id}")
@Operation(
operationId = "getRoleByID",
summary = "Get a role",
tags = "roles",
description = "Get a role by `id`.",
@ -244,6 +247,7 @@ public class RoleResource extends EntityResource<Role, RoleRepository> {
@Valid
@Path("/name/{name}")
@Operation(
operationId = "getRoleByFQN",
summary = "Get a role by name",
tags = "roles",
description = "Get a role by `name`.",
@ -276,6 +280,7 @@ public class RoleResource extends EntityResource<Role, RoleRepository> {
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificRoleVersion",
summary = "Get a version of the role",
tags = "roles",
description = "Get a version of the role by given `id`",
@ -303,6 +308,7 @@ public class RoleResource extends EntityResource<Role, RoleRepository> {
@POST
@Operation(
operationId = "createRole",
summary = "Create a role",
tags = "roles",
description = "Create a new role.",
@ -310,7 +316,7 @@ public class RoleResource extends EntityResource<Role, RoleRepository> {
@ApiResponse(
responseCode = "200",
description = "The role",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateRole.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Role.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@ -324,6 +330,7 @@ public class RoleResource extends EntityResource<Role, RoleRepository> {
@PUT
@Operation(
operationId = "createOrUpdateRole",
summary = "Update role",
tags = "roles",
description = "Create or Update a role.",
@ -331,7 +338,7 @@ public class RoleResource extends EntityResource<Role, RoleRepository> {
@ApiResponse(
responseCode = "200",
description = "The role ",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateRole.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Role.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createOrUpdateRole(
@ -347,6 +354,7 @@ public class RoleResource extends EntityResource<Role, RoleRepository> {
@Path("/{id}")
@Consumes(MediaType.APPLICATION_JSON_PATCH_JSON)
@Operation(
operationId = "patchRole",
summary = "Update a role",
tags = "roles",
description = "Update an existing role with JsonPatch.",
@ -373,6 +381,7 @@ public class RoleResource extends EntityResource<Role, RoleRepository> {
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteRole",
summary = "Delete a role",
tags = "roles",
description = "Delete a role by given `id`.",

13
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/teams/TeamResource.java
View File

@ -96,6 +96,7 @@ public class TeamResource extends EntityResource<Team, TeamRepository> {
@GET
@Valid
@Operation(
operationId = "listTeams",
summary = "List teams",
tags = "teams",
description =
@ -142,6 +143,7 @@ public class TeamResource extends EntityResource<Team, TeamRepository> {
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllTeamVersion",
summary = "List team versions",
tags = "teams",
description = "Get a list of all the versions of a team identified by `id`",
@ -163,6 +165,7 @@ public class TeamResource extends EntityResource<Team, TeamRepository> {
@Valid
@Path("/{id}")
@Operation(
operationId = "getTeamByID",
summary = "Get a team",
tags = "teams",
description = "Get a team by `id`.",
@ -196,6 +199,7 @@ public class TeamResource extends EntityResource<Team, TeamRepository> {
@Valid
@Path("/name/{name}")
@Operation(
operationId = "getTeamByFQN",
summary = "Get a team by name",
tags = "teams",
description = "Get a team by `name`.",
@ -228,6 +232,7 @@ public class TeamResource extends EntityResource<Team, TeamRepository> {
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificRoleVersion",
summary = "Get a version of the team",
tags = "teams",
description = "Get a version of the team by given `id`",
@ -255,6 +260,7 @@ public class TeamResource extends EntityResource<Team, TeamRepository> {
@POST
@Operation(
operationId = "createTeam",
summary = "Create a team",
tags = "teams",
description = "Create a new team.",
@ -262,7 +268,7 @@ public class TeamResource extends EntityResource<Team, TeamRepository> {
@ApiResponse(
responseCode = "200",
description = "The team",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateTeam.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Team.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(@Context UriInfo uriInfo, @Context SecurityContext securityContext, @Valid CreateTeam ct)
@ -273,6 +279,7 @@ public class TeamResource extends EntityResource<Team, TeamRepository> {
@PUT
@Operation(
operationId = "createOrUpdateTeam",
summary = "Update team",
tags = "teams",
description = "Create or Update a team.",
@ -280,7 +287,7 @@ public class TeamResource extends EntityResource<Team, TeamRepository> {
@ApiResponse(
responseCode = "200",
description = "The team ",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateTeam.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Team.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createOrUpdate(
@ -293,6 +300,7 @@ public class TeamResource extends EntityResource<Team, TeamRepository> {
@Path("/{id}")
@Consumes(MediaType.APPLICATION_JSON_PATCH_JSON)
@Operation(
operationId = "patchTeam",
summary = "Update a team",
tags = "teams",
description = "Update an existing team with JsonPatch.",
@ -317,6 +325,7 @@ public class TeamResource extends EntityResource<Team, TeamRepository> {
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteTeam",
summary = "Delete a team",
tags = "teams",
description = "Delete a team by given `id`.",

14
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/teams/UserResource.java
View File

@ -115,6 +115,7 @@ public class UserResource extends EntityResource<User, UserRepository> {
@GET
@Valid
@Operation(
operationId = "listUsers",
summary = "List users",
tags = "users",
description =
@ -164,6 +165,7 @@ public class UserResource extends EntityResource<User, UserRepository> {
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllUserVersion",
summary = "List user versions",
tags = "users",
description = "Get a list of all the versions of a user identified by `id`",
@ -185,6 +187,7 @@ public class UserResource extends EntityResource<User, UserRepository> {
@Valid
@Path("/{id}")
@Operation(
operationId = "getUserByID",
summary = "Get a user",
tags = "users",
description = "Get a user by `id`",
@ -218,6 +221,7 @@ public class UserResource extends EntityResource<User, UserRepository> {
@Valid
@Path("/name/{name}")
@Operation(
operationId = "getUserByFQN",
summary = "Get a user by name",
tags = "users",
description = "Get a user by `name`.",
@ -251,6 +255,7 @@ public class UserResource extends EntityResource<User, UserRepository> {
@Valid
@Path("/loggedInUser")
@Operation(
operationId = "getCurrentLoggedInUser",
summary = "Get current logged in user",
tags = "users",
description = "Get the user who is authenticated and is currently logged in.",
@ -279,6 +284,7 @@ public class UserResource extends EntityResource<User, UserRepository> {
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificUserVersion",
summary = "Get a version of the user",
tags = "users",
description = "Get a version of the user by given `id`",
@ -306,6 +312,7 @@ public class UserResource extends EntityResource<User, UserRepository> {
@POST
@Operation(
operationId = "createUser",
summary = "Create a user",
tags = "users",
description = "Create a new user.",
@ -313,7 +320,7 @@ public class UserResource extends EntityResource<User, UserRepository> {
@ApiResponse(
responseCode = "200",
description = "The user ",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateUser.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = User.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createUser(
@ -355,6 +362,7 @@ public class UserResource extends EntityResource<User, UserRepository> {
@PUT
@Path("/generateToken/{id}")
@Operation(
operationId = "generateJWTTokenForBotUser",
summary = "Generate JWT Token for a Bot User",
tags = "users",
description = "Generate JWT Token for a Bot User.",
@ -391,6 +399,7 @@ public class UserResource extends EntityResource<User, UserRepository> {
@PUT
@Path("/revokeToken/{id}")
@Operation(
operationId = "revokeJWTTokenForBotUser",
summary = "Revoke JWT Token for a Bot User",
tags = "users",
description = "Revoke JWT Token for a Bot User.",
@ -423,6 +432,7 @@ public class UserResource extends EntityResource<User, UserRepository> {
@GET
@Path("/token/{id}")
@Operation(
operationId = "getJWTTokenForBotUser",
summary = "Get JWT Token for a Bot User",
tags = "users",
description = "Get JWT Token for a Bot User.",
@ -456,6 +466,7 @@ public class UserResource extends EntityResource<User, UserRepository> {
@Path("/{id}")
@Consumes(MediaType.APPLICATION_JSON_PATCH_JSON)
@Operation(
operationId = "patchUser",
summary = "Update a user",
tags = "users",
description = "Update an existing user using JsonPatch.",
@ -508,6 +519,7 @@ public class UserResource extends EntityResource<User, UserRepository> {
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteUser",
summary = "Delete a user",
tags = "users",
description = "Users can't be deleted but are soft-deleted.",

39
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/topics/TopicResource.java
View File

@ -60,6 +60,7 @@ import org.openmetadata.catalog.resources.Collection;
import org.openmetadata.catalog.resources.EntityResource;
import org.openmetadata.catalog.security.Authorizer;
import org.openmetadata.catalog.security.SecurityUtil;
import org.openmetadata.catalog.type.ChangeEvent;
import org.openmetadata.catalog.type.EntityHistory;
import org.openmetadata.catalog.type.Include;
import org.openmetadata.catalog.type.topic.TopicSampleData;
@ -101,6 +102,7 @@ public class TopicResource extends EntityResource<Topic, TopicRepository> {
@GET
@Operation(
operationId = "listTopics",
summary = "List topics",
tags = "topics",
description =
@ -152,6 +154,7 @@ public class TopicResource extends EntityResource<Topic, TopicRepository> {
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllTopicVersion",
summary = "List topic versions",
tags = "topics",
description = "Get a list of all the versions of a topic identified by `id`",
@ -204,6 +207,7 @@ public class TopicResource extends EntityResource<Topic, TopicRepository> {
@GET
@Path("/name/{fqn}")
@Operation(
operationId = "getTopicByFQN",
summary = "Get a topic by name",
tags = "topics",
description = "Get a topic by fully qualified name.",
@ -236,6 +240,7 @@ public class TopicResource extends EntityResource<Topic, TopicRepository> {
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificTopicVersion",
summary = "Get a version of the topic",
tags = "topics",
description = "Get a version of the topic by given `id`",
@ -263,6 +268,7 @@ public class TopicResource extends EntityResource<Topic, TopicRepository> {
@POST
@Operation(
operationId = "createTopic",
summary = "Create a topic",
tags = "topics",
description = "Create a topic under an existing `service`.",
@ -270,7 +276,7 @@ public class TopicResource extends EntityResource<Topic, TopicRepository> {
@ApiResponse(
responseCode = "200",
description = "The topic",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateTopic.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Topic.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(@Context UriInfo uriInfo, @Context SecurityContext securityContext, @Valid CreateTopic create)
@ -282,6 +288,7 @@ public class TopicResource extends EntityResource<Topic, TopicRepository> {
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchTopic",
summary = "Update a topic",
tags = "topics",
description = "Update an existing topic using JsonPatch.",
@ -306,6 +313,7 @@ public class TopicResource extends EntityResource<Topic, TopicRepository> {
@PUT
@Operation(
operationId = "createOrUpdateTopic",
summary = "Update topic",
tags = "topics",
description = "Create a topic, it it does not exist or update an existing topic.",
@ -313,7 +321,7 @@ public class TopicResource extends EntityResource<Topic, TopicRepository> {
@ApiResponse(
responseCode = "200",
description = "The updated topic ",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateTopic.class)))
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Topic.class)))
})
public Response createOrUpdate(
@Context UriInfo uriInfo, @Context SecurityContext securityContext, @Valid CreateTopic create)
@ -324,7 +332,17 @@ public class TopicResource extends EntityResource<Topic, TopicRepository> {
@PUT
@Path("/{id}/sampleData")
@Operation(summary = "Add sample data", tags = "topics", description = "Add sample data to the topic.")
@Operation(
operationId = "addSampleData",
summary = "Add sample data",
tags = "topics",
description = "Add sample data to the topic.",
responses = {
@ApiResponse(
responseCode = "200",
description = "The topic",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Topic.class))),
})
public Topic addSampleData(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -339,11 +357,15 @@ public class TopicResource extends EntityResource<Topic, TopicRepository> {
@PUT
@Path("/{id}/followers")
@Operation(
operationId = "addFollower",
summary = "Add a follower",
tags = "topics",
description = "Add a user identified by `userId` as followed of this topic",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ChangeEvent.class))),
@ApiResponse(responseCode = "404", description = "Topic for instance {id} is not found")
})
public Response addFollower(
@ -362,7 +384,13 @@ public class TopicResource extends EntityResource<Topic, TopicRepository> {
@Operation(
summary = "Remove a follower",
tags = "topics",
description = "Remove the user identified `userId` as a follower of the topic.")
description = "Remove the user identified `userId` as a follower of the topic.",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = ChangeEvent.class)))
})
public Response deleteFollower(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@ -379,6 +407,7 @@ public class TopicResource extends EntityResource<Topic, TopicRepository> {
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteTopic",
summary = "Delete a topic",
tags = "topics",
description = "Delete a topic by `id`.",

11
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/types/TypeResource.java
View File

@ -124,6 +124,7 @@ public class TypeResource extends EntityResource<Type, TypeRepository> {
@GET
@Valid
@Operation(
operationId = "listTypes",
summary = "List types",
tags = "metadata",
description =
@ -164,6 +165,7 @@ public class TypeResource extends EntityResource<Type, TypeRepository> {
@GET
@Path("/{id}")
@Operation(
operationId = "getTypeByID",
summary = "Get a type",
tags = "metadata",
description = "Get a type by `id`.",
@ -196,6 +198,7 @@ public class TypeResource extends EntityResource<Type, TypeRepository> {
@GET
@Path("/name/{name}")
@Operation(
operationId = "getTypeByFQN",
summary = "Get a type by name",
tags = "metadata",
description = "Get a type by name.",
@ -228,6 +231,7 @@ public class TypeResource extends EntityResource<Type, TypeRepository> {
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllTypeVersion",
summary = "List type versions",
tags = "metadata",
description = "Get a list of all the versions of a type identified by `id`",
@ -248,6 +252,7 @@ public class TypeResource extends EntityResource<Type, TypeRepository> {
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificTypeVersion",
summary = "Get a version of the types",
tags = "metadata",
description = "Get a version of the type by given `id`",
@ -275,6 +280,7 @@ public class TypeResource extends EntityResource<Type, TypeRepository> {
@POST
@Operation(
operationId = "createType",
summary = "Create a type",
tags = "metadata",
description = "Create a new type.",
@ -282,7 +288,7 @@ public class TypeResource extends EntityResource<Type, TypeRepository> {
@ApiResponse(
responseCode = "200",
description = "The type",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = CreateType.class))),
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Type.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(@Context UriInfo uriInfo, @Context SecurityContext securityContext, @Valid CreateType create)
@ -294,6 +300,7 @@ public class TypeResource extends EntityResource<Type, TypeRepository> {
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchType",
summary = "Update a type",
tags = "metadata",
description = "Update an existing type using JsonPatch.",
@ -337,6 +344,7 @@ public class TypeResource extends EntityResource<Type, TypeRepository> {
@DELETE
@Path("/{id}")
@Operation(
operationId = "deleteType",
summary = "Delete a type",
tags = "metadata",
description = "Delete a type by `id`.",
@ -355,6 +363,7 @@ public class TypeResource extends EntityResource<Type, TypeRepository> {
@PUT
@Path("/{id}")
@Operation(
operationId = "addField",
summary = "Add a field to an entity",
tags = "metadata",
description = "Add a field to an entity type. Fields can only be added to entity type and not field type.",

5
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/usage/UsageResource.java
View File

@ -64,6 +64,7 @@ public class UsageResource {
@Valid
@Path("/{entity}/{id}")
@Operation(
operationId = "getEntityUsageByID",
summary = "Get usage",
tags = "usage",
description = "Get usage details for an entity identified by `id`.",
@ -104,6 +105,7 @@ public class UsageResource {
@Valid
@Path("/{entity}/name/{fqn}")
@Operation(
operationId = "getEntityUsageByFQN",
summary = "Get usage by name",
tags = "usage",
description = "Get usage details for an entity identified by fully qualified name.",
@ -146,6 +148,7 @@ public class UsageResource {
@POST
@Path("/{entity}/{id}")
@Operation(
operationId = "reportEntityUsageWithID",
summary = "Report usage",
tags = "usage",
description =
@ -177,6 +180,7 @@ public class UsageResource {
@POST
@Path("/{entity}/name/{fqn}")
@Operation(
operationId = "reportEntityUsageWithFQN",
summary = "Report usage by name",
tags = "usage",
description =
@ -212,6 +216,7 @@ public class UsageResource {
@POST
@Path("/compute.percentile/{entity}/{date}")
@Operation(
operationId = "computeEntityUsagePercentile",
summary = "Compute percentiles",
tags = "usage",
description = "Compute percentile ranking for an entity based on last 30 days of usage.",

3
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/version/VersionResource.java
View File

@ -53,8 +53,9 @@ public class VersionResource {
@GET
@Operation(
operationId = "getCatalogVersion",
summary = "Get version of metadata service",
tags = "general",
tags = "catalog",
description = "Get the build version of OpenMetadata service and build timestamp.")
public CatalogVersion getCatalogVersion() {
return CATALOG_VERSION;