bitbucket-api-client-lib

SnippetsApi

All URIs are relative to https://api.bitbucket.org/2.0

Method	HTTP request	Description
snippetsGet	GET /snippets
snippetsPost	POST /snippets
snippetsWorkspaceEncodedIdCommentsCommentIdDelete	DELETE /snippets/{workspace}/{encoded_id}/comments/{comment_id}
snippetsWorkspaceEncodedIdCommentsCommentIdGet	GET /snippets/{workspace}/{encoded_id}/comments/{comment_id}
snippetsWorkspaceEncodedIdCommentsCommentIdPut	PUT /snippets/{workspace}/{encoded_id}/comments/{comment_id}
snippetsWorkspaceEncodedIdCommentsGet	GET /snippets/{workspace}/{encoded_id}/comments
snippetsWorkspaceEncodedIdCommentsPost	POST /snippets/{workspace}/{encoded_id}/comments
snippetsWorkspaceEncodedIdCommitsGet	GET /snippets/{workspace}/{encoded_id}/commits
snippetsWorkspaceEncodedIdCommitsRevisionGet	GET /snippets/{workspace}/{encoded_id}/commits/{revision}
snippetsWorkspaceEncodedIdDelete	DELETE /snippets/{workspace}/{encoded_id}
snippetsWorkspaceEncodedIdGet	GET /snippets/{workspace}/{encoded_id}
snippetsWorkspaceEncodedIdNodeIdDelete	DELETE /snippets/{workspace}/{encoded_id}/{node_id}
snippetsWorkspaceEncodedIdNodeIdFilesPathGet	GET /snippets/{workspace}/{encoded_id}/{node_id}/files/{path}
snippetsWorkspaceEncodedIdNodeIdGet	GET /snippets/{workspace}/{encoded_id}/{node_id}
snippetsWorkspaceEncodedIdNodeIdPut	PUT /snippets/{workspace}/{encoded_id}/{node_id}
snippetsWorkspaceEncodedIdPut	PUT /snippets/{workspace}/{encoded_id}
snippetsWorkspaceEncodedIdRevisionDiffGet	GET /snippets/{workspace}/{encoded_id}/{revision}/diff
snippetsWorkspaceEncodedIdRevisionPatchGet	GET /snippets/{workspace}/{encoded_id}/{revision}/patch
snippetsWorkspaceEncodedIdWatchDelete	DELETE /snippets/{workspace}/{encoded_id}/watch
snippetsWorkspaceEncodedIdWatchGet	GET /snippets/{workspace}/{encoded_id}/watch
snippetsWorkspaceEncodedIdWatchPut	PUT /snippets/{workspace}/{encoded_id}/watch
snippetsWorkspaceEncodedIdWatchersGet	GET /snippets/{workspace}/{encoded_id}/watchers
snippetsWorkspaceGet	GET /snippets/{workspace}
snippetsWorkspacePost	POST /snippets/{workspace}

snippetsGet

PaginatedSnippets snippetsGet(role)

