List a recipe's translations

GET

/api/v1/recipes/{id}/translations

const url = 'http://127.0.0.1:8080/api/v1/recipes/example/translations';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://127.0.0.1:8080/api/v1/recipes/example/translations \
  --header 'Authorization: Bearer <token>'

Renditions are separate recipes, each with its own address. Opening one never redirects to another.

Authorizations

bearerToken
browserSession

Parameters

Path Parameters

required

Library entry identifier

string

Library entry identifier

Responses

200

application/json

object

original

Library entry the renditions declare as their original, when they agree on one

string

renditions

required

Other recipes in this library that are renditions of this one

Array<object> | null

object

required

Library entry identifier

string

language

required

BCP 47 tag of the rendition’s primary language

string

linked

required

One of the two recipes names the other, so the relationship can be removed from either

boolean

relation

required

How the rendition relates to the requested recipe

string

Allowed values: original translation alternate

title

required

string

key

additional properties

any

unresolved

required

This recipe’s own declarations that name no recipe in this library

Array<object> | null

object

language

required

The counterpart’s primary language as a BCP 47 tag

string

>= 2 characters <= 255 characters

recipe_id

The counterpart’s portable recipe document ID, not a library entry ID

string

/^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$/

relation

required

Original: this recipe was translated from the counterpart; translation: the counterpart was translated from this recipe; alternate: the same recipe in another language with no stated direction

string

Allowed values: original translation alternate

title

The counterpart’s title as authored

string

<= 1000 characters

url

Where the counterpart is published

string format: uri

<= 10000 characters

key

additional properties

any

Example

{
  "renditions": [
    {
      "relation": "original"
    }
  ],
  "unresolved": [
    {
      "relation": "original"
    }
  ]
}

401

No valid session or API token (authentication-required), or the credential sent is invalid (invalid-credentials).

application/problem+json

object

code

required

string

detail

required

string

status

required

integer format: int64

title

required

string

type

required

string

key

additional properties

any

Example^generated

{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Not Found

application/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

422

Unprocessable Entity

application/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

500

Internal Server Error

application/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

List a recipe's translations

Authorizations

Parameters

Path Parameters

Responses

200

Example

401

Examplegenerated

404

Example

422

Example

500

Example

Example^generated