ex_heroku_client v0.3.0 Heroku.Formation

Summary

Functions

Calls PATCH /apps/#{app_identity}/formation

Calls GET /apps/#{app_identity}/formation/#{formation_identity}

Calls GET /apps/#{app_identity}/formation

Calls PATCH /apps/#{app_identity}/formation/#{formation_identity}

Functions

batch_update_process_types(app_identity, params)

Calls PATCH /apps/#{app_identity}/formation

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "updates": {
      "additionalItems": true,
      "description": "Array with formation updates. Each element must have \"type\", the id or name of the process type to be updated, and can optionally update its \"quantity\" or \"size\".",
      "items": {
        "additionalProperties": false,
        "description": "Properties to update a process type",
        "properties": {
          "quantity": {
            "description": "number of processes to maintain",
            "example": 1,
            "readOnly": false,
            "type": [
              "integer"
            ]
          },
          "size": {
            "description": "dyno size (default: \"standard-1X\")",
            "example": "standard-1X",
            "readOnly": false,
            "type": [
              "string"
            ]
          },
          "type": {
            "description": "type of process to maintain",
            "example": "web",
            "pattern": "^[-\\w]{1,128}$",
            "readOnly": true,
            "type": [
              "string"
            ]
          }
        },
        "readOnly": false,
        "required": [
          "type"
        ],
        "type": [
          "object"
        ]
      },
      "type": [
        "array"
      ]
    }
  },
  "required": [
    "updates"
  ],
  "type": [
    "object"
  ]
}
get(app_identity, formation_identity)

Calls GET /apps/#{app_identity}/formation/#{formation_identity}

index(app_identity)

Calls GET /apps/#{app_identity}/formation

update_process_type(app_identity, formation_identity, params \\ %{})

Calls PATCH /apps/#{app_identity}/formation/#{formation_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "quantity": {
      "description": "number of processes to maintain",
      "example": 1,
      "readOnly": false,
      "type": [
        "integer"
      ]
    },
    "size": {
      "description": "dyno size (default: \"standard-1X\")",
      "example": "standard-1X",
      "readOnly": false,
      "type": [
        "string"
      ]
    }
  },
  "type": [
    "object"
  ]
}