Package com.cdancy.bitbucket.rest.features

Interface InsightsApi

@Produces("application/json")
@Path("/rest/insights/{jclouds.api-version}")
public interface InsightsApi

Method Summary

Modifier and Type	Method	Description
RequestStatus	createAnnotation(String project, String repo, String commitId, String key, String externalId, Annotation annotation)
RequestStatus	createAnnotations(String project, String repo, String commitId, String key, CreateAnnotations createAnnotations)
InsightReport	createReport(String project, String repo, String commitId, String key, CreateInsightReport createInsightReport)
RequestStatus	deleteAnnotation(String project, String repo, String commitId, String key, String externalId)
RequestStatus	deleteReport(String project, String repo, String commitId, String key)
AnnotationsResponse	getAnnotationsByReport(String project, String repo, String commitId, String key)
InsightReport	getReport(String project, String repo, String commitId, String key)
AnnotationsResponse	listAnnotations(String project, String repo, String commitId, String externalId, String path, String severity, String type)
InsightReportPage	listReports(String project, String repo, String commitId, int limit, int start)

Method Detail

listAnnotations

@Named("insights:get-annotations")
@Consumes("application/json")
@Path("/projects/{project}/repos/{repo}/commits/{commitId}/annotations")
@GET
AnnotationsResponse listAnnotations(@PathParam("project")
                                    String project,
                                    @PathParam("repo")
                                    String repo,
                                    @PathParam("commitId")
                                    String commitId,
                                    @Nullable @QueryParam("externalId")
                                    String externalId,
                                    @Nullable @QueryParam("path")
                                    String path,
                                    @Nullable @QueryParam("severity")
                                    String severity,
                                    @Nullable @QueryParam("type")
                                    String type)

listReports

@Named("insights:get-reports")
@Consumes("application/json")
@Path("/projects/{project}/repos/{repo}/commits/{commitId}/reports")
@GET
InsightReportPage listReports(@PathParam("project")
                              String project,
                              @PathParam("repo")
                              String repo,
                              @PathParam("commitId")
                              String commitId,
                              @Nullable @QueryParam("limit")
                              int limit,
                              @Nullable @QueryParam("start")
                              int start)

getReport

@Named("insights:get-report")
@Consumes("application/json")
@Path("/projects/{project}/repos/{repo}/commits/{commitId}/reports/{key}")
@GET
InsightReport getReport(@PathParam("project")
                        String project,
                        @PathParam("repo")
                        String repo,
                        @PathParam("commitId")
                        String commitId,
                        @PathParam("key")
                        String key)

createReport

@Named("insights:create-report")
@Consumes("application/json")
@Path("/projects/{project}/repos/{repo}/commits/{commitId}/reports/{key}")
@PUT
InsightReport createReport(@PathParam("project")
                           String project,
                           @PathParam("repo")
                           String repo,
                           @PathParam("commitId")
                           String commitId,
                           @PathParam("key")
                           String key,
                           CreateInsightReport createInsightReport)

deleteReport

@Named("insights:delete-report")
@Consumes("application/json")
@Path("/projects/{project}/repos/{repo}/commits/{commitId}/reports/{key}")
@DELETE
RequestStatus deleteReport(@PathParam("project")
                           String project,
                           @PathParam("repo")
                           String repo,
                           @PathParam("commitId")
                           String commitId,
                           @PathParam("key")
                           String key)

deleteAnnotation

@Named("insights:delete-annotation")
@Consumes("application/json")
@Path("/projects/{project}/repos/{repo}/commits/{commitId}/reports/{key}/annotations")
@DELETE
RequestStatus deleteAnnotation(@PathParam("project")
                               String project,
                               @PathParam("repo")
                               String repo,
                               @PathParam("commitId")
                               String commitId,
                               @PathParam("key")
                               String key,
                               @Nullable @QueryParam("externalId")
                               String externalId)

createAnnotations

@Named("insights:create-annotations")
@Consumes("application/json")
@Path("/projects/{project}/repos/{repo}/commits/{commitId}/reports/{key}/annotations")
@POST
RequestStatus createAnnotations(@PathParam("project")
                                String project,
                                @PathParam("repo")
                                String repo,
                                @PathParam("commitId")
                                String commitId,
                                @PathParam("key")
                                String key,
                                CreateAnnotations createAnnotations)

getAnnotationsByReport

@Named("insights:get-annotations")
@Consumes("application/json")
@Path("/projects/{project}/repos/{repo}/commits/{commitId}/reports/{key}/annotations")
@GET
AnnotationsResponse getAnnotationsByReport(@PathParam("project")
                                           String project,
                                           @PathParam("repo")
                                           String repo,
                                           @PathParam("commitId")
                                           String commitId,
                                           @PathParam("key")
                                           String key)

createAnnotation

@Named("insights:create-annotation")
@Consumes("application/json")
@Path("/projects/{project}/repos/{repo}/commits/{commitId}/reports/{key}/annotations/{externalId}")
@PUT
RequestStatus createAnnotation(@PathParam("project")
                               String project,
                               @PathParam("repo")
                               String repo,
                               @PathParam("commitId")
                               String commitId,
                               @PathParam("key")
                               String key,
                               @PathParam("externalId")
                               String externalId,
                               Annotation annotation)