Returns all snippets. Like pull requests, repositories and workspaces, the full set of snippets is defined by what the current user has access to. This includes all snippets owned by any of the workspaces the user is a member of, or snippets by other users that the current user is either watching or has collaborated on (for instance by commenting on it). To limit the set of returned snippets, apply the `?role=[owner

contributor

member]` query parameter where the roles are defined as follows: * `owner`: all snippets owned by the current user * `contributor`: all snippets owned by, or watched by the current user * `member`: created in a workspaces or watched by the current user When no role is specified, all public snippets are returned, as well as all privately owned snippets watched or commented on. The returned response is a normal paginated JSON list. This endpoint only supports `application/json` responses and no `multipart/form-data` or `multipart/related`. As a result, it is not possible to include the file contents.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String role = "role_example"; // String | Filter down the result based on the authenticated user's role (`owner`, `contributor`, or `member`).
try {
    PaginatedSnippets result = apiInstance.snippetsGet(role);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
role	String	Filter down the result based on the authenticated user's role (`owner`, `contributor`, or `member`).	[optional] [enum: owner, contributor, member]

Return type

PaginatedSnippets

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsPost

Snippet snippetsPost(body)

Creates a new snippet under the authenticated user's account. Snippets can contain multiple files. Both text and binary files are supported. The simplest way to create a new snippet from a local file: $ curl -u username:password -X POST https://api.bitbucket.org/2.0/snippets -F file=@image.png Creating snippets through curl has a few limitations and so let's look at a more complicated scenario. Snippets are created with a multipart POST. Both `multipart/form-data` and `multipart/related` are supported. Both allow the creation of snippets with both meta data (title, etc), as well as multiple text and binary files. The main difference is that `multipart/related` can use rich encoding for the meta data (currently JSON). multipart/related (RFC-2387) —————————- This is the most advanced and efficient way to create a paste. POST /2.0/snippets/evzijst HTTP/1.1 Content-Length: 1188 Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\" MIME-Version: 1.0 –===============1438169132528273974== Content-Type: application/json; charset=\"utf-8\" MIME-Version: 1.0 Content-ID: snippet { \"title\": \"My snippet\", \"is_private\": true, \"scm\": \"hg\", \"files\": { \"foo.txt\": {}, \"image.png\": {} } } –===============1438169132528273974== Content-Type: text/plain; charset=\"us-ascii\" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-ID: \"foo.txt\" Content-Disposition: attachment; filename=\"foo.txt\" foo –===============1438169132528273974== Content-Type: image/png MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-ID: \"image.png\" Content-Disposition: attachment; filename=\"image.png\" iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5 EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg== –===============1438169132528273974==– The request contains multiple parts and is structured as follows. The first part is the JSON document that describes the snippet's properties or meta data. It either has to be the first part, or the request's `Content-Type` header must contain the `start` parameter to point to it. The remaining parts are the files of which there can be zero or more. Each file part should contain the `Content-ID` MIME header through which the JSON meta data's `files` element addresses it. The value should be the name of the file. `Content-Disposition` is an optional MIME header. The header's optional `filename` parameter can be used to specify the file name that Bitbucket should use when writing the file to disk. When present, `filename` takes precedence over the value of `Content-ID`. When the JSON body omits the `files` element, the remaining parts are not ignored. Instead, each file is added to the new snippet as if its name was explicitly linked (the use of the `files` elements is mandatory for some operations like deleting or renaming files). multipart/form-data ——————- The use of JSON for the snippet's meta data is optional. Meta data can also be supplied as regular form fields in a more conventional `multipart/form-data` request: $ curl -X POST -u credentials https://api.bitbucket.org/2.0/snippets -F title=\"My snippet\" -F file=@foo.txt -F file=@image.png POST /2.0/snippets HTTP/1.1 Content-Length: 951 Content-Type: multipart/form-data; boundary=—————————-63a4b224c59f ——————————63a4b224c59f Content-Disposition: form-data; name=\"file\"; filename=\"foo.txt\" Content-Type: text/plain foo ——————————63a4b224c59f Content-Disposition: form-data; name=\"file\"; filename=\"image.png\" Content-Type: application/octet-stream ?PNG IHDR?1??I….. ——————————63a4b224c59f Content-Disposition: form-data; name=\"title\" My snippet ——————————63a4b224c59f– Here the meta data properties are included as flat, top-level form fields. The file attachments use the `file` field name. To attach multiple files, simply repeat the field. The advantage of `multipart/form-data` over `multipart/related` is that it can be easier to build clients. Essentially all properties are optional, `title` and `files` included. Sharing and Visibility ———————- Snippets can be either public (visible to anyone on Bitbucket, as well as anonymous users), or private (visible only to members of the workspace). This is controlled through the snippet's `is_private` element: * is_private=false – everyone, including anonymous users can view the snippet * is_private=true – only workspace members can view the snippet To create the snippet under a workspace, just append the workspace ID to the URL. See `/2.0/snippets/{workspace}`.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
Snippet body = new Snippet(); // Snippet | The new snippet object.
try {
    Snippet result = apiInstance.snippetsPost(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsPost");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	Snippet	The new snippet object.

Return type

Snippet

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

snippetsWorkspaceEncodedIdCommentsCommentIdDelete

snippetsWorkspaceEncodedIdCommentsCommentIdDelete(commentId, encodedId, workspace)

Deletes a snippet comment. Comments can only be removed by their author.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String commentId = "commentId_example"; // String | 
String encodedId = "encodedId_example"; // String | 
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
try {
    apiInstance.snippetsWorkspaceEncodedIdCommentsCommentIdDelete(commentId, encodedId, workspace);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdCommentsCommentIdDelete");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
commentId	String
encodedId	String
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.

Return type

null (empty response body)

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdCommentsCommentIdGet

SnippetComment snippetsWorkspaceEncodedIdCommentsCommentIdGet(commentId, encodedId, workspace)

Returns the specific snippet comment.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String commentId = "commentId_example"; // String | 
String encodedId = "encodedId_example"; // String | 
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
try {
    SnippetComment result = apiInstance.snippetsWorkspaceEncodedIdCommentsCommentIdGet(commentId, encodedId, workspace);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdCommentsCommentIdGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
commentId	String
encodedId	String
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.

Return type

SnippetComment

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdCommentsCommentIdPut

snippetsWorkspaceEncodedIdCommentsCommentIdPut(commentId, encodedId, workspace)

Updates a comment. Comments can only be updated by their author.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String commentId = "commentId_example"; // String | 
String encodedId = "encodedId_example"; // String | 
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
try {
    apiInstance.snippetsWorkspaceEncodedIdCommentsCommentIdPut(commentId, encodedId, workspace);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdCommentsCommentIdPut");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
commentId	String
encodedId	String
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.

Return type

null (empty response body)

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdCommentsGet

PaginatedSnippetComments snippetsWorkspaceEncodedIdCommentsGet(encodedId, workspace)

Used to retrieve a paginated list of all comments for a specific snippet. This resource works identical to commit and pull request comments. The default sorting is oldest to newest and can be overridden with the `sort` query parameter.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String encodedId = "encodedId_example"; // String | 
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
try {
    PaginatedSnippetComments result = apiInstance.snippetsWorkspaceEncodedIdCommentsGet(encodedId, workspace);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdCommentsGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
encodedId	String
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.

Return type

PaginatedSnippetComments

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdCommentsPost

Snippet snippetsWorkspaceEncodedIdCommentsPost(body, encodedId, workspace)

Creates a new comment. The only required field in the body is `content.raw`. To create a threaded reply to an existing comment, include `parent.id`.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
Snippet body = new Snippet(); // Snippet | The contents of the new comment.
String encodedId = "encodedId_example"; // String | 
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
try {
    Snippet result = apiInstance.snippetsWorkspaceEncodedIdCommentsPost(body, encodedId, workspace);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdCommentsPost");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	Snippet	The contents of the new comment.
encodedId	String
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.

Return type

Snippet

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

snippetsWorkspaceEncodedIdCommitsGet

PaginatedSnippetCommit snippetsWorkspaceEncodedIdCommitsGet(encodedId, workspace)

Returns the changes (commits) made on this snippet.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String encodedId = "encodedId_example"; // String | 
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
try {
    PaginatedSnippetCommit result = apiInstance.snippetsWorkspaceEncodedIdCommitsGet(encodedId, workspace);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdCommitsGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
encodedId	String
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.

Return type

PaginatedSnippetCommit

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdCommitsRevisionGet

SnippetCommit snippetsWorkspaceEncodedIdCommitsRevisionGet(encodedId, revision, workspace)

Returns the changes made on this snippet in this commit.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String encodedId = "encodedId_example"; // String | 
String revision = "revision_example"; // String | 
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
try {
    SnippetCommit result = apiInstance.snippetsWorkspaceEncodedIdCommitsRevisionGet(encodedId, revision, workspace);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdCommitsRevisionGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
encodedId	String
revision	String
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.

Return type

SnippetCommit

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdDelete

snippetsWorkspaceEncodedIdDelete(workspace, encodedId)

Deletes a snippet and returns an empty response.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
String encodedId = "encodedId_example"; // String | The snippet's id.
try {
    apiInstance.snippetsWorkspaceEncodedIdDelete(workspace, encodedId);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdDelete");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.
encodedId	String	The snippet's id.

Return type

null (empty response body)

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdGet

Snippet snippetsWorkspaceEncodedIdGet(workspace, encodedId)

Retrieves a single snippet. Snippets support multiple content types: * application/json * multipart/related * multipart/form-data application/json —————- The default content type of the response is `application/json`. Since JSON is always `utf-8`, it cannot reliably contain file contents for files that are not text. Therefore, JSON snippet documents only contain the filename and links to the file contents. This means that in order to retrieve all parts of a snippet, N+1 requests need to be made (where N is the number of files in the snippet). multipart/related —————– To retrieve an entire snippet in a single response, use the `Accept: multipart/related` HTTP request header. $ curl -H \"Accept: multipart/related\" https://api.bitbucket.org/2.0/snippets/evzijst/1 Response: HTTP/1.1 200 OK Content-Length: 2214 Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\" MIME-Version: 1.0 –===============1438169132528273974== Content-Type: application/json; charset=\"utf-8\" MIME-Version: 1.0 Content-ID: snippet { \"links\": { \"self\": { \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj\" }, \"html\": { \"href\": \"https://bitbucket.org/snippets/evzijst/kypj\" }, \"comments\": { \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/comments\" }, \"watchers\": { \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/watchers\" }, \"commits\": { \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/commits\" } }, \"id\": kypj, \"title\": \"My snippet\", \"created_on\": \"2014-12-29T22:22:04.790331+00:00\", \"updated_on\": \"2014-12-29T22:22:04.790331+00:00\", \"is_private\": false, \"files\": { \"foo.txt\": { \"links\": { \"self\": { \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/foo.txt\" }, \"html\": { \"href\": \"https://bitbucket.org/snippets/evzijst/kypj#file-foo.txt\" } } }, \"image.png\": { \"links\": { \"self\": { \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/image.png\" }, \"html\": { \"href\": \"https://bitbucket.org/snippets/evzijst/kypj#file-image.png\" } } } ], \"owner\": { \"username\": \"evzijst\", \"nickname\": \"evzijst\", \"display_name\": \"Erik van Zijst\", \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\", \"links\": { \"self\": { \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\" }, \"html\": { \"href\": \"https://bitbucket.org/evzijst\" }, \"avatar\": { \"href\": \"https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png\" } } }, \"creator\": { \"username\": \"evzijst\", \"nickname\": \"evzijst\", \"display_name\": \"Erik van Zijst\", \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\", \"links\": { \"self\": { \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\" }, \"html\": { \"href\": \"https://bitbucket.org/evzijst\" }, \"avatar\": { \"href\": \"https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png\" } } } } –===============1438169132528273974== Content-Type: text/plain; charset=\"us-ascii\" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-ID: \"foo.txt\" Content-Disposition: attachment; filename=\"foo.txt\" foo –===============1438169132528273974== Content-Type: image/png MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-ID: \"image.png\" Content-Disposition: attachment; filename=\"image.png\" iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5 EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg== –===============1438169132528273974==– multipart/form-data ——————- As with creating new snippets, `multipart/form-data` can be used as an alternative to `multipart/related`. However, the inherently flat structure of form-data means that only basic, root-level properties can be returned, while nested elements like `links` are omitted: $ curl -H \"Accept: multipart/form-data\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj Response: HTTP/1.1 200 OK Content-Length: 951 Content-Type: multipart/form-data; boundary=—————————-63a4b224c59f ——————————63a4b224c59f Content-Disposition: form-data; name=\"title\" Content-Type: text/plain; charset=\"utf-8\" My snippet ——————————63a4b224c59f– Content-Disposition: attachment; name=\"file\"; filename=\"foo.txt\" Content-Type: text/plain foo ——————————63a4b224c59f Content-Disposition: attachment; name=\"file\"; filename=\"image.png\" Content-Transfer-Encoding: base64 Content-Type: application/octet-stream iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5 EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg== ——————————5957323a6b76–

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
String encodedId = "encodedId_example"; // String | The snippet's id.
try {
    Snippet result = apiInstance.snippetsWorkspaceEncodedIdGet(workspace, encodedId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.
encodedId	String	The snippet's id.

Return type

Snippet

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, multipart/related, multipart/form-data

snippetsWorkspaceEncodedIdNodeIdDelete

snippetsWorkspaceEncodedIdNodeIdDelete(nodeId, workspace, encodedId)

Deletes the snippet. Note that this only works for versioned URLs that point to the latest commit of the snippet. Pointing to an older commit results in a 405 status code. To delete a snippet, regardless of whether or not concurrent changes are being made to it, use `DELETE /snippets/{encoded_id}` instead.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String nodeId = "nodeId_example"; // String | 
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
String encodedId = "encodedId_example"; // String | The snippet's id.
try {
    apiInstance.snippetsWorkspaceEncodedIdNodeIdDelete(nodeId, workspace, encodedId);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdNodeIdDelete");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
nodeId	String
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.
encodedId	String	The snippet's id.

Return type

null (empty response body)

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdNodeIdFilesPathGet

snippetsWorkspaceEncodedIdNodeIdFilesPathGet(encodedId, nodeId, path, workspace)

Retrieves the raw contents of a specific file in the snippet. The `Content-Disposition` header will be \"attachment\" to avoid issues with malevolent executable files. The file's mime type is derived from its filename and returned in the `Content-Type` header. Note that for text files, no character encoding is included as part of the content type.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String encodedId = "encodedId_example"; // String | 
String nodeId = "nodeId_example"; // String | 
String path = "path_example"; // String | 
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
try {
    apiInstance.snippetsWorkspaceEncodedIdNodeIdFilesPathGet(encodedId, nodeId, path, workspace);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdNodeIdFilesPathGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
encodedId	String
nodeId	String
path	String
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.

Return type

null (empty response body)

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdNodeIdGet

Snippet snippetsWorkspaceEncodedIdNodeIdGet(workspace, encodedId, nodeId)

Identical to `GET /snippets/encoded_id`, except that this endpoint can be used to retrieve the contents of the snippet as it was at an older revision, while `/snippets/encoded_id` always returns the snippet's current revision. Note that only the snippet's file contents are versioned, not its meta data properties like the title. Other than that, the two endpoints are identical in behavior.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
String encodedId = "encodedId_example"; // String | The snippet's id.
String nodeId = "nodeId_example"; // String | A commit revision (SHA1).
try {
    Snippet result = apiInstance.snippetsWorkspaceEncodedIdNodeIdGet(workspace, encodedId, nodeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdNodeIdGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.
encodedId	String	The snippet's id.
nodeId	String	A commit revision (SHA1).

Return type

Snippet

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, multipart/related, multipart/form-data

snippetsWorkspaceEncodedIdNodeIdPut

Snippet snippetsWorkspaceEncodedIdNodeIdPut(workspace, encodedId, nodeId)

Identical to `UPDATE /snippets/encoded_id`, except that this endpoint takes an explicit commit revision. Only the snippet's \"HEAD\"/\"tip\" (most recent) version can be updated and requests on all other, older revisions fail by returning a 405 status. Usage of this endpoint over the unrestricted `/snippets/encoded_id` could be desired if the caller wants to be sure no concurrent modifications have taken place between the moment of the UPDATE request and the original GET. This can be considered a so-called \"Compare And Swap\", or CAS operation. Other than that, the two endpoints are identical in behavior.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
String encodedId = "encodedId_example"; // String | The snippet's id.
String nodeId = "nodeId_example"; // String | A commit revision (SHA1).
try {
    Snippet result = apiInstance.snippetsWorkspaceEncodedIdNodeIdPut(workspace, encodedId, nodeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdNodeIdPut");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.
encodedId	String	The snippet's id.
nodeId	String	A commit revision (SHA1).

Return type

Snippet

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, multipart/related, multipart/form-data

snippetsWorkspaceEncodedIdPut

Snippet snippetsWorkspaceEncodedIdPut(workspace, encodedId)

Used to update a snippet. Use this to add and delete files and to change a snippet's title. To update a snippet, one can either PUT a full snapshot, or only the parts that need to be changed. The contract for PUT on this API is that properties missing from the request remain untouched so that snippets can be efficiently manipulated with differential payloads. To delete a property (e.g. the title, or a file), include its name in the request, but omit its value (use `null`). As in Git, explicit renaming of files is not supported. Instead, to rename a file, delete it and add it again under another name. This can be done atomically in a single request. Rename detection is left to the SCM. PUT supports three different content types for both request and response bodies: * `application/json` * `multipart/related` * `multipart/form-data` The content type used for the request body can be different than that used for the response. Content types are specified using standard HTTP headers. Use the `Content-Type` and `Accept` headers to select the desired request and response format. application/json —————- As with creation and retrieval, the content type determines what properties can be manipulated. `application/json` does not support file contents and is therefore limited to a snippet's meta data. To update the title, without changing any of its files: $ curl -X POST -H \"Content-Type: application/json\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj -d '{\"title\": \"Updated title\"}' To delete the title: $ curl -X POST -H \"Content-Type: application/json\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj -d '{\"title\": null}' Not all parts of a snippet can be manipulated. The owner and creator for instance are immutable. multipart/related —————– `multipart/related` can be used to manipulate all of a snippet's properties. The body is identical to a POST. properties omitted from the request are left unchanged. Since the `start` part contains JSON, the mechanism for manipulating the snippet's meta data is identical to `application/json` requests. To update one of a snippet's file contents, while also changing its title: PUT /2.0/snippets/evzijst/kypj HTTP/1.1 Content-Length: 288 Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\" MIME-Version: 1.0 –===============1438169132528273974== Content-Type: application/json; charset=\"utf-8\" MIME-Version: 1.0 Content-ID: snippet { \"title\": \"My updated snippet\", \"files\": { \"foo.txt\": {} } } –===============1438169132528273974== Content-Type: text/plain; charset=\"us-ascii\" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-ID: \"foo.txt\" Content-Disposition: attachment; filename=\"foo.txt\" Updated file contents. –===============1438169132528273974==– Here only the parts that are changed are included in the body. The other files remain untouched. Note the use of the `files` list in the JSON part. This list contains the files that are being manipulated. This list should have corresponding multiparts in the request that contain the new contents of these files. If a filename in the `files` list does not have a corresponding part, it will be deleted from the snippet, as shown below: PUT /2.0/snippets/evzijst/kypj HTTP/1.1 Content-Length: 188 Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\" MIME-Version: 1.0 –===============1438169132528273974== Content-Type: application/json; charset=\"utf-8\" MIME-Version: 1.0 Content-ID: snippet { \"files\": { \"image.png\": {} } } –===============1438169132528273974==– To simulate a rename, delete a file and add the same file under another name: PUT /2.0/snippets/evzijst/kypj HTTP/1.1 Content-Length: 212 Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\" MIME-Version: 1.0 –===============1438169132528273974== Content-Type: application/json; charset=\"utf-8\" MIME-Version: 1.0 Content-ID: snippet { \"files\": { \"foo.txt\": {}, \"bar.txt\": {} } } –===============1438169132528273974== Content-Type: text/plain; charset=\"us-ascii\" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-ID: \"bar.txt\" Content-Disposition: attachment; filename=\"bar.txt\" foo –===============1438169132528273974==– multipart/form-data —————– Again, one can also use `multipart/form-data` to manipulate file contents and meta data atomically. $ curl -X PUT http://localhost:12345/2.0/snippets/evzijst/kypj -F title=\"My updated snippet\" -F file=@foo.txt PUT /2.0/snippets/evzijst/kypj HTTP/1.1 Content-Length: 351 Content-Type: multipart/form-data; boundary=—————————-63a4b224c59f ——————————63a4b224c59f Content-Disposition: form-data; name=\"file\"; filename=\"foo.txt\" Content-Type: text/plain foo ——————————63a4b224c59f Content-Disposition: form-data; name=\"title\" My updated snippet ——————————63a4b224c59f To delete a file, omit its contents while including its name in the `files` field: $ curl -X PUT https://api.bitbucket.org/2.0/snippets/evzijst/kypj -F files=image.png PUT /2.0/snippets/evzijst/kypj HTTP/1.1 Content-Length: 149 Content-Type: multipart/form-data; boundary=—————————-ef8871065a86 ——————————ef8871065a86 Content-Disposition: form-data; name=\"files\" image.png ——————————ef8871065a86– The explicit use of the `files` element in `multipart/related` and `multipart/form-data` is only required when deleting files. The default mode of operation is for file parts to be processed, regardless of whether or not they are listed in `files`, as a convenience to the client.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
String encodedId = "encodedId_example"; // String | The snippet's id.
try {
    Snippet result = apiInstance.snippetsWorkspaceEncodedIdPut(workspace, encodedId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdPut");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.
encodedId	String	The snippet's id.

Return type

Snippet

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, multipart/related, multipart/form-data

snippetsWorkspaceEncodedIdRevisionDiffGet

snippetsWorkspaceEncodedIdRevisionDiffGet(workspace, encodedId, revision, path)

Returns the diff of the specified commit against its first parent. Note that this resource is different in functionality from the `patch` resource. The differences between a diff and a patch are: * patches have a commit header with the username, message, etc * diffs support the optional `path=foo/bar.py` query param to filter the diff to just that one file diff (not supported for patches) * for a merge, the diff will show the diff between the merge commit and its first parent (identical to how PRs work), while patch returns a response containing separate patches for each commit on the second parent's ancestry, up to the oldest common ancestor (identical to its reachability). Note that the character encoding of the contents of the diff is unspecified as Git and Mercurial do not track this, making it hard for Bitbucket to reliably determine this.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
String encodedId = "encodedId_example"; // String | The snippet id.
String revision = "revision_example"; // String | A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like `staging..production`.
String path = "path_example"; // String | When used, only one the diff of the specified file will be returned.
try {
    apiInstance.snippetsWorkspaceEncodedIdRevisionDiffGet(workspace, encodedId, revision, path);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdRevisionDiffGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.
encodedId	String	The snippet id.
revision	String	A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like `staging..production`.
path	String	When used, only one the diff of the specified file will be returned.	[optional]

Return type

null (empty response body)

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdRevisionPatchGet

snippetsWorkspaceEncodedIdRevisionPatchGet(workspace, encodedId, revision)

Returns the patch of the specified commit against its first parent. Note that this resource is different in functionality from the `diff` resource. The differences between a diff and a patch are: * patches have a commit header with the username, message, etc * diffs support the optional `path=foo/bar.py` query param to filter the diff to just that one file diff (not supported for patches) * for a merge, the diff will show the diff between the merge commit and its first parent (identical to how PRs work), while patch returns a response containing separate patches for each commit on the second parent's ancestry, up to the oldest common ancestor (identical to its reachability). Note that the character encoding of the contents of the patch is unspecified as Git and Mercurial do not track this, making it hard for Bitbucket to reliably determine this.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
String encodedId = "encodedId_example"; // String | The snippet id.
String revision = "revision_example"; // String | A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like `staging..production`.
try {
    apiInstance.snippetsWorkspaceEncodedIdRevisionPatchGet(workspace, encodedId, revision);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdRevisionPatchGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.
encodedId	String	The snippet id.
revision	String	A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like `staging..production`.

Return type

null (empty response body)

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdWatchDelete

PaginatedUsers snippetsWorkspaceEncodedIdWatchDelete(workspace, encodedId)

Used to stop watching a specific snippet. Returns 204 (No Content) to indicate success.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
String encodedId = "encodedId_example"; // String | The snippet id.
try {
    PaginatedUsers result = apiInstance.snippetsWorkspaceEncodedIdWatchDelete(workspace, encodedId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdWatchDelete");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.
encodedId	String	The snippet id.

Return type

PaginatedUsers

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdWatchGet

PaginatedUsers snippetsWorkspaceEncodedIdWatchGet(workspace, encodedId)

Used to check if the current user is watching a specific snippet. Returns 204 (No Content) if the user is watching the snippet and 404 if not. Hitting this endpoint anonymously always returns a 404.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
String encodedId = "encodedId_example"; // String | The snippet id.
try {
    PaginatedUsers result = apiInstance.snippetsWorkspaceEncodedIdWatchGet(workspace, encodedId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdWatchGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.
encodedId	String	The snippet id.

Return type

PaginatedUsers

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdWatchPut

PaginatedUsers snippetsWorkspaceEncodedIdWatchPut(workspace, encodedId)

Used to start watching a specific snippet. Returns 204 (No Content).

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
String encodedId = "encodedId_example"; // String | The snippet id.
try {
    PaginatedUsers result = apiInstance.snippetsWorkspaceEncodedIdWatchPut(workspace, encodedId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdWatchPut");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.
encodedId	String	The snippet id.

Return type

PaginatedUsers

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceEncodedIdWatchersGet

PaginatedUsers snippetsWorkspaceEncodedIdWatchersGet(workspace, encodedId)

Returns a paginated list of all users watching a specific snippet.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String workspace = "workspace_example"; // String | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. 
String encodedId = "encodedId_example"; // String | The snippet id.
try {
    PaginatedUsers result = apiInstance.snippetsWorkspaceEncodedIdWatchersGet(workspace, encodedId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceEncodedIdWatchersGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.
encodedId	String	The snippet id.

Return type

PaginatedUsers

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspaceGet

PaginatedSnippets snippetsWorkspaceGet(workspace, role)

Identical to `/snippets`, except that the result is further filtered by the snippet owner and only those that are owned by `{workspace}` are returned.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
String workspace = "workspace_example"; // String | Limits the result to snippets owned by this workspace.
String role = "role_example"; // String | Filter down the result based on the authenticated user's role (`owner`, `contributor`, or `member`).
try {
    PaginatedSnippets result = apiInstance.snippetsWorkspaceGet(workspace, role);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspaceGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workspace	String	Limits the result to snippets owned by this workspace.
role	String	Filter down the result based on the authenticated user's role (`owner`, `contributor`, or `member`).	[optional] [enum: owner, contributor, member]

Return type

PaginatedSnippets

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

snippetsWorkspacePost

Snippet snippetsWorkspacePost(body, workspace)

Identical to `/snippets`, except that the new snippet will be created under the workspace specified in the path parameter `{workspace}`.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiClient;
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.invoker.Configuration;
//import com.rappi.bitbucket.client.invoker.auth.*;
//import com.rappi.bitbucket.client.api.SnippetsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SnippetsApi apiInstance = new SnippetsApi();
Snippet body = new Snippet(); // Snippet | The new snippet object.
String workspace = "workspace_example"; // String | Create a snippet in the specified workspace.
try {
    Snippet result = apiInstance.snippetsWorkspacePost(body, workspace);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SnippetsApi#snippetsWorkspacePost");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	Snippet	The new snippet object.
workspace	String	Create a snippet in the specified workspace.

Return type

Snippet

Authorization

api_keybasicoauth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

This site is open source. Improve this page.