Package org.openmetadata.service.resources.feeds

Class SuggestionsResource

java.lang.Object

org.openmetadata.service.resources.feeds.SuggestionsResource

@Path("/v1/suggestions")
@Produces("application/json")
@Consumes("application/json")
public class SuggestionsResource
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SuggestionsResource.SuggestionList

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLLECTION_PATH

Constructor Summary

Constructors

Constructor	Description
SuggestionsResource(Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
RestUtil.PutResponse<List<Suggestion>>	acceptAllSuggestions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID userId, String entityFQN, SuggestionType suggestionType)
javax.ws.rs.core.Response	acceptSuggestion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
static void	addHref(javax.ws.rs.core.UriInfo uriInfo, List<Suggestion> suggestions)
static Suggestion	addHref(javax.ws.rs.core.UriInfo uriInfo, Suggestion suggestion)
javax.ws.rs.core.Response	createSuggestion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateSuggestion create)
javax.ws.rs.core.Response	deleteSuggestion(javax.ws.rs.core.SecurityContext securityContext, UUID suggestionId)
javax.ws.rs.core.Response	deleteSuggestions(javax.ws.rs.core.SecurityContext securityContext, String entityType, String entityFQN)
Suggestion	get(javax.ws.rs.core.UriInfo uriInfo, UUID id)
ResultList<Suggestion>	list(javax.ws.rs.core.UriInfo uriInfo, @javax.validation.constraints.Min(1L),@javax.validation.constraints.Max(1000000L) int limitParam, String before, String after, String entityFQN, UUID userId, String status)
RestUtil.PutResponse<List<Suggestion>>	rejectAllSuggestions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID userId, String entityFQN, SuggestionType suggestionType)
javax.ws.rs.core.Response	rejectSuggestion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	updateSuggestion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid Suggestion suggestion)

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

SuggestionsResource

public SuggestionsResource(Authorizer authorizer)

Method Details

addHref

public static void addHref(javax.ws.rs.core.UriInfo uriInfo,
 List<Suggestion> suggestions)

addHref

public static Suggestion addHref(javax.ws.rs.core.UriInfo uriInfo,
 Suggestion suggestion)

list

@GET
public ResultList<Suggestion> list(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @DefaultValue("10") @Min(1L) @Max(1000000L) @QueryParam("limit")
 @javax.validation.constraints.Min(1L),@javax.validation.constraints.Max(1000000L) int limitParam,
 @QueryParam("before")
 String before,
 @QueryParam("after")
 String after,
 @QueryParam("entityFQN")
 String entityFQN,
 @QueryParam("userId")
 UUID userId,
 @DefaultValue("Open") @QueryParam("status")
 String status)

get

@GET
@Path("/{id}")
public Suggestion get(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("id")
 UUID id)

acceptSuggestion

@PUT
@Path("/{id}/accept")
public javax.ws.rs.core.Response acceptSuggestion(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id)

rejectSuggestion

@PUT
@Path("/{id}/reject")
public javax.ws.rs.core.Response rejectSuggestion(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id)

acceptAllSuggestions

@PUT
@Path("accept-all")
public RestUtil.PutResponse<List<Suggestion>> acceptAllSuggestions(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("userId")
 UUID userId,
 @QueryParam("entityFQN")
 String entityFQN,
 @QueryParam("suggestionType") @DefaultValue("SuggestDescription")
 SuggestionType suggestionType)

rejectAllSuggestions

@PUT
@Path("reject-all")
public RestUtil.PutResponse<List<Suggestion>> rejectAllSuggestions(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("userId")
 UUID userId,
 @QueryParam("entityFQN")
 String entityFQN,
 @QueryParam("suggestionType") @DefaultValue("SuggestDescription")
 SuggestionType suggestionType)

updateSuggestion

@PUT
@Path("/{id}")
public javax.ws.rs.core.Response updateSuggestion(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @Valid
 @Valid Suggestion suggestion)

createSuggestion

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

deleteSuggestion

@DELETE
@Path("/{suggestionId}")
public javax.ws.rs.core.Response deleteSuggestion(@Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("suggestionId")
 UUID suggestionId)

deleteSuggestions

@DELETE
@Path("/{entityType}/name/{entityFQN}")
public javax.ws.rs.core.Response deleteSuggestions(@Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("entityType")
 String entityType,
 @PathParam("entityFQN")
 String entityFQN)