diff --git a/README.md b/README.md index ea7dd75f..d272f38f 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ Pre-rendered HTML documentation is also included in docs/index.html. HTML can be re-generated from the spec, using: ``` -redoc-cli build docs/spec/audnexus.yaml -o docs/index.html +pnpm run build-docs ``` ## 🚀 Deployment diff --git a/docs/index.html b/docs/index.html index 784b6e9e..d0ec2fcd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -12,2168 +12,363 @@ margin: 0; } - -

Audnexus (1.4.0)

Download OpenAPI specification:Download

License: GPL v3

Aggegate audiobook data

-

Authors

Author functions

-

Find authors by name

Returns a list of authors, based on search query provided

-
query Parameters
name
required
string

Name to search with

-
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

-

Responses

Response samples

Content type
[
  • {
    }
]

Find author by ID

Returns a single author

-
path Parameters
ASIN
required
string

ID of author to return

-
query Parameters
update
string
Enum: "0" "1"

Have server check for updated data upstream

-
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

-

Responses

Response samples

Content type
{
  • "asin": "B00G0WYW92",
  • "description": "ANDY WEIR built a two-decade career as a software engineer until the success of his first published novel, The Martian, allowed him to live out his dream of writing full-time. He is a lifelong space nerd and a devoted hobbyist of such subjects as relativistic physics, orbital mechanics, and the history of manned spaceflight. He also mixes a mean cocktail. He lives in California.",
  • "genres": [
    ],
  • "name": "Andy Weir",
  • "region": "us",
  • "similar": [
    ]
}

Deletes a author

Deletes a single author

-
path Parameters
ASIN
required
string

Author id to delete

-
query Parameters
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

-

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Books

Book functions

-

Find book by ID

Returns a single book

-
path Parameters
ASIN
required
string

ID of book to return

-
query Parameters
seedAuthors
number
Enum: 0 1

Whether to seed authors of book

-
update
number
Enum: 0 1

Have server check for updated data upstream

-
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

-

Responses

Response samples

Content type
{
  • "asin": "B08G9PRS1K",
  • "authors": [
    ],
  • "description": "Ryland Grace is the sole survivor on a desperate, last-chance mission - and if he fails, humanity and the Earth itself will perish. Except that right now, he doesn't know that. He can't even remember his own name, let alone the nature of his assignment or how to complete it....",
  • "formatType": "unabridged",
  • "genres": [
    ],
  • "language": "english",
  • "narrators": [
    ],
  • "publisherName": "Audible Studios",
  • "rating": "4.9",
  • "region": "us",
  • "releaseDate": "2021-05-04T00:00:00.000Z",
  • "runtimeLengthMin": 970,
  • "summary": "<p><b>Winner of the 2022 Audie Awards Audiobook of the Year.</b></p> <p><b>Number-One Audible and</b><b><i> New York Times</i></b><b> Audio Best Seller</b></p> <p><b>A lone astronaut must save the earth from disaster in this incredible new science-based thriller from the number-one </b><b><i>New York Times</i></b><b> best-selling author of </b><b><i>The Martian</i></b><b>.</b></p> <p>Ryland Grace is the sole survivor on a desperate, last-chance mission - and if he fails, humanity and the Earth itself will perish.</p> <p>Except that right now, he doesn't know that. He can't even remember his own name, let alone the nature of his assignment or how to complete it.</p> <p>All he knows is that he's been asleep for a very, very long time. And he's just been awakened to find himself millions of miles from home, with nothing but two corpses for company.</p> <p>His crewmates dead, his memories fuzzily returning, he realizes that an impossible task now confronts him. Alone on this tiny ship that's been cobbled together by every government and space agency on the planet and hurled into the depths of space, it's up to him to conquer an extinction-level threat to our species.</p> <p>And thanks to an unexpected ally, he just might have a chance.</p> <p>Part scientific mystery, part dazzling interstellar journey, <i>Project Hail Mary</i> is a tale of discovery, speculation, and survival to rival <i>The Martian</i> - while taking us to places it never dreamed of going.</p> <p>PLEASE NOTE: To accommodate this audio edition, some changes to the original text have been made with the approval of author Andy Weir.</p>",
  • "title": "Project Hail Mary"
}

Deletes a book

Deletes a single book

-
path Parameters
ASIN
required
string

Book id to delete

-
query Parameters
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

-

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Chapters

Chapter functions

-

Find chapters by ASIN

Returns a single book's chapters

-
path Parameters
ASIN
required
string

ID of book to return

-
query Parameters
update
number
Enum: 0 1

Have server check for updated data upstream

-
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

-

Responses

Response samples

Content type
{
  • "asin": "B08G9PRS1K",
  • "brandIntroDurationMs": 2043,
  • "brandOutroDurationMs": 5061,
  • "chapters": [
    ],
  • "isAccurate": true,
  • "region": "us",
  • "runtimeLengthMs": 58252995,
  • "runtimeLengthSec": 58253
}

Delete chapters by ASIN

Deletes a single book's chapters

-
path Parameters
ASIN
required
string

Audible.com ID

-
query Parameters
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

-

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Search

Search functions

-

Find authors by name

Returns a list of authors, based on search query provided

-
query Parameters
name
required
string

Name to search with

-
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

-

Responses

Response samples

Content type
[
  • {
    }
]
- + " fill="currentColor">

Audnexus (1.7.0)

Download OpenAPI specification:Download

License: GPL v3

Aggegate audiobook data

+

Authors

Author functions

+

Find authors by name

Returns a list of authors, based on search query provided

+
query Parameters
name
required
string

Name to search with

+
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

+

Responses

Response samples

Content type
[
  • {
    }
]

Find author by ID

Returns a single author

+
path Parameters
ASIN
required
string

ID of author to return

+
query Parameters
update
string
Enum: "0" "1"

Have server check for updated data upstream

+
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

+

Responses

Response samples

Content type
{
  • "asin": "B00G0WYW92",
  • "description": "ANDY WEIR built a two-decade career as a software engineer until the success of his first published novel, The Martian, allowed him to live out his dream of writing full-time. He is a lifelong space nerd and a devoted hobbyist of such subjects as relativistic physics, orbital mechanics, and the history of manned spaceflight. He also mixes a mean cocktail. He lives in California.",
  • "genres": [
    ],
  • "name": "Andy Weir",
  • "region": "us",
  • "similar": [
    ]
}

Deletes a author

Deletes a single author

+
path Parameters
ASIN
required
string

Author id to delete

+
query Parameters
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

+

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Books

Book functions

+

Find book by ID

Returns a single book

+
path Parameters
ASIN
required
string

ID of book to return

+
query Parameters
seedAuthors
number
Enum: 0 1

Whether to seed authors of book

+
update
number
Enum: 0 1

Have server check for updated data upstream

+
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

+

Responses

Response samples

Content type
{
  • "asin": "B08G9PRS1K",
  • "authors": [
    ],
  • "copyright": 2021,
  • "description": "Ryland Grace is the sole survivor on a desperate, last-chance mission - and if he fails, humanity and the Earth itself will perish. Except that right now, he doesn't know that. He can't even remember his own name, let alone the nature of his assignment or how to complete it....",
  • "formatType": "unabridged",
  • "genres": [
    ],
  • "isAdult": false,
  • "isbn": "9781603935470",
  • "language": "english",
  • "narrators": [
    ],
  • "publisherName": "Audible Studios",
  • "rating": "4.9",
  • "region": "us",
  • "releaseDate": "2021-05-04T00:00:00.000Z",
  • "runtimeLengthMin": 970,
  • "summary": "<p><b><i>Winner of the 2022 Audie Awards' Audiobook of the Year</i></b></p> <p><b><i>Number-One Audible and </i></b><b>New York Times</b><b><i> Audio Best Seller</i></b></p> <p><b><i>More than one million audiobooks sold</i></b></p> <p><b>A lone astronaut must save the earth from disaster in this incredible new science-based thriller from the number-one </b><b><i>New York Times</i></b><b> best-selling author of </b><b><i>The Martian</i></b><b>.</b></p> <p>Ryland Grace is the sole survivor on a desperate, last-chance mission - and if he fails, humanity and the Earth itself will perish.</p> <p>Except that right now, he doesn't know that. He can't even remember his own name, let alone the nature of his assignment or how to complete it.</p> <p>All he knows is that he's been asleep for a very, very long time. And he's just been awakened to find himself millions of miles from home, with nothing but two corpses for company.</p> <p>His crewmates dead, his memories fuzzily returning, he realizes that an impossible task now confronts him. Alone on this tiny ship that's been cobbled together by every government and space agency on the planet and hurled into the depths of space, it's up to him to conquer an extinction-level threat to our species.</p> <p>And thanks to an unexpected ally, he just might have a chance.</p> <p>Part scientific mystery, part dazzling interstellar journey, <i>Project Hail Mary</i> is a tale of discovery, speculation, and survival to rival <i>The Martian</i> - while taking us to places it never dreamed of going.</p> <p>PLEASE NOTE: To accommodate this audio edition, some changes to the original text have been made with the approval of author Andy Weir.</p>",
  • "title": "Project Hail Mary"
}

Deletes a book

Deletes a single book

+
path Parameters
ASIN
required
string

Book id to delete

+
query Parameters
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

+

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Chapters

Chapter functions

+

Find chapters by ASIN

Returns a single book's chapters

+
path Parameters
ASIN
required
string

ID of book to return

+
query Parameters
update
number
Enum: 0 1

Have server check for updated data upstream

+
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

+

Responses

Response samples

Content type
{
  • "asin": "B08G9PRS1K",
  • "brandIntroDurationMs": 2043,
  • "brandOutroDurationMs": 5061,
  • "chapters": [
    ],
  • "isAccurate": true,
  • "region": "us",
  • "runtimeLengthMs": 58252995,
  • "runtimeLengthSec": 58253
}

Delete chapters by ASIN

Deletes a single book's chapters

+
path Parameters
ASIN
required
string

Audible.com ID

+
query Parameters
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

+

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Search

Search functions

+

Find authors by name

Returns a list of authors, based on search query provided

+
query Parameters
name
required
string

Name to search with

+
region
string
Default: "us"
Enum: "au" "ca" "de" "es" "fr" "in" "it" "jp" "us" "uk"

Region code

+

Responses

Response samples

Content type
[
  • {
    }
]
+ - \ No newline at end of file +