ex_heroku_client v0.1.0 Heroku.PipelineCoupling

Summary

Functions

Calls POST /pipeline-couplings

Calls DELETE /pipeline-couplings/#{pipeline-coupling_identity}

Calls GET /pipeline-couplings/#{pipeline-coupling_identity}

Calls GET /apps/#{app_identity}/pipeline-couplings

Calls GET /pipelines/#{pipeline_id}/pipeline-couplings

Calls GET /pipeline-couplings

Calls PATCH /pipeline-couplings/#{pipeline-coupling_identity}

Functions

create(params)

Calls POST /pipeline-couplings

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "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"
          ]
        }
      ]
    },
    "pipeline": {
      "description": "unique identifier of pipeline",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "format": "uuid",
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "stage": {
      "description": "target pipeline stage",
      "enum": [
        "review",
        "development",
        "staging",
        "production"
      ],
      "example": "production",
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "app",
    "pipeline",
    "stage"
  ],
  "type": [
    "object"
  ]
}
delete(pipeline-coupling_identity)

Calls DELETE /pipeline-couplings/#{pipeline-coupling_identity}

get_4(pipeline-coupling_identity)

Calls GET /pipeline-couplings/#{pipeline-coupling_identity}

get_7(app_identity)

Calls GET /apps/#{app_identity}/pipeline-couplings

index_1(pipeline_id)

Calls GET /pipelines/#{pipeline_id}/pipeline-couplings

index_2()

Calls GET /pipeline-couplings

update(pipeline-coupling_identity, params \\ %{})

Calls PATCH /pipeline-couplings/#{pipeline-coupling_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "stage": {
      "description": "target pipeline stage",
      "enum": [
        "review",
        "development",
        "staging",
        "production"
      ],
      "example": "production",
      "type": [
        "string"
      ]
    }
  },
  "type": [
    "object"
  ]
}