public class

ResourcePatterns

extends Object
java.lang.Object
   ↳ com.atlassian.bitbucket.rest.util.ResourcePatterns

Class Overview

An enumeration of root resource paths for Stash's REST APIs.

Summary

Constants
String COMMENT_ID
String COMMENT_ID_PATH
String COMMENT_URI The generic root resource for Comment-related resources.
String COMMIT_ID
String COMMIT_ID_PATH
String COMMIT_URI The root resource path for Commit Commit-related resources.
String PROJECT_KEY
String PROJECT_KEY_PATH
String PROJECT_URI The root resource path for Project-related resources.
String PULL_REQUEST_ID
String PULL_REQUEST_ID_PATH
String PULL_REQUEST_URI The root resource path for PullRequest-related resources.
String REPOSITORY_SLUG
String REPOSITORY_SLUG_PATH
String REPOSITORY_URI The root resource path for Repository-related resources.
String TASK_ID
String TASK_ID_PATH
String TASK_URI The root resource for Task-related resources.
String USER_SLUG
String USER_SLUG_PATH
String USER_URI The root resource path for ApplicationUser-related resources.
Public Constructors
ResourcePatterns()
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String COMMENT_ID

Constant Value: "commentId"

public static final String COMMENT_ID_PATH

Constant Value: "{commentId}"

public static final String COMMENT_URI

The generic root resource for Comment-related resources. This needs to be used in combination with either PROJECT_URI, or COMMIT_URI, to construct a comment root resource for comments associated with the respective "parent" resources. Refer to the documentation of those parent resources for the entities that can be injected using the Context annotation when using this URI.

Constant Value: "/comments"

public static final String COMMIT_ID

Constant Value: "commitId"

public static final String COMMIT_ID_PATH

Constant Value: "{commitId}"

public static final String COMMIT_URI

The root resource path for Commit Commit-related resources. Resources with Path paths under this URI can use the Context annotation to inject the Project and Repository objects referenced by the {projectKey} and {repositorySlug} path parameters of the context request.

Constant Value: "projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}"

public static final String PROJECT_KEY

Constant Value: "projectKey"

public static final String PROJECT_KEY_PATH

Constant Value: "{projectKey}"

public static final String PROJECT_URI

The root resource path for Project-related resources. Resources with Path paths under this URI can use the Context annotation to inject the Project object referenced by the {projectKey} path parameter of the context request.

Constant Value: "projects/{projectKey}"

public static final String PULL_REQUEST_ID

Constant Value: "pullRequestId"

public static final String PULL_REQUEST_ID_PATH

Constant Value: "{pullRequestId}"

public static final String PULL_REQUEST_URI

The root resource path for PullRequest-related resources. Resources with Path paths under this URI can use the Context annotation to inject the Project, Repository and PullRequest objects referenced by the {projectKey}, {repositorySlug} and {pullRequestId} path parameters of the context request.

Constant Value: "projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}"

public static final String REPOSITORY_SLUG

Constant Value: "repositorySlug"

public static final String REPOSITORY_SLUG_PATH

Constant Value: "{repositorySlug}"

public static final String REPOSITORY_URI

The root resource path for Repository-related resources. Resources with Path paths under this URI can use the Context annotation to inject the Project and Repository objects referenced by the {projectKey} and {repositorySlug} path parameters of the context request.

Constant Value: "projects/{projectKey}/repos/{repositorySlug}"

public static final String TASK_ID

Constant Value: "taskId"

public static final String TASK_ID_PATH

Constant Value: "{taskId}"

public static final String TASK_URI

The root resource for Task-related resources. TODO

Constant Value: "tasks"

public static final String USER_SLUG

Constant Value: "userSlug"

public static final String USER_SLUG_PATH

Constant Value: "{userSlug}"

public static final String USER_URI

The root resource path for ApplicationUser-related resources. Resources with Path paths under this URI can use the Context annotation to inject the ApplicationUser object referenced by the {username} path parameter of the context request.

Constant Value: "users/{userSlug}"

Public Constructors

public ResourcePatterns ()