Skip to content
Yagra

The section catalog that drives the builder. Static, so it answers fully in skeleton mode.

GET
/api/v1/reports/sections
curl --request GET \
  --url https://example.com/api/v1/reports/sections \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Every section kind this build can render

Media typeapplication/json
Array<object>

A report-section type the user can add to a report.

object
blurb
required
string
group
required
string
kind
required
string
settings
required
Array<object>

A configurable setting on a section (rendered generically by the builder).

object
default
required
key
required
string
kind
required

number | select.

string
label
required
string
options
Array<object>

One selectable choice for a select setting.

object
label
required
string
value
required
string
title
required
string
Examplegenerated
[
  {
    "blurb": "example",
    "group": "example",
    "kind": "example",
    "settings": [
      {
        "default": "example",
        "key": "example",
        "kind": "example",
        "label": "example",
        "options": [
          {
            "label": "example",
            "value": "example"
          }
        ]
      }
    ],
    "title": "example"
  }
]

401

Section titled “401”

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403”

Role lacks View

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}