Class: cloudSpecs

cloudSpecs(domainOrOptionsopt)

new cloudSpecs(domainOrOptionsopt)

Parameters:
Name Type Attributes Description
domainOrOptions string | object <optional>
The project domain or options object. If object, see the object's optional properties.
Properties
Name Type Attributes Description
domain string <optional>
The project domain
token object <optional>
auth token - object with value property and optional headerOrQueryName and isQuery properties
Source:

Methods

getSpecById(specId)

Find spec by spec specId
Parameters:
Name Type Description
specId string Id of spec to be fetched
Source:

getSpecList(name, status, limit, offset)

Get a list of specs
Parameters:
Name Type Description
name string Spec name filter (exact match)
status string Spec status filter (exact match)
limit integer Number of results to display
offset integer The starting position of the query
Source:

setToken(value, headerOrQueryName, isQuery)

Set Token
Parameters:
Name Type Description
value string token's value
headerOrQueryName string the header or query name to send the token at
isQuery boolean true if send the token as query param, otherwise, send as header param
Source: