ex_heroku_client v0.1.0 Heroku.PipelinePromotion

Summary

Functions

Calls POST /pipeline-promotions

Calls GET /pipeline-promotions/#{pipeline-promotion_identity}

Functions

create(params)

Calls POST /pipeline-promotions

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "pipeline": {
      "description": "pipeline involved in the promotion",
      "properties": {
        "id": {
          "description": "unique identifier of pipeline",
          "example": "01234567-89ab-cdef-0123-456789abcdef",
          "format": "uuid",
          "readOnly": true,
          "type": [
            "string"
          ]
        }
      },
      "required": [
        "id"
      ],
      "type": [
        "object"
      ]
    },
    "source": {
      "description": "the app being promoted from",
      "properties": {
        "app": {
          "description": "the app which was promoted from",
          "properties": {
            "id": {
              "description": "unique identifier of app",
              "example": "01234567-89ab-cdef-0123-456789abcdef",
              "format": "uuid",
              "readOnly": true,
              "type": [
                "string"
              ]
            }
          },
          "strictProperties": true,
          "type": [
            "object"
          ]
        }
      }
    },
    "targets": {
      "additionalItems": true,
      "items": {
        "properties": {
          "app": {
            "description": "the app is being promoted to",
            "properties": {
              "id": {
                "description": "unique identifier of app",
                "example": "01234567-89ab-cdef-0123-456789abcdef",
                "format": "uuid",
                "readOnly": true,
                "type": [
                  "string"
                ]
              }
            },
            "strictProperties": true,
            "type": [
              "object"
            ]
          }
        }
      }
    }
  },
  "required": [
    "pipeline",
    "source",
    "targets"
  ],
  "type": [
    "object"
  ]
}
get(pipeline-promotion_identity)

Calls GET /pipeline-promotions/#{pipeline-promotion_identity}