org.openmetadata.client.api.DashboardsApi Maven / Gradle / Ivy
package org.openmetadata.client.api;
import org.openmetadata.client.ApiClient;
import org.openmetadata.client.EncodingUtils;
import org.openmetadata.client.model.ApiResponse;
import org.openmetadata.client.model.ChangeEvent;
import org.openmetadata.client.model.CreateDashboard;
import org.openmetadata.client.model.Dashboard;
import org.openmetadata.client.model.DashboardList;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.RestoreEntity;
import java.util.UUID;
import org.openmetadata.client.model.VoteRequest;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import feign.*;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-03T19:44:33.436780642Z[Etc/UTC]")
public interface DashboardsApi extends ApiClient.Api {
/**
* Add a follower
* Add a user identified by `userId` as follower of this dashboard
* @param id Id of the dashboard (required)
* @param body Id of the user to be added as follower (optional)
*/
@RequestLine("PUT /v1/dashboards/{id}/followers")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void addFollowerToDashboard(@Param("id") UUID id, UUID body);
/**
* Add a follower
* Similar to addFollowerToDashboard but it also returns the http response headers .
* Add a user identified by `userId` as follower of this dashboard
* @param id Id of the dashboard (required)
* @param body Id of the user to be added as follower (optional)
*/
@RequestLine("PUT /v1/dashboards/{id}/followers")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addFollowerToDashboardWithHttpInfo(@Param("id") UUID id, UUID body);
/**
* Create a dashboard
* Create a new dashboard.
* @param createDashboard (optional)
* @return Dashboard
*/
@RequestLine("POST /v1/dashboards")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Dashboard createDashboard(CreateDashboard createDashboard);
/**
* Create a dashboard
* Similar to createDashboard but it also returns the http response headers .
* Create a new dashboard.
* @param createDashboard (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/dashboards")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createDashboardWithHttpInfo(CreateDashboard createDashboard);
/**
* Create or update a dashboard
* Create a new dashboard, if it does not exist or update an existing dashboard.
* @param createDashboard (optional)
* @return Dashboard
*/
@RequestLine("PUT /v1/dashboards")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Dashboard createOrUpdateDashboard(CreateDashboard createDashboard);
/**
* Create or update a dashboard
* Similar to createOrUpdateDashboard but it also returns the http response headers .
* Create a new dashboard, if it does not exist or update an existing dashboard.
* @param createDashboard (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dashboards")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateDashboardWithHttpInfo(CreateDashboard createDashboard);
/**
* Delete a dashboard by Id
* Delete a dashboard by `Id`.
* @param id Id of the dashboard (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dashboards/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteDashboard(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a dashboard by Id
* Similar to deleteDashboard but it also returns the http response headers .
* Delete a dashboard by `Id`.
* @param id Id of the dashboard (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dashboards/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDashboardWithHttpInfo(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a dashboard by Id
* Delete a dashboard by `Id`.
* Note, this is equivalent to the other deleteDashboard method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link DeleteDashboardQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the dashboard (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dashboards/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteDashboard(@Param("id") UUID id, @QueryMap(encoded=true) DeleteDashboardQueryParams queryParams);
/**
* Delete a dashboard by Id
* Delete a dashboard by `Id`.
* Note, this is equivalent to the other deleteDashboard that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the dashboard (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dashboards/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDashboardWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeleteDashboardQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteDashboard method in a fluent style.
*/
public static class DeleteDashboardQueryParams extends HashMap {
public DeleteDashboardQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete a dashboard by fully qualified name
* Delete a dashboard by `fullyQualifiedName`.
* @param fqn Fully qualified name of the dashboard (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dashboards/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteDashboardByFQN(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a dashboard by fully qualified name
* Similar to deleteDashboardByFQN but it also returns the http response headers .
* Delete a dashboard by `fullyQualifiedName`.
* @param fqn Fully qualified name of the dashboard (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dashboards/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDashboardByFQNWithHttpInfo(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a dashboard by fully qualified name
* Delete a dashboard by `fullyQualifiedName`.
* Note, this is equivalent to the other deleteDashboardByFQN method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link DeleteDashboardByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the dashboard (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dashboards/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteDashboardByFQN(@Param("fqn") String fqn, @QueryMap(encoded=true) DeleteDashboardByFQNQueryParams queryParams);
/**
* Delete a dashboard by fully qualified name
* Delete a dashboard by `fullyQualifiedName`.
* Note, this is equivalent to the other deleteDashboardByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the dashboard (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dashboards/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDashboardByFQNWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) DeleteDashboardByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteDashboardByFQN method in a fluent style.
*/
public static class DeleteDashboardByFQNQueryParams extends HashMap {
public DeleteDashboardByFQNQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
public DeleteDashboardByFQNQueryParams recursive(final Boolean value) {
put("recursive", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a dashboard by fully qualified name
* Get a dashboard by fully qualified name.
* @param fqn Fully qualified name of the dashboard (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return Dashboard
*/
@RequestLine("GET /v1/dashboards/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
Dashboard getDashboardByFQN(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include);
/**
* Get a dashboard by fully qualified name
* Similar to getDashboardByFQN but it also returns the http response headers .
* Get a dashboard by fully qualified name.
* @param fqn Fully qualified name of the dashboard (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dashboards/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDashboardByFQNWithHttpInfo(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include);
/**
* Get a dashboard by fully qualified name
* Get a dashboard by fully qualified name.
* Note, this is equivalent to the other getDashboardByFQN method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetDashboardByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the dashboard (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return Dashboard
*/
@RequestLine("GET /v1/dashboards/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
Dashboard getDashboardByFQN(@Param("fqn") String fqn, @QueryMap(encoded=true) GetDashboardByFQNQueryParams queryParams);
/**
* Get a dashboard by fully qualified name
* Get a dashboard by fully qualified name.
* Note, this is equivalent to the other getDashboardByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the dashboard (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return Dashboard
*/
@RequestLine("GET /v1/dashboards/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDashboardByFQNWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) GetDashboardByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getDashboardByFQN method in a fluent style.
*/
public static class GetDashboardByFQNQueryParams extends HashMap {
public GetDashboardByFQNQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetDashboardByFQNQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a dashboard by Id
* Get a dashboard by `Id`.
* @param id Id of the dashboard (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return Dashboard
*/
@RequestLine("GET /v1/dashboards/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
Dashboard getDashboardByID(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a dashboard by Id
* Similar to getDashboardByID but it also returns the http response headers .
* Get a dashboard by `Id`.
* @param id Id of the dashboard (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dashboards/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDashboardByIDWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a dashboard by Id
* Get a dashboard by `Id`.
* Note, this is equivalent to the other getDashboardByID method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetDashboardByIDQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the dashboard (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return Dashboard
*/
@RequestLine("GET /v1/dashboards/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
Dashboard getDashboardByID(@Param("id") UUID id, @QueryMap(encoded=true) GetDashboardByIDQueryParams queryParams);
/**
* Get a dashboard by Id
* Get a dashboard by `Id`.
* Note, this is equivalent to the other getDashboardByID that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the dashboard (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return Dashboard
*/
@RequestLine("GET /v1/dashboards/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDashboardByIDWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetDashboardByIDQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getDashboardByID method in a fluent style.
*/
public static class GetDashboardByIDQueryParams extends HashMap {
public GetDashboardByIDQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetDashboardByIDQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the dashboard
* Get a version of the dashboard by given `id`
* @param id Id of the dashboard (required)
* @param version Dashboard version number in the form `major`.`minor` (required)
* @return Dashboard
*/
@RequestLine("GET /v1/dashboards/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
Dashboard getSpecificDashboardVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the dashboard
* Similar to getSpecificDashboardVersion but it also returns the http response headers .
* Get a version of the dashboard by given `id`
* @param id Id of the dashboard (required)
* @param version Dashboard version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dashboards/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificDashboardVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* List dashboard versions
* Get a list of all the versions of a dashboard identified by `Id`
* @param id Id of the dashboard (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/dashboards/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllDashboardVersion(@Param("id") UUID id);
/**
* List dashboard versions
* Similar to listAllDashboardVersion but it also returns the http response headers .
* Get a list of all the versions of a dashboard identified by `Id`
* @param id Id of the dashboard (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dashboards/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllDashboardVersionWithHttpInfo(@Param("id") UUID id);
/**
* List dashboards
* Get a list of dashboards, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* @param fields Fields requested in the returned resource (optional)
* @param service Filter dashboards by service name (optional)
* @param limit Limit the number dashboards returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of dashboards before this cursor (optional)
* @param after Returns list of dashboards after this cursor (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return DashboardList
*/
@RequestLine("GET /v1/dashboards?fields={fields}&service={service}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
DashboardList listDashboards(@Param("fields") String fields, @Param("service") String service, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List dashboards
* Similar to listDashboards but it also returns the http response headers .
* Get a list of dashboards, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* @param fields Fields requested in the returned resource (optional)
* @param service Filter dashboards by service name (optional)
* @param limit Limit the number dashboards returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of dashboards before this cursor (optional)
* @param after Returns list of dashboards after this cursor (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dashboards?fields={fields}&service={service}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listDashboardsWithHttpInfo(@Param("fields") String fields, @Param("service") String service, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List dashboards
* Get a list of dashboards, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other listDashboards method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link ListDashboardsQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - service - Filter dashboards by service name (optional)
* - limit - Limit the number dashboards returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of dashboards before this cursor (optional)
* - after - Returns list of dashboards after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return DashboardList
*/
@RequestLine("GET /v1/dashboards?fields={fields}&service={service}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
DashboardList listDashboards(@QueryMap(encoded=true) ListDashboardsQueryParams queryParams);
/**
* List dashboards
* Get a list of dashboards, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other listDashboards that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - service - Filter dashboards by service name (optional)
* - limit - Limit the number dashboards returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of dashboards before this cursor (optional)
* - after - Returns list of dashboards after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return DashboardList
*/
@RequestLine("GET /v1/dashboards?fields={fields}&service={service}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listDashboardsWithHttpInfo(@QueryMap(encoded=true) ListDashboardsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listDashboards method in a fluent style.
*/
public static class ListDashboardsQueryParams extends HashMap {
public ListDashboardsQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListDashboardsQueryParams service(final String value) {
put("service", EncodingUtils.encode(value));
return this;
}
public ListDashboardsQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListDashboardsQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListDashboardsQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
public ListDashboardsQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Update a dashboard by name.
* Update an existing dashboard using JsonPatch.
* @param fqn Name of the dashboard (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a dashboard by name. Documentation
*/
@RequestLine("PATCH /v1/dashboards/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchDashboard(@Param("fqn") String fqn, Object body);
/**
* Update a dashboard by name.
* Similar to patchDashboard but it also returns the http response headers .
* Update an existing dashboard using JsonPatch.
* @param fqn Name of the dashboard (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a dashboard by name. Documentation
*/
@RequestLine("PATCH /v1/dashboards/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchDashboardWithHttpInfo(@Param("fqn") String fqn, Object body);
/**
* Update a dashboard
* Update an existing dashboard using JsonPatch.
* @param id Id of the dashboard (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a dashboard Documentation
*/
@RequestLine("PATCH /v1/dashboards/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchDashboard1(@Param("id") UUID id, Object body);
/**
* Update a dashboard
* Similar to patchDashboard1 but it also returns the http response headers .
* Update an existing dashboard using JsonPatch.
* @param id Id of the dashboard (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a dashboard Documentation
*/
@RequestLine("PATCH /v1/dashboards/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchDashboard1WithHttpInfo(@Param("id") UUID id, Object body);
/**
* Remove a follower
* Remove the user identified `userId` as a follower of the dashboard.
* @param id Id of the dashboard (required)
* @param userId Id of the user being removed as follower (required)
*/
@RequestLine("DELETE /v1/dashboards/{id}/followers/{userId}")
@Headers({
"Accept: application/json",
})
void removeFollowerFromDashboard(@Param("id") UUID id, @Param("userId") UUID userId);
/**
* Remove a follower
* Similar to removeFollowerFromDashboard but it also returns the http response headers .
* Remove the user identified `userId` as a follower of the dashboard.
* @param id Id of the dashboard (required)
* @param userId Id of the user being removed as follower (required)
*/
@RequestLine("DELETE /v1/dashboards/{id}/followers/{userId}")
@Headers({
"Accept: application/json",
})
ApiResponse removeFollowerFromDashboardWithHttpInfo(@Param("id") UUID id, @Param("userId") UUID userId);
/**
* Restore a soft deleted dashboard
* Restore a soft deleted dashboard.
* @param restoreEntity (optional)
* @return Dashboard
*/
@RequestLine("PUT /v1/dashboards/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Dashboard restore4(RestoreEntity restoreEntity);
/**
* Restore a soft deleted dashboard
* Similar to restore4 but it also returns the http response headers .
* Restore a soft deleted dashboard.
* @param restoreEntity (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dashboards/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse restore4WithHttpInfo(RestoreEntity restoreEntity);
/**
* Update Vote for a Entity
* Update vote for a Entity
* @param id Id of the Entity (required)
* @param voteRequest (optional)
* @return ChangeEvent
*/
@RequestLine("PUT /v1/dashboards/{id}/vote")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ChangeEvent updateVoteForEntity1(@Param("id") UUID id, VoteRequest voteRequest);
/**
* Update Vote for a Entity
* Similar to updateVoteForEntity1 but it also returns the http response headers .
* Update vote for a Entity
* @param id Id of the Entity (required)
* @param voteRequest (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dashboards/{id}/vote")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse updateVoteForEntity1WithHttpInfo(@Param("id") UUID id, VoteRequest voteRequest);
}