Find recipe authors

GET

/api/v1/recipe-authors

const url = 'http://127.0.0.1:8080/api/v1/recipe-authors?q=example&limit=20';
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/recipe-authors?q=example&limit=20' \
  --header 'Authorization: Bearer <token>'

Resolve a complete author name from active recipes in the selected library. Returns only the best available tier: Unicode case-folded NFC and whitespace equality, then Latin accent variants, then one edit or adjacent transposition for 5 to 64 rune names with at least four letters. Punctuation is literal in exact matching. Non-Latin marks are preserved; scripts are not transliterated. Names are ordered by their original Unicode spelling. Exact and accent matches have no candidate cap; typo comparisons evaluate at most 128 indexed candidate names. Choose a returned name before applying the exact author: recipe filter, and ask for a choice when suggestions are ambiguous.

Authorizations

bearerToken
browserSession

Parameters

Query Parameters

required

Complete author name to resolve; only recipe author fields are searched

string

>= 1 characters <= 200 characters

Complete author name to resolve; only recipe author fields are searched

limit

Maximum number of author names to return

integer format: int64

default: 20 >= 1 <= 50

Maximum number of author names to return

Responses

200

application/json

object

candidate_limit_reached

required

Typo candidate retrieval exceeded 128 names; additional suggestions may exist

boolean

has_more

required

Matching names in the selected tier exceed the requested limit

boolean

items

required

Array<object> | null

object

match

required

Best available tier: exact normalized name, Latin accent variant, or one edit or adjacent transposition

string

Allowed values: exact accent fuzzy

name

required

Original author name to quote in an author: qualifier

string

recipe_count

required

Active recipes with this exact credited spelling in the selected library

integer format: int64

>= 1

key

additional properties

any

key

additional properties

any

Example

{
  "items": [
    {
      "match": "exact"
    }
  ]
}

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"
}

403

Forbidden

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"
}

Find recipe authors

Authorizations

Parameters

Query Parameters

Responses

200

Example

401

Examplegenerated

403

Example

422

Example

500

Example

Example^generated