PathFindr Creator API (0.1.0)

Download OpenAPI specification:Download

API for PathFindr to manage games, cards, and summaries.
Test

Generate a summary of the provided data

This endpoint generates a summary of the provided data and returns it as a paragraph of text in JSON format.

Request Body schema: application/json
required
data
string

The data to be summarized

Responses

Request samples

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

Response samples

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

Store game data

Persists provided JSON data for the game with the specified identifier.

Request Body schema: application/json
required
identifier
string

Unique identifier for the game

data
object

JSON data for the game to be stored

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "data": { }
}

Store game card set data

Persists provided JSON data for the set of cards of the specified game and theme.

Request Body schema: application/json
required
identifier
string

Unique identifier for the game

theme
string

Theme of the cards to be stored (composers, greekheroes, soldiers, plants, politicians, rivers, painters, writers, athletes or women)

data
object

JSON data for the game cards to be stored

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "theme": "string",
  • "data": { }
}

Store game card data

Persists provided JSON data for a cards.

Request Body schema: application/json
required
identifier
string

Unique identifier for the game

data
object

JSON data for the game cards to be stored

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "data": { }
}

Retrieve a list of games

Returns a list of games, including identifiers and names, in JSON format.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve game data

Returns data of the specified game by its identifier.

path Parameters
identifier
required
string

Unique identifier for the game

Responses

Response samples

Content type
application/json
{ }

Retrieve game card

Returns data of the specified game card by its identifier.

path Parameters
identifier
required
string

Unique identifier for the game card

Responses

Response samples

Content type
application/json
{ }

Retrieve game cardset data

Returns data for a cardset of the specified game and theme.

path Parameters
identifier
required
string

Unique identifier for the game

theme
required
string

Theme of the cardset (composers, greekheroes, soldiers, plants, politicians, rivers, painters, writers, athletes or women)

Responses

Response samples

Content type
application/json
[
  • { }
]