Resources Enums Models Unions Clients
Generator[elm] failed with HTTP 404: Unsupported response code[404]. Expected: 200, 409

common 0.0.1

History | Watch

Common models and resources used by all services.

  • Contact: N/A
  • License: MIT

Resources

health_check

Operations

Method and Path Description
GET /_internal_/healthcheck

Get the current health of the service.
GET /_internal_/probe/ready

Endpoint for readiness probe.
GET /_internal_/probe/live

Endpoint for liveliness probe.

service_info

Operations

Method and Path Description
GET /_internal_/service

Get information about the deployed service.

Headers

No headers

Imports

No imports

Enums

error_source_type

Type of an error source.

Name Value Description
pointer pointer

Indicating a JSON pointer to the value that has caused the error.
parameter parameter

Indicating an URI query parameter causing the error.
header header

Indicating a request header causing the error.

health_status

The status of a service.

Name Value Description
running running

The service is running and healthy.
starting starting

The service is not yet running.
unhealthy unhealthy

The service has encountered errors and is not running property.

sort_direction

The direction in which to sort by a property.

Name Value Description
asc asc

Sort ascending.
desc desc

Sort descending.

Interfaces

No interfaces

Models

audit

Example Json: Minimal | Full

Interfaces: None

Basic audit information for a resource.

Field Type Required? Default Description
created_at date-time-iso8601 Yes -

created_by uuid Yes -

updated_at date-time-iso8601 Yes -

updated_by uuid Yes -

error_links

Example Json: Minimal | Full

Interfaces: None

Links to further information about the occurred error.

Field Type Required? Default Description
about link No -

A link that leads to further details about this particular occurrence of the problem.
type link No -

A link that identifies the type of the error that this particular error is an instance of.

error_source

Example Json: Minimal | Full

Interfaces: None

Reference to the primary source of an error.

Field Type Required? Default Description
type error_source_type Yes -

source string Yes -

The source of the problem in the form specified by type.

generic_error

Example Json: Minimal | Full

Interfaces: None

An error returned on failed API requests.

Field Type Required? Default Description
links error_links No -

code string Yes -

An app specific error code.
title string Yes -

A short human readable summary of the problem.
detail string Yes -

A human readable explanation of the problem.
source error_source No -

meta object No -

Non-standard meta-information about the error.

health_check

Example Json: Minimal | Full

Interfaces: None

Indicating the health of a service.

Field Type Required? Default Description
status health_status Yes -

message string No -

An optional message giving more detailed information about the current health.

link_object

Example Json: Minimal | Full

Interfaces: None

Represents a link with some meta information.

Field Type Required? Default Description
href string Yes -

An URI-reference pointing to the links target.
title string No -

A human-readable label for the link.
type string No -

Optional media type of the link's target.

page_response

Example Json: Minimal | Full

Interfaces: None

Paging information returned from a paged request.

Field Type Required? Default Description
offset integer Yes -

limit integer Yes -

sort [sort] Yes -

total_results long Yes -

Total number of results that can potentially be returned.
total_pages long Yes -

Total number of pages that can potentially be returned.

paging_form

Example Json: Minimal | Full

Interfaces: None

Form containing paging information.

Field Type Required? Default Description
offset integer Yes 0

Offset of the current page. The pages are 0-indexed, meaning the first page starts at 0.
limit integer Yes 25

The number of results to be returned by the api.
sort [sort] No -

Defines multiple properties for the results to be sorted by. The order of the definition defines the priority. If omitted, the service will use an implementation dependent default sort.

service_info

Example Json: Minimal | Full

Interfaces: None

Information about a deployed service.

Field Type Required? Default Description
name string Yes -

version string Yes -

uri string Yes -

URI under which this service is deployed.
title string No -

A human-readable title of the service.
description string No -

A human-readable description of the service.

sort

Example Json: Minimal | Full

Interfaces: None

Single property to sort by.

Field Type Required? Default Description
property string Yes -

The property by which the results should be sorted.
direction sort_direction Yes -

The direction in which the results should be sorted.

Unions

link

Interfaces: None

  • Type discriminator: N/A

Represents a link to a resource.

Type Discriminator Value Example Json Description
string string Minimal | Full

An URI-reference pointing to the links target.
link_object link_object Minimal | Full

Annotations

No annotations