Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.openmetadata.service.resources.glossary.GlossaryTermResource Maven / Gradle / Ivy
/*
* Copyright 2021 Collate
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openmetadata.service.resources.glossary;
import static org.openmetadata.service.Entity.ADMIN_USER_NAME;
import static org.openmetadata.service.Entity.GLOSSARY;
import io.swagger.v3.oas.annotations.ExternalDocumentation;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.ExampleObject;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import javax.json.JsonPatch;
import javax.validation.Valid;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
import javax.ws.rs.PATCH;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.SecurityContext;
import javax.ws.rs.core.UriInfo;
import org.openmetadata.schema.api.AddGlossaryToAssetsRequest;
import org.openmetadata.schema.api.VoteRequest;
import org.openmetadata.schema.api.data.CreateGlossaryTerm;
import org.openmetadata.schema.api.data.LoadGlossary;
import org.openmetadata.schema.api.data.RestoreEntity;
import org.openmetadata.schema.entity.data.Glossary;
import org.openmetadata.schema.entity.data.GlossaryTerm;
import org.openmetadata.schema.type.ChangeEvent;
import org.openmetadata.schema.type.EntityHistory;
import org.openmetadata.schema.type.EntityReference;
import org.openmetadata.schema.type.Include;
import org.openmetadata.schema.type.MetadataOperation;
import org.openmetadata.schema.type.api.BulkOperationResult;
import org.openmetadata.service.Entity;
import org.openmetadata.service.OpenMetadataApplicationConfig;
import org.openmetadata.service.exception.CatalogExceptionMessage;
import org.openmetadata.service.jdbi3.EntityRepository;
import org.openmetadata.service.jdbi3.GlossaryRepository;
import org.openmetadata.service.jdbi3.GlossaryTermRepository;
import org.openmetadata.service.jdbi3.ListFilter;
import org.openmetadata.service.resources.Collection;
import org.openmetadata.service.resources.EntityResource;
import org.openmetadata.service.security.Authorizer;
import org.openmetadata.service.util.EntityUtil;
import org.openmetadata.service.util.EntityUtil.Fields;
import org.openmetadata.service.util.RestUtil;
import org.openmetadata.service.util.ResultList;
@Path("/v1/glossaryTerms")
@Tag(
name = "Glossaries",
description = "A `Glossary` is collection of hierarchical `GlossaryTerms`.")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@Collection(
name = "glossaryTerms",
order = 7) // Initialized after Glossary, Classification, and Tags
public class GlossaryTermResource extends EntityResource {
public static final String COLLECTION_PATH = "v1/glossaryTerms/";
static final String FIELDS =
"children,relatedTerms,reviewers,owner,tags,usageCount,domain,extension,childrenCount";
@Override
public GlossaryTerm addHref(UriInfo uriInfo, GlossaryTerm term) {
super.addHref(uriInfo, term);
Entity.withHref(uriInfo, term.getGlossary());
Entity.withHref(uriInfo, term.getParent());
Entity.withHref(uriInfo, term.getRelatedTerms());
return term;
}
public GlossaryTermResource(Authorizer authorizer) {
super(Entity.GLOSSARY_TERM, authorizer);
}
@Override
protected List getEntitySpecificOperations() {
addViewOperation("children,relatedTerms,reviewers,usageCount", MetadataOperation.VIEW_BASIC);
return null;
}
public static class GlossaryTermList extends ResultList {
/* Required for serde */
}
@Override
public void initialize(OpenMetadataApplicationConfig config) throws IOException {
super.initialize(config);
// Load glossaries provided by OpenMetadata
GlossaryRepository glossaryRepository =
(GlossaryRepository) Entity.getEntityRepository(GLOSSARY);
List loadGlossaries =
EntityRepository.getEntitiesFromSeedData(
GLOSSARY, ".*json/data/glossary/.*Glossary\\.json$", LoadGlossary.class);
for (LoadGlossary loadGlossary : loadGlossaries) {
Glossary glossary =
GlossaryResource.getGlossary(
glossaryRepository, loadGlossary.getCreateGlossary(), ADMIN_USER_NAME);
glossary.setFullyQualifiedName(glossary.getName());
glossaryRepository.initializeEntity(glossary);
List termsToCreate = new ArrayList<>();
for (CreateGlossaryTerm createTerm : loadGlossary.getCreateTerms()) {
createTerm.withGlossary(glossary.getName());
createTerm.withProvider(glossary.getProvider());
GlossaryTerm term = getGlossaryTerm(createTerm, ADMIN_USER_NAME);
repository.setFullyQualifiedName(term); // FQN required for ordering tags based on hierarchy
termsToCreate.add(term);
}
// Sort tags based on tag hierarchy
EntityUtil.sortByFQN(termsToCreate);
for (GlossaryTerm term : termsToCreate) {
repository.initializeEntity(term);
}
}
}
@GET
@Valid
@Operation(
operationId = "listGlossaryTerm",
summary = "List glossary terms",
description =
"Get a list of glossary terms. Use `fields` parameter to get only necessary fields. "
+ " Use cursor-based pagination to limit the number "
+ "entries in the list using `limit` and `before` or `after` query params.",
responses = {
@ApiResponse(
responseCode = "200",
description = "List of glossary terms",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = GlossaryTermList.class)))
})
public ResultList list(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(
description =
"List glossary terms filtered by glossary identified by Id given in `glossary` parameter.",
schema = @Schema(type = "string", example = FIELDS))
@QueryParam("glossary")
String glossaryIdParam,
@Parameter(
description =
"List glossary terms filtered by children of glossary term identified by Id given in "
+ "`parent` parameter.",
schema = @Schema(type = "string", example = FIELDS))
@QueryParam("parent")
UUID parentTermParam,
@Parameter(
description = "Fields requested in the returned resource",
schema = @Schema(type = "string", example = FIELDS))
@QueryParam("fields")
String fieldsParam,
@Parameter(
description =
"Limit the number glossary terms returned. (1 to 1000000, default = 10)")
@DefaultValue("10")
@Min(0)
@Max(1000000)
@QueryParam("limit")
int limitParam,
@Parameter(
description = "Returns list of glossary terms before this cursor",
schema = @Schema(type = "string"))
@QueryParam("before")
String before,
@Parameter(
description = "Returns list of glossary terms after this cursor",
schema = @Schema(type = "string"))
@QueryParam("after")
String after,
@Parameter(
description = "Include all, deleted, or non-deleted entities.",
schema = @Schema(implementation = Include.class))
@QueryParam("include")
@DefaultValue("non-deleted")
Include include,
@Parameter(
description =
"List glossary terms filtered to retrieve the first level/immediate children of the glossary term "
+ "`directChildrenOf` parameter.",
schema = @Schema(type = "string"))
@QueryParam("directChildrenOf")
String parentTermFQNParam) {
RestUtil.validateCursors(before, after);
Fields fields = getFields(fieldsParam);
// Filter by glossary
String fqn = null;
EntityReference glossary = null;
if (glossaryIdParam != null) {
glossary = repository.getGlossary(glossaryIdParam);
fqn = glossary.getFullyQualifiedName();
}
// Filter by glossary parent term
if (parentTermParam != null) {
GlossaryTerm parentTerm = repository.find(parentTermParam, Include.NON_DELETED);
fqn = parentTerm.getFullyQualifiedName();
// Ensure parent glossary term belongs to the glossary
if ((glossary != null) && (!parentTerm.getGlossary().getId().equals(glossary.getId()))) {
throw new IllegalArgumentException(
CatalogExceptionMessage.glossaryTermMismatch(
parentTermParam.toString(), glossaryIdParam));
}
}
ListFilter filter =
new ListFilter(include)
.addQueryParam("parent", fqn)
.addQueryParam("directChildrenOf", parentTermFQNParam);
ResultList terms;
if (before != null) { // Reverse paging
terms =
repository.listBefore(
uriInfo, fields, filter, limitParam, before); // Ask for one extra entry
} else { // Forward paging or first page
terms = repository.listAfter(uriInfo, fields, filter, limitParam, after);
}
return addHref(uriInfo, terms);
}
@GET
@Path("/{id}")
@Operation(
operationId = "getGlossaryTermByID",
summary = "Get a glossary term by Id",
description = "Get a glossary term by `Id`.",
responses = {
@ApiResponse(
responseCode = "200",
description = "The glossary term",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = Glossary.class))),
@ApiResponse(responseCode = "404", description = "Glossary for instance {id} is not found")
})
public GlossaryTerm get(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Id of the glossary term", schema = @Schema(type = "UUID"))
@PathParam("id")
UUID id,
@Parameter(
description = "Fields requested in the returned resource",
schema = @Schema(type = "string", example = FIELDS))
@QueryParam("fields")
String fieldsParam,
@Parameter(
description = "Include all, deleted, or non-deleted entities.",
schema = @Schema(implementation = Include.class))
@QueryParam("include")
@DefaultValue("non-deleted")
Include include) {
return getInternal(uriInfo, securityContext, id, fieldsParam, include);
}
@GET
@Path("/name/{fqn}")
@Operation(
operationId = "getGlossaryTermByFQN",
summary = "Get a glossary term by fully qualified name",
description = "Get a glossary term by `fullyQualifiedName`.",
responses = {
@ApiResponse(
responseCode = "200",
description = "The glossary term",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = Glossary.class))),
@ApiResponse(responseCode = "404", description = "Glossary for instance {fqn} is not found")
})
public GlossaryTerm getByName(
@Context UriInfo uriInfo,
@Parameter(
description = "Fully qualified name of the glossary term",
schema = @Schema(type = "string"))
@PathParam("fqn")
String fqn,
@Context SecurityContext securityContext,
@Parameter(
description = "Fields requested in the returned resource",
schema = @Schema(type = "string", example = FIELDS))
@QueryParam("fields")
String fieldsParam,
@Parameter(
description = "Include all, deleted, or non-deleted entities.",
schema = @Schema(implementation = Include.class))
@QueryParam("include")
@DefaultValue("non-deleted")
Include include) {
return getByNameInternal(uriInfo, securityContext, fqn, fieldsParam, include);
}
@GET
@Path("/{id}/versions")
@Operation(
operationId = "listAllGlossaryTermVersion",
summary = "List glossary term versions",
description = "Get a list of all the versions of a glossary terms identified by `id`",
responses = {
@ApiResponse(
responseCode = "200",
description = "List of glossary term versions",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = EntityHistory.class)))
})
public EntityHistory listVersions(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Id of the glossary term", schema = @Schema(type = "UUID"))
@PathParam("id")
UUID id) {
return super.listVersionsInternal(securityContext, id);
}
@GET
@Path("/{id}/versions/{version}")
@Operation(
operationId = "getSpecificGlossaryTermVersion",
summary = "Get a version of the glossary term",
description = "Get a version of the glossary term by given `Id`",
responses = {
@ApiResponse(
responseCode = "200",
description = "glossaries",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = Glossary.class))),
@ApiResponse(
responseCode = "404",
description = "Glossary for instance {id} and version {version} is not found")
})
public GlossaryTerm getVersion(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Id of the glossary term", schema = @Schema(type = "UUID"))
@PathParam("id")
UUID id,
@Parameter(
description = "glossary term version number in the form `major`.`minor`",
schema = @Schema(type = "string", example = "0.1 or 1.1"))
@PathParam("version")
String version) {
return super.getVersionInternal(securityContext, id, version);
}
@POST
@Operation(
operationId = "createGlossaryTerm",
summary = "Create a glossary term",
description = "Create a new glossary term.",
responses = {
@ApiResponse(
responseCode = "200",
description = "The glossary term",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = GlossaryTerm.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response create(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Valid CreateGlossaryTerm create) {
GlossaryTerm term = getGlossaryTerm(create, securityContext.getUserPrincipal().getName());
return create(uriInfo, securityContext, term);
}
@PATCH
@Path("/{id}")
@Operation(
operationId = "patchGlossaryTerm",
summary = "Update a glossary term",
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)
public Response patch(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Id of the glossary term", schema = @Schema(type = "UUID"))
@PathParam("id")
UUID id,
@RequestBody(
description = "JsonPatch with array of operations",
content =
@Content(
mediaType = MediaType.APPLICATION_JSON_PATCH_JSON,
examples = {
@ExampleObject("[{op:remove, path:/a},{op:add, path: /b, value: val}]")
}))
JsonPatch patch) {
return patchInternal(uriInfo, securityContext, id, patch);
}
@PATCH
@Path("/name/{fqn}")
@Operation(
operationId = "patchGlossaryTerm",
summary = "Update a glossary term by name.",
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)
public Response patch(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Name of the glossary term", schema = @Schema(type = "string"))
@PathParam("fqn")
String fqn,
@RequestBody(
description = "JsonPatch with array of operations",
content =
@Content(
mediaType = MediaType.APPLICATION_JSON_PATCH_JSON,
examples = {
@ExampleObject("[{op:remove, path:/a},{op:add, path: /b, value: val}]")
}))
JsonPatch patch) {
return patchInternal(uriInfo, securityContext, fqn, patch);
}
@PUT
@Operation(
operationId = "createOrUpdateGlossaryTerm",
summary = "Create or update a glossary term",
description =
"Create a new glossary term, if it does not exist or update an existing glossary term.",
responses = {
@ApiResponse(
responseCode = "200",
description = "The glossary",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = GlossaryTerm.class))),
@ApiResponse(responseCode = "400", description = "Bad request")
})
public Response createOrUpdate(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Valid CreateGlossaryTerm create) {
GlossaryTerm term = getGlossaryTerm(create, securityContext.getUserPrincipal().getName());
return createOrUpdate(uriInfo, securityContext, term);
}
@PUT
@Path("/{id}/vote")
@Operation(
operationId = "updateVoteForEntity",
summary = "Update Vote for a Entity",
description = "Update vote for a Entity",
responses = {
@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 updateVote(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Id of the Entity", schema = @Schema(type = "UUID")) @PathParam("id")
UUID id,
@Valid VoteRequest request) {
return repository
.updateVote(securityContext.getUserPrincipal().getName(), id, request)
.toResponse();
}
@PUT
@Path("/{id}/assets/add")
@Operation(
operationId = "bulkAddGlossaryTermToAssets",
summary = "Bulk Add Glossary Term to Assets",
description = "Bulk Add Glossary Term to Assets",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = BulkOperationResult.class))),
@ApiResponse(responseCode = "404", description = "model for instance {id} is not found")
})
public Response bulkAddGlossaryToAssets(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Id of the Entity", schema = @Schema(type = "UUID")) @PathParam("id")
UUID id,
@Valid AddGlossaryToAssetsRequest request) {
return Response.ok().entity(repository.bulkAddAndValidateGlossaryToAssets(id, request)).build();
}
@PUT
@Path("/{id}/tags/validate")
@Operation(
operationId = "validateGlossaryTermTagsAddition",
summary = "Validate Tags Addition to Glossary Term",
description = "Validate Tags Addition to Glossary Term",
responses = {
@ApiResponse(
responseCode = "200",
description = "OK",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = BulkOperationResult.class))),
@ApiResponse(responseCode = "404", description = "model for instance {id} is not found")
})
public Response validateGlossaryTermTagsAddition(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Id of the Entity", schema = @Schema(type = "UUID")) @PathParam("id")
UUID id,
@Valid AddGlossaryToAssetsRequest request) {
return Response.ok().entity(repository.validateGlossaryTagsAddition(id, request)).build();
}
@PUT
@Path("/{id}/assets/remove")
@Operation(
operationId = "bulkRemoveGlossaryTermFromAssets",
summary = "Bulk Remove Glossary Term from Assets",
description = "Bulk Remove Glossary Term from Assets",
responses = {
@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 bulkRemoveGlossaryFromAssets(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Id of the Entity", schema = @Schema(type = "UUID")) @PathParam("id")
UUID id,
@Valid AddGlossaryToAssetsRequest request) {
return Response.ok().entity(repository.bulkRemoveGlossaryToAssets(id, request)).build();
}
@DELETE
@Path("/{id}")
@Operation(
summary = "Delete a glossary term by Id",
description = "Delete a glossary term by `Id`.",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),
@ApiResponse(
responseCode = "404",
description = "glossaryTerm for instance {id} is not found")
})
public Response delete(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(
description = "Recursively delete this entity and it's children. (Default `false`)")
@DefaultValue("false")
@QueryParam("recursive")
boolean recursive,
@Parameter(description = "Hard delete the entity. (Default = `false`)")
@QueryParam("hardDelete")
@DefaultValue("false")
boolean hardDelete,
@Parameter(description = "Id of the glossary term", schema = @Schema(type = "UUID"))
@PathParam("id")
UUID id) {
return delete(uriInfo, securityContext, id, recursive, hardDelete);
}
@DELETE
@Path("/name/{fqn}")
@Operation(
operationId = "deleteGlossaryTermByName",
summary = "Delete a glossary term by fully qualified name",
description = "Delete a glossary term by `fullyQualifiedName`.",
responses = {
@ApiResponse(responseCode = "200", description = "OK"),
@ApiResponse(
responseCode = "404",
description = "glossaryTerm for instance {fqn} is not found")
})
public Response delete(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Hard delete the entity. (Default = `false`)")
@QueryParam("hardDelete")
@DefaultValue("false")
boolean hardDelete,
@Parameter(
description = "Recursively delete this entity and it's children. (Default `false`)")
@QueryParam("recursive")
@DefaultValue("false")
boolean recursive,
@Parameter(
description = "Fully qualified name of the glossary term",
schema = @Schema(type = "string"))
@PathParam("fqn")
String fqn) {
return deleteByName(uriInfo, securityContext, fqn, recursive, hardDelete);
}
@PUT
@Path("/restore")
@Operation(
operationId = "restore",
summary = "Restore a soft deleted glossary term",
description = "Restore a soft deleted glossary term.",
responses = {
@ApiResponse(
responseCode = "200",
description = "Successfully restored the Chart ",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = GlossaryTerm.class)))
})
public Response restoreTable(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Valid RestoreEntity restore) {
return restoreEntity(uriInfo, securityContext, restore.getId());
}
private GlossaryTerm getGlossaryTerm(CreateGlossaryTerm create, String user) {
return repository
.copy(new GlossaryTerm(), create, user)
.withSynonyms(create.getSynonyms())
.withStyle(create.getStyle())
.withGlossary(getEntityReference(Entity.GLOSSARY, create.getGlossary()))
.withParent(getEntityReference(Entity.GLOSSARY_TERM, create.getParent()))
.withRelatedTerms(getEntityReferences(Entity.GLOSSARY_TERM, create.getRelatedTerms()))
.withReferences(create.getReferences())
.withProvider(create.getProvider())
.withMutuallyExclusive(create.getMutuallyExclusive());
}
}
