ex_heroku_client v0.4.0 Heroku.Space

Summary

Functions

Calls POST /spaces

Calls DELETE /spaces/#{space_identity}

Calls GET /spaces/#{space_identity}

Calls GET /spaces

Calls PATCH /spaces/#{space_identity}

Functions

create(params)

Calls POST /spaces

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "name": {
      "description": "unique name of space",
      "example": "nasa",
      "pattern": "^[a-z0-9](?:[a-z0-9]|-(?!-))+[a-z0-9]$",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "region": {
      "anyOf": [
        {
          "description": "unique identifier of region",
          "example": "01234567-89ab-cdef-0123-456789abcdef",
          "format": "uuid",
          "readOnly": true,
          "type": [
            "string"
          ]
        },
        {
          "description": "unique name of region",
          "example": "us",
          "readOnly": true,
          "type": [
            "string"
          ]
        }
      ]
    },
    "shield": {
      "description": "true if this space has shield enabled",
      "example": true,
      "readOnly": true,
      "type": [
        "boolean"
      ]
    },
    "team": {
      "description": "unique name of team",
      "example": "example",
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "name",
    "team"
  ],
  "type": [
    "object"
  ]
}
destroy(space_identity)

Calls DELETE /spaces/#{space_identity}

get(space_identity)

Calls GET /spaces/#{space_identity}

index()

Calls GET /spaces

update(space_identity, params \\ %{})

Calls PATCH /spaces/#{space_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "name": {
      "description": "unique name of space",
      "example": "nasa",
      "pattern": "^[a-z0-9](?:[a-z0-9]|-(?!-))+[a-z0-9]$",
      "readOnly": false,
      "type": [
        "string"
      ]
    }
  },
  "type": [
    "object"
  ]
}