A realm's problems

GET

/api/v1/realms/{name}/problems

const url = 'http://localhost:11044/api/v1/realms/example/problems';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/realms/example/problems \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

The problems the realm listing counts in problems for this realm: each with its source, what went wrong, a suggested fix when there is one, its severity, and where in the realm it is when known. 404 when no installed realm has that name.

Authorizations

apiKeyAuth
basicAuth

Parameters

Path Parameters

name

required

string

Realm name

Responses

200

The realm’s problems; empty when it has none

*/*

Array<object>

One problem found with a realm, with its cause, a suggested fix, and where it is when known.

object

column

1-based column in the file, when known

integer format: int32

file

The file, relative to the realm root, when known

string

line

1-based line in the file, when known

integer format: int32

message

required

What went wrong

string

path

The YAML path inside the file, when known

string

severity

required

NOTE is worth a look and leaves the realm active; WARNING degrades a feature; ERROR breaks one

string

Allowed values: NOTE WARNING ERROR

source

required

Where the problem was found, such as realms/<name> or realms/<name>/producers/x.yml

string

suggestion

How to fix it, when there is a suggestion

string

404

No installed realm has that name. Raised as a status, so it answers the not-found page

text/html