From f435f7fbf8f337fa88f0aabf95375d42271db850 Mon Sep 17 00:00:00 2001 From: brittonhayes Date: Tue, 25 Jul 2023 22:35:29 -0700 Subject: [PATCH] docs: update generated api documentation --- Taskfile.yml | 2 +- web/index.html | 100 +++++++++++++++++++++++++++++++------------------ 2 files changed, 64 insertions(+), 38 deletions(-) diff --git a/Taskfile.yml b/Taskfile.yml index 3a1ffde..aa10459 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -20,7 +20,7 @@ tasks: docs: desc: "Generate documentation" cmds: - - redocly build-docs api/openapi.yaml -o web/index.html + - npx @redocly/cli build-docs api/openapi.yaml -o web/index.html lint: desc: "Run linter" diff --git a/web/index.html b/web/index.html index d98da5b..d64ff60 100644 --- a/web/index.html +++ b/web/index.html @@ -329,7 +329,7 @@ -
API docs by Redocly
API docs by Redocly

Warhammer Age of Sigmar API (1.0.0)

Download OpenAPI specification:Download

This is an API specification for a Unofficial Warhammer Age of Sigmar API

-

Get API documentation

Get API documentation

+ " fill="currentColor">

Warhammer Age of Sigmar API (1.0.0)

Download OpenAPI specification:Download

API specification for a Unofficial Warhammer Age of Sigmar API

+

Get health status

Get health status

+

Responses

Response samples

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

Get all allegiances

Get all allegiances

+
query Parameters
name
string

name of allegiance to filter by

+
grand_alliance
string

id of grand alliance to filter by

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get allegiance by id

Get allegiance by id

+
path Parameters
id
required
string

id of allegiance to return

+

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "grand_alliance": "string",
  • "mortal_realm": "string"
}

Get all armies

Get all armies

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get army by id

Get army by id

+
path Parameters
id
required
string

id of army to return

+

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "units": [
    ]
}

Get all cities

Get all cities

+
query Parameters
name
string

name of city to filter by

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get city by id

Get city by id

+
path Parameters
id
required
string

id of city to return

+

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string"
}

Get API documentation

Get API documentation

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get grand alliance by id

Get grand alliance by id

+
https://aos-api.com/grand-alliances

Response samples

Content type
application/json
[
  • {
    }
]

Get grand alliance by id

Get grand alliance by id

path Parameters
id
required
string

id of grand alliance to return

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string"
}

Get all grand strategies

Get all grand strategies

+
https://aos-api.com/grand-alliances/{id}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string"
}

Get all grand strategies

Get all grand strategies

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get grand strategy by id

Get grand strategy by id

+
https://aos-api.com/grand-strategies

Response samples

Content type
application/json
[
  • {
    }
]

Get grand strategy by id

Get grand strategy by id

path Parameters
id
required
string

id of grand strategy to return

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string"
}

Get all allegiances

Get all allegiances

-
query Parameters
name
string

name of allegiance to filter by

-
grand_alliance
string

id of grand alliance to filter by

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get allegiance by id

Get allegiance by id

-
path Parameters
id
required
string

id of allegiance to return

-

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "grand_alliance": "string",
  • "mortal_realm": "string"
}

Get all cities

Get all cities

-
query Parameters
name
string

name of city to filter by

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all units

Get all units

+
https://aos-api.com/grand-strategies/{id}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string"
}

Get all units

Get all units

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get unit by id

Get unit by id

+
https://aos-api.com/units

Response samples

Content type
application/json
[
  • {
    }
]

Get unit by id

Get unit by id

path Parameters
id
required
string

id of unit to return

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "grand_alliance": "string",
  • "size": {
    },
  • "move": {
    },
  • "description": "string",
  • "save": 0,
  • "bravery": 0,
  • "models": 0,
  • "points": 0,
  • "wounds": 0,
  • "abilities": [
    ],
  • "keywords": [
    ],
  • "command_abilities": [
    ],
  • "magic": [
    ],
  • "damage_table": [
    ],
  • "weapons": [
    ]
}

Get all armies

Get all armies

-

Responses

https://aos-api.com/units/{id}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "grand_alliance": "string",
  • "size": {
    },
  • "move": {
    },
  • "description": "string",
  • "save": 0,
  • "bravery": 0,
  • "models": 0,
  • "points": 0,
  • "wounds": 0,
  • "abilities": [
    ],
  • "keywords": [
    ],
  • "command_abilities": [
    ],
  • "magic": [
    ],
  • "damage_table": [
    ],
  • "weapons": [
    ]
}

Get all warscrolls

Get all warscrolls

+
query Parameters
name
string

name of warscroll to filter by

+
points
integer

points of warscroll to filter by

+
battlefield_role
string

battlefield_role of warscroll to filter by

+
size
string

size of warscroll to filter by

+
notes
string

notes of warscroll to filter by

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get army by id

Get army by id

-
path Parameters
id
required
string

id of army to return

+

Response samples

Content type
application/json
[
  • {
    }
]

Get warscroll by id

Get warscroll by id

+
path Parameters
id
required
string

id of warscroll to return

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "units": [
    ]
}
+

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "allegiance_id": "string",
  • "allegiance": {
    },
  • "grand_alliance_id": "string",
  • "grand_alliance": {
    },
  • "size": 0,
  • "points": 0,
  • "battlefield_role": "string",
  • "notes": "string"
}