Trying to do something more standard, like groovy docs - http://docs.groovy-lang.org/latest/html/api/groovy/time/TimeCategory.html
Context Variables
| Name | Description |
|---|---|
| FLX_MESSAGE_ID |
| Unique id for the incoming webhook message |
| FLX_PRISTINE_PAYLOAD |
| Pristine (untouched) payload from the sender. Use this payload when generating hmac strings | |
| FLX_REMOTE_ADDR | Remote address of the incoming request |
| FLX_REMOTE_HOST | Remote host of the incoming request |
| HTTP_HEADERS | Headers of the incoming request |
| PAYLOAD | Hash map of incoming payload. Nodes can be referenced with dot notation. PAYLOAD.field2.field3 |
| QUERY_PARAMS |
Methods
FLEXDEPLOY
| Query parameters of the incoming request |
Function Classes
LOG
...
GITHUB
...
BITBUCKET
...
JIRA
...
SLACK
| Class | Description |
|---|---|
| addFilesToPackageFLEXDEPLOY | Add files to a given project package |
| projectId | Id of project package is in |
| packageName | Name of package to add files to |
| files | Filepaths of files to add |
| addPackagesToRelease | Add package(s) to an existing release |
| releaseName | Name of release to add packages to |
| releaseProjects | A list of release project pojos to add. ****describe pojo***** |
| addProjectsToRelease | Add project(s) to an existing release |
| releaseName | Release name to use |
| projectIds | List of ids for projects to add |
| approveTask | Submits approval for an existing approval task ****should we even document this one??? |
| username | The username to request the approval as |
| taskId | Id of the task to approve |
| notes | Comment to include with approval |
| buildPackage | Build a package for a project. Returns the workflow request id |
| streamId | The stream to build, see findStreamId |
| projectPackage | Pojo containing package information ****pojo description |
| buildPackage | Build a package for a project. Returns the workflow request id |
| streamId | The stream to build, see findStreamId |
| projectPackage | Pojo containing package information ****pojo description |
| pollingResult | PollingResult object to pass to build |
HMAC
...
| Functions to perform actions in FlexDeploy | |
| HMAC | Functions for generating an hmac string |
| LOG | Functions used to print log messages |
| GITHUB | Functions used to get information from a GitHub payload |
| BITBUCKET | Functions used to get information from a Bitbucket payload |
| SLACK | Functions used to get information from a Slack payload |