Home Reference Source

Typedef

Static Public Summary
public	JiraApiWithXrayOptions: *
public	JiraIssueCreationJson: *
public	OAuth: *
public	TestExecNUnitXml: *
public	TestExecXrayJson: *
public	TestExecXrayJsonEvidence: *
public	TestExecXrayJsonInfo: *
public	TestExecXrayJsonResult: *
public	TestExecXrayJsonTestRun: *
public	TestExecXrayJsonTestStep: *
public	XrayImportQueryParams: *
public	makeXrayUriOptions: *

Static Public

public JiraApiWithXrayOptions: * source

Properties:

Name	Type	Attribute	Description
protocol	string	optional default: http	What protocol to use to connect to Jira? Ex: http\|https
host	string		What host is this tool connecting to for the Jira instance? Ex: jira.somehost.com
port	string	optional	What port is this tool connecting to Jira with? Only needed for none standard ports. Ex: 8080, 3000, etc
username	string	optional	Specify a username for this tool to authenticate all requests with.
password	string	optional	Specify a password for this tool to authenticate all requests with.
apiVersion	string	optional default: 2	What version of the Jira REST API is the instance the tool is connecting to?
base	string	optional	What other url parts exist, if any, before the rest/api/ section?
intermediatePath	string	optional	If specified, overwrites the default rest/api/version section of the uri
strictSSL	boolean	optional default: true	Does this tool require each request to be authenticated? Defaults to true.
request	function	optional	What method does this tool use to make its requests? Defaults to request from request-promise
timeout	number	optional	Integer containing the number of milliseconds to wait for a server to send response headers (and start the response body) before aborting the request. Note that if the underlying TCP connection cannot be established, the OS-wide TCP connection timeout will overrule the timeout option (the default in Linux can be anywhere from 20-120 * seconds).
webhookVersion	string	optional default: 1.0	What webhook version does this api wrapper need to hit?
greenhopperVersion	string	optional default: 1.0	What webhook version does this api wrapper need to hit?
oauth	OAuth	optional	Specify an OAuth object for this tool to authenticate all requests using OAuth.
bearer	string	optional	Specify a OAuth bearer token to authenticate all requests with.
xrayVersion	string	optional default: 1.0	What version of the "Xray for Jira" REST API is the instance the tool is connecting to?

public JiraIssueCreationJson: * source

public OAuth: * source

Properties:

Name	Type	Attribute	Description
consumer_key	string		The consumer entered in Jira Preferences.
consumer_secret	string		The private RSA file.
access_token	string		The generated access token.
access_token_secret	string		The generated access toke secret.
signature_method	string		[signature_method=RSA-SHA1] - OAuth signurate methode Possible values RSA-SHA1, HMAC-SHA1, PLAINTEXT. Jira Cloud supports only RSA-SHA1.

public TestExecNUnitXml: * source

public TestExecXrayJson: * source

Properties:

Name	Type	Attribute	Description
testExecutionKey	string	optional	The Jira issue key for an existing Test Execution that should be updated. If omitted, a new Test Execution is created automatically.
info	TestExecXrayJsonInfo	optional	Test Execution metadata
tests	TestExecXrayJsonTestRun[]		The results of the Test Run

See:

https://confluence.xpand-addons.com/display/XRAY/Import+Execution+Results#ImportExecutionResults-XrayJSONformat

public TestExecXrayJsonEvidence: * source

Properties:

Name	Type	Attribute	Description
data	string		The base64-encoded string of data representing this attachment
filename	string		The basename of the file associated with this attachment
contentType	string	optional	The MIME type associated with this attachment, e.g. "image/jpeg"

public TestExecXrayJsonInfo: * source

Properties:

Name	Type	Attribute	Description
project	string	optional	The Jira project ID
summary	string		Summary of the Test Execution
description	string	optional	Description of the Test Execution
user	string	optional	The Jira user logging the Test Execution results
version	string	optional	Version under test
revision	string	optional	The revision/build/branch under test
startDate	string	optional	The ISO date timestamp at which the Test Execution started
finishDate	string	optional	The ISO date timestamp at which the Test Execution finished
testPlanKey	string	optional	The Jira issue key for the associated Test Plan
testEnvironments	string[]	optional	The environmental configuration under test

public TestExecXrayJsonResult: * source

Properties:

Name	Type	Attribute	Description
name	string		The name of the test case
status	string		The "PASS" or "FAIL" status of this test case
duration	number	optional	The duration (milliseconds? seconds?)
log	string	optional	Any log messages that came out of this test case
examples	string[]	optional	The "PASS" or "FAIL" status for each of this test case's examples

public TestExecXrayJsonTestRun: * source

Properties:

Name	Type	Attribute	Description
testKey	string		The Jira issue key for the associated Test
status	string		The "PASS" or "FAIL" status for the Test Run as a whole
comment	string	optional	A message about this Test Run
start	string	optional	The ISO date timestamp at which this Test Run started
finish	string	optional	The ISO date timestamp at which this Test Run finished
executedBy	string	optional	The Jira user who executed this Test Run
evidences	TestExecXrayJsonEvidence[]	optional	Attachments (e.g. screenshots) proving the Test Run's failure
results	TestExecXrayJsonResult[]	optional	Detailed results of individual test cases within this Test Run
examples	string[]	optional	The "PASS" or "FAIL" status for each of the Test Run's examples
steps	TestExecXrayJsonTestStep[]	optional	Details about each Test step and its outcome
defects	string[]	optional	The Jira issue keys for any associated bugs recorded during this Test Run

public TestExecXrayJsonTestStep: * source

Properties:

Name	Type	Attribute	Description
status	string		The "PASS" or "FAIL" status of this step
comment	string	optional	A message about this step
evidences	TestExecXrayJsonEvidence[]	optional	Attachments (e.g. screenshots) proving this step's failure

public XrayImportQueryParams: * source

Properties:

Name	Type	Attribute	Description
testExecKey	string	optional	The Jira issue key for an existing Test Execution that should be updated. If omitted, a new Test Execution is created automatically in the Jira project indicated by `projectKey`. Either `testExecKey` or `projectKey` must be provided.
projectKey	string	optional	The Jira project key where the new Test Execution issue should be created. Not needed if `testExecKey` is provided. Either `testExecKey` or `projectKey` must be provided.
testPlanKey	string	optional	The Jira issue key for the associated Test Plan
testEnvironments	string \| string[]	optional	The list of test environments. If provided as a string, items must be delimited by a ";".
revision	string	optional	Source code and documentation version used in the Test Execution
fixVersion	string	optional	The Jira "Fix Version" to be associated with the Test Execution

public makeXrayUriOptions: * source

Properties:

Name	Type	Attribute	Description
pathname	string		The url after the /rest/raven/version
intermediatePath	string		If specified will overwrite the /rest/raven/version section