spacetraders/api-docs
1
0
Fork 0
mirror of https://github.com/SpaceTradersAPI/api-docs.git synced 2024-11-15 06:40:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add meta query params to list factions, ships, contracts, systems, waypoints. Fix typo for Galactic faction /register enum.

Browse Source
This commit is contained in:
james.clague@brct.io 2023-01-02 09:41:04 -07:00
parent 27f63adf4a
commit 6dc72cc7e5
1 changed files with 76 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
reference/SpaceTraders.json
View File

@ -72,7 +72,7 @@
"enum": [ "enum": [
"COSMIC", "COSMIC",
"VOID", "VOID",
"GALLACTIC", "GALACTIC",
"QUANTUM", "QUANTUM",
"DOMINION", "DOMINION",
"ASTRO", "ASTRO",
@ -193,15 +193,15 @@
"parameters": [ "parameters": [
{ {
"schema": { "schema": {
"type": "number" "type": "integer"
}, },
"in": "query", "in": "query",
"name": "page", "name": "page",
"description": "What page to request" "description": "What entry offset to request"
}, },
{ {
"schema": { "schema": {
"type": "number" "type": "integer"
}, },
"in": "query", "in": "query",
"name": "limit", "name": "limit",
@ -298,6 +298,24 @@
"summary": "List Waypoints", "summary": "List Waypoints",
"tags": [ "tags": [
"systems" "systems"
],
"parameters": [
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "page",
"description": "What entry offset to request"
},
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "limit",
"description": "How many entries to return per page"
}
] ]
}, },
"parameters": [ "parameters": [
@ -569,6 +587,24 @@
"summary": "List Factions", "summary": "List Factions",
"tags": [ "tags": [
"factions" "factions"
],
"parameters": [
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "page",
"description": "What entry offset to request"
},
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "limit",
"description": "How many entries to return per page"
}
] ]
} }
}, },
@ -689,6 +725,24 @@
"summary": "List Contracts", "summary": "List Contracts",
"tags": [ "tags": [
"contracts" "contracts"
],
"parameters": [
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "page",
"description": "What entry offset to request"
},
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "limit",
"description": "How many entries to return per page"
}
] ]
} }
}, },
@ -978,6 +1032,24 @@
"summary": "List Ships", "summary": "List Ships",
"tags": [ "tags": [
"fleet" "fleet"
],
"parameters": [
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "page",
"description": "What entry offset to request"
},
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "limit",
"description": "How many entries to return per page"
}
] ]
}, },
"post": { "post": {