Resources Enums Models Unions Clients

state-example 0.0.5-dev

History | Watch

Sample API to play with Apibuilder

Resources

healthcheck

Operations

Method and Path Description
GET /_internal_/healthcheck
POST /_internal_/healthcheck/test_form_params_json
GET /_internal_/healthcheck/:id

Headers

No headers

Imports

No imports

Enums

item_state_failed_cause

Name Value Description
ErrorCause1 ErrorCause1

ErrorCause2 ErrorCause2

ErrorCause3 ErrorCause3

item_state_progress

Name Value Description
Init Init

Pending Pending

Completed Completed

Interfaces

No interfaces

Models

error

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
code integer Yes -

message string Yes -

details string No -

healthcheck

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
status string Yes -

Example: healthy

Unions

item_state

Interfaces: None

  • Type discriminator: type
Type Discriminator Value Example Json Description
item_state_progress item_state_progress Minimal | Full

item_state_failed_cause item_state_failed_cause Minimal | Full

Annotations

No annotations