This README is the one indexed from the repository at its latest ref, not from the tag for this version.

build-client

The Crystal module for the Build.io API V1

Authentication

All endpoints accept an OAuth Bearer token in the Authorization header.

Tokens come in three kinds, distinguished by their resource owner:

• User tokens (default) — full access to the user's apps, teams, pipelines, and namespaces.
• App-scoped tokens (prefix bldp_) — bound to a single app. Can only access endpoints that operate on that one app (e.g. GET /api/v1/apps/:id, builds, dynos, config vars). Endpoints that operate on user-level collections (/api/v1/apps, /api/v1/teams, /api/v1/pipelines, /api/v1/namespaces, /api/v1/addon-attachments, /api/v1/addons) return 403 Forbidden for these tokens.
• Addon partner tokens (addon:config scope) — issued to addon vendors for partner endpoints only.

The /api/v1/me response shape varies by token kind: user tokens return { email }; app-scoped tokens return { app, email } where email belongs to the user that minted the token.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: 1.1.45
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.CrystalClientCodegen

Installation

Install from Git

Add the following to shard.yaml

dependencies:
  build-client:
    github: buildio/sdk-crystal-lang
    version: ~> 1.1.45

Development

Install dependencies

shards

Run the tests:

crystal spec