IncidentIo.CatalogTypesV3 (IncidentIo v0.3.1)

View Source

Manage catalog types.

Catalog types represent categories of things in your organisation (e.g. services, teams, customers). Each type has a schema defining the attributes its entries can hold. This module covers the v3 Catalog API.

Summary

Functions

create(client \\ %Client{}, body)

Create a catalog type.

destroy(client \\ %Client{}, id)

Archives a catalog type and associated entries.

list(client \\ %Client{})

List entries for a catalog type.

show(client \\ %Client{}, id)

Show a single catalog type.

update(client \\ %Client{}, id, body)

Updates an existing catalog type.

Functions

create(client \\ %Client{}, body)

@spec create(IncidentIo.Client.t(), request_body()) :: IncidentIo.response()

Create a catalog type.

Catalog type body example:

%{
    annotations: %{
      "incident.io/catalog-importer/id": "id-of-config"
    },
    color: "yellow",
    description: "Represents Kubernetes clusters that we run inside of GKE.",
    icon: "bolt",
    name: "Kubernetes Cluster",
    ranked: true,
    source_repo_url: "https://github.com/my-company/incident-io-catalog",
    type_name: "Custom[\"BackstageGroup\"]"
}

Example

IncidentIo.CatalogTypesV3.create(client, body)

More information at: https://api-docs.incident.io/tag/Catalog-V3#operation/Catalog%20V3_CreateType

destroy(client \\ %Client{}, id)

@spec destroy(IncidentIo.Client.t(), binary()) :: IncidentIo.response()

Archives a catalog type and associated entries.

Example

IncidentIo.CatalogTypesV3.destroy(client, "some-catalog-type-id")

More information at: https://api-docs.incident.io/tag/Catalog-V3#operation/Catalog%20V3_DestroyType

list(client \\ %Client{})

@spec list(IncidentIo.Client.t()) :: IncidentIo.response()

List entries for a catalog type.

Example

IncidentIo.CatalogTypesV3.list(client)

More information at: https://api-docs.incident.io/tag/Catalog-V3#operation/Catalog%20V3_ListTypes

show(client \\ %Client{}, id)

@spec show(IncidentIo.Client.t(), binary()) :: IncidentIo.response()

Show a single catalog type.

Example

IncidentIo.CatalogTypesV3.show(client, "some-catalog-type-id")

More information at: https://api-docs.incident.io/tag/Catalog-V3#operation/Catalog%20V3_ShowType

update(client \\ %Client{}, id, body)

@spec update(IncidentIo.Client.t(), binary(), request_body()) :: IncidentIo.response()

Updates an existing catalog type.

Catalog type body example:

%{
    annotations: %{
      "incident.io/catalog-importer/id": "id-of-config"
    },
    color: "yellow",
    description: "Represents Kubernetes clusters that we run inside of GKE.",
    icon: "bolt",
    name: "Kubernetes Cluster",
    ranked: true,
    source_repo_url: "https://github.com/my-company/incident-io-catalog"
}

Example

IncidentIo.CatalogTypesV3.update(client, "some-catalog-type-id", body)

More information at: https://api-docs.incident.io/tag/Catalog-V3#operation/Catalog%20V3_UpdateType