Namespace: JSON

JSON

Source:

Type Definitions

CommitJSON

Describes a single, specific commit.

Type:
  • Object
Properties:
Name Type Description
id string

An identifier for the commit. For Git repositories, this is the SHA-1 hash.
displayId string

An identifier for the commit suitable for displaying in the UI.
Source:

CommitRangeJSON

Describes a range of commits, with a topographical beginning (since) and end (until).

Type:
  • Object
Properties:
Name Type Description
sinceRevision JSON.CommitJSON

The first revision of the range of commits.
untilRevision JSON.CommitJSON

The last revision of the range of commits.
Source:

FileChangeJSON

Metadata about a change to a file.

Type:
  • Object
Properties:
Name Type Argument Description
repository JSON.RepositoryJSON

The repository containing the file that was changed.
commitRange JSON.CommitRangeJSON

The since revision and the until revision of the file change.
path JSON.PathJSON

The path to the changed content.
srcPath JSON.PathJSON <optional>

The path at which the changed content originated, if different from path.
diff Object <optional>

The diff of the file change. The structure matches the structure for diffs
retrieved via the REST API. This is only provided for handling diffs as
activity items for a pull request. For other usages, diffs must be retrieved
from the server.
Source:

ParticipantJSON

Describes a pull request participant in Stash.

Type:
  • Object
Properties:
Name Type Description
approved boolean

Whether this participant has approved the pull request.
role string

"AUTHOR", "REVIEWER", or "PARTICIPANT"
user JSON.StashUserJSON

The user participating in the pull request.
Source:

PathJSON

Describe a Path in Stash

Type:
  • Object
Properties:
Name Type Description
components Array.<string>

an array of path components
extension string

file extension, if any (and an empty string if there isn't)
name string

the file name
Source:

ProjectJSON

Describes a project in Stash.

Type:
  • Object
Properties:
Name Type Description
id number

An identifier for the project.
name string

The name of the project.
key string

The key of the project.
public boolean

True if the project is publicly accessible.
avatarUrl string

A URL to the project's avatar.
Source:

PullRequestJSON

Describes a pull request in Stash.

Type:
  • Object
Properties:
Name Type Description
author JSON.ParticipantJSON

The author of the pull request.
createdDate string

The date the pull request was first created, in ISO-8601 form.
description string

The user-provided description for this pull request.
descriptionAsHtml string

The rendered HTML result for the user-provided description.
id number

The ID of the pull request, unique within its repository.
fromRef JSON.RefJSON

The ref describing the source of this pull request.
participants Array.<JSON.ParticipantJSON>

Non-reviewer participants in the pull request.
reviewers Array.<JSON.ParticipantJSON>

Explicitly listed reviewers of the pull request.
title string

The title of the pull request.
toRef JSON.RefJSON

The ref describing the target/destination of this pull request.
updatedDate string

The date the pull request was last updated, in ISO-8601 form.
version number

A number describing the version of this pull request, updated when the pull request is changed.
Source:

RefJSON

Describes a ref in Stash (e.g. a Git branch or tag).

Type:
  • Object
Properties:
Name Type Description
displayId string

A user-facing id for the ref. No guarantees are made about the format of the output.
id string

A unique identifier for the ref, within its repository.
isDefault boolean

Whether this is the default ref for the repository.
hash string

Tags can also have a hash property when they aren't simply pointers to a commit. It points to the rich tag object
latestCommit string

The hash for the most recent commit on the branch.
repository JSON.RepositoryJSON

The repository this ref is associated with.
type Object

Contains an id property with value 'tag', 'branch', or 'commit', describing the kind of ref this is.
Source:

RepositoryJSON

Describes a repository in Stash.

Type:
  • Object
Properties:
Name Type Description
id number

An identifier for the repository.
name string

The name of the repository.
slug string

The slug of the repository which is a URL-friendly variant of its name.
project JSON.ProjectJSON

The project the repository belongs to.
scmId string

The identifier of the repository's SCM.
public boolean

True if the repository is publicly accessible.
cloneUrl string

The repository's HTTP clone URL.
Source:

StashUserJSON

Describes a user in Stash.

Type:
  • Object
Properties:
Name Type Argument Description
active boolean

True if the user is an active user.
avatarUrl string <optional>

A URL where the user's avatar can be retrieved. This property's availability depends on the caller providing a requested avatarSize when the user data is requested.
displayName string

The user's human-readable name. E.g. Adam Ahmed
emailAddress string

The user's email address.
id number

A numeric unique ID for the user.
name string

The login/username for the user.
slug string

A URL-safe id for the user. Use this when constructing URLs for user information.
type string

Currently "NORMAL" or "SERVICE", where "SERVICE" users are not backed by a Crowd entity and cannot authenticate via the UI.
Source: