Package org.openmetadata.service.resources.glossary

Class GlossaryResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Glossary,GlossaryRepository>

org.openmetadata.service.resources.glossary.GlossaryResource

@Path("/v1/glossaries")
@Produces("application/json")
@Consumes("application/json")
public class GlossaryResource
extends EntityResource<Glossary,GlossaryRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GlossaryResource.GlossaryList

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLLECTION_PATH

Fields inherited from class org.openmetadata.service.resources.EntityResource

allowedFields, authorizer, entityClass, entityType, fieldsToViewOperations, repository, VIEW_ALL_OPERATIONS, VIEW_BASIC_OPERATIONS

Constructor Summary

Constructors

Constructor	Description
GlossaryResource(Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateGlossary create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateGlossary create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, boolean recursive, String name)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean recursive, boolean hardDelete, UUID id)
@Valid String	exportCsv(javax.ws.rs.core.SecurityContext securityContext, String name)
Glossary	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
Glossary	getByName(javax.ws.rs.core.UriInfo uriInfo, String name, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
@Valid String	getCsvDocumentation(javax.ws.rs.core.SecurityContext securityContext, String name)
protected List<MetadataOperation>	getEntitySpecificOperations()
static Glossary	getGlossary(GlossaryRepository repository, CreateGlossary create, String updatedBy)
Glossary	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
@Valid CsvImportResult	importCsv(javax.ws.rs.core.SecurityContext securityContext, String name, boolean dryRun, String csv)
@Valid ResultList<Glossary>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam, String before, String after, Include include)
EntityHistory	listVersions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	patch(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, javax.json.JsonPatch patch)
javax.ws.rs.core.Response	restoreGlossary(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)
javax.ws.rs.core.Response	updateVote(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid VoteRequest request)

Methods inherited from class org.openmetadata.service.resources.EntityResource

addHref, addHref, addViewOperation, create, createOrUpdate, delete, deleteByName, exportCsvInternal, getByNameInternal, getByNameInternal, getEntityReference, getEntityReferences, getFields, getInternal, getInternal, getResourceContext, getResourceContextById, getResourceContextByName, getVersionInternal, getVersionInternal, importCsvInternal, initialize, listInternal, listInternal, listVersionsInternal, listVersionsInternal, patchInternal, restoreEntity, upgrade

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

• Constant Field Values

Constructor Details

GlossaryResource

public GlossaryResource(Authorizer authorizer)

Method Details

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<Glossary,GlossaryRepository>

list

@GET
@Valid
public @Valid ResultList<Glossary> list(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @DefaultValue("10") @Min(0L) @Max(1000000L) @QueryParam("limit")
 @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam,
 @QueryParam("before")
 String before,
 @QueryParam("after")
 String after,
 @QueryParam("include") @DefaultValue("non-deleted")
 Include include)

get

@GET
@Path("/{id}")
public Glossary get(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @QueryParam("fields")
 String fieldsParam,
 @QueryParam("include") @DefaultValue("non-deleted")
 Include include)

getByName

@GET
@Path("/name/{name}")
public Glossary getByName(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("name")
 String name,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @QueryParam("include") @DefaultValue("non-deleted")
 Include include)

listVersions

@GET
@Path("/{id}/versions")
public EntityHistory listVersions(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id)

getVersion

@GET
@Path("/{id}/versions/{version}")
public Glossary getVersion(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @PathParam("version")
 String version)

create

@POST
public javax.ws.rs.core.Response create(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid CreateGlossary create)

patch

@PATCH
@Path("/{id}")
@Consumes("application/json-patch+json")
public javax.ws.rs.core.Response patch(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 javax.json.JsonPatch patch)

createOrUpdate

@PUT
public javax.ws.rs.core.Response createOrUpdate(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid CreateGlossary create)

updateVote

@PUT
@Path("/{id}/vote")
public javax.ws.rs.core.Response updateVote(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @Valid
 @Valid VoteRequest request)

delete

@DELETE
@Path("/{id}")
public javax.ws.rs.core.Response delete(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @DefaultValue("false") @QueryParam("recursive")
 boolean recursive,
 @QueryParam("hardDelete") @DefaultValue("false")
 boolean hardDelete,
 @PathParam("id")
 UUID id)

delete

@DELETE
@Path("/name/{name}")
public javax.ws.rs.core.Response delete(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("hardDelete") @DefaultValue("false")
 boolean hardDelete,
 @DefaultValue("false") @QueryParam("recursive")
 boolean recursive,
 @PathParam("name")
 String name)

restoreGlossary

@PUT
@Path("/restore")
public javax.ws.rs.core.Response restoreGlossary(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid RestoreEntity restore)

getCsvDocumentation

@GET
@Path("/documentation/csv")
@Valid
public @Valid String getCsvDocumentation(@Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("name")
 String name)

exportCsv

@GET
@Path("/name/{name}/export")
@Produces("text/plain")
@Valid
public @Valid String exportCsv(@Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("name")
 String name)
                        throws IOException

Throws:

IOException

importCsv

@PUT
@Path("/name/{name}/import")
@Consumes("text/plain")
@Valid
public @Valid CsvImportResult importCsv(@Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("name")
 String name,
 @DefaultValue("true") @QueryParam("dryRun")
 boolean dryRun,
 String csv)
                                 throws IOException

Throws:

IOException

getGlossary

public static Glossary getGlossary(GlossaryRepository repository,
 CreateGlossary create,
 String updatedBy)