ex_heroku_client v0.1.0 Heroku.AddonAttachment

Summary

Functions

Calls POST /addon-attachments

Calls DELETE /addon-attachments/#{addon-attachment_identity}

Calls GET /addon-attachments/#{addon-attachment_identity}

Calls GET /apps/#{app_identity}/addon-attachments/#{addon-attachment_scopedIdentity}

Calls GET /addon-attachments

Calls GET /addons/#{addon_identity}/addon-attachments

Calls GET /apps/#{app_identity}/addon-attachments

Functions

create(params)

Calls POST /addon-attachments

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "addon": {
      "anyOf": [
        {
          "description": "unique identifier of add-on",
          "example": "01234567-89ab-cdef-0123-456789abcdef",
          "format": "uuid",
          "readOnly": true,
          "type": [
            "string"
          ]
        },
        {
          "description": "globally unique name of the add-on",
          "example": "acme-inc-primary-database",
          "pattern": "^[a-zA-Z][A-Za-z0-9_-]+$",
          "readOnly": true,
          "type": [
            "string"
          ]
        }
      ]
    },
    "app": {
      "anyOf": [
        {
          "description": "unique identifier of app",
          "example": "01234567-89ab-cdef-0123-456789abcdef",
          "format": "uuid",
          "readOnly": true,
          "type": [
            "string"
          ]
        },
        {
          "description": "unique name of app",
          "example": "example",
          "pattern": "^[a-z][a-z0-9-]{2,29}$",
          "readOnly": false,
          "type": [
            "string"
          ]
        }
      ]
    },
    "force": {
      "default": false,
      "description": "whether or not to allow existing attachment with same name to be replaced",
      "example": false,
      "readOnly": false,
      "type": [
        "boolean"
      ]
    },
    "name": {
      "description": "unique name for this add-on attachment to this app",
      "example": "DATABASE",
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "addon",
    "app"
  ],
  "type": [
    "object"
  ]
}
destroy(addon-attachment_identity)

Calls DELETE /addon-attachments/#{addon-attachment_identity}

get_3(addon-attachment_identity)

Calls GET /addon-attachments/#{addon-attachment_identity}

get_7(app_identity, addon-attachment_scopedIdentity)

Calls GET /apps/#{app_identity}/addon-attachments/#{addon-attachment_scopedIdentity}

index_4()

Calls GET /addon-attachments

index_5(addon_identity)

Calls GET /addons/#{addon_identity}/addon-attachments

index_6(app_identity)

Calls GET /apps/#{app_identity}/addon-attachments