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

public agent endpoints

Browse Source
This commit is contained in:
Felix Baumkötter 2023-07-11 23:44:03 +00:00
parent 3c1c694047
commit 6379a3c27f
2 changed files with 119 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
models/Agent.json
View File

@ -5,7 +5,7 @@
"accountId": {
"type": "string",
"minLength": 1,
"description": "Account ID that is tied to this agent."
"description": "Account ID that is tied to this agent. Only included on your own agent."
},
"symbol": {
"type": "string",
@ -26,10 +26,13 @@
"type": "string",
"minLength": 1,
"description": "The faction the agent started with."
},
"shipCount": {
"type": "integer",
"description": "How many ships are owned by the agent."
}
},
"required": [
"accountId",
"symbol",
"headquarters",
"credits",

114
reference/SpaceTraders.json
View File

@ -858,6 +858,120 @@
}
]
},
"/agents": {
"get": {
"description": "Fetch agents details.",
"operationId": "get-agents",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"items": {
"$ref": "../models/Agent.json"
},
"type": "array"
},
"meta": {
"$ref": "../models/Meta.json"
}
},
"required": [
"data",
"meta"
],
"type": "object"
}
}
},
"description": "Successfully fetched agents details."
}
},
"summary": "List Agents",
"tags": [
"Agents"
],
"parameters": [
{
"schema": {
"type": "integer",
"minimum": 1,
"default": 1
},
"in": "query",
"name": "page",
"description": "What entry offset to request"
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"default": 10
},
"in": "query",
"name": "limit",
"description": "How many entries to return per page"
}
],
"security": [
{},
{
"AgentToken": []
}
]
}
},
"/agents/{agentSymbol}": {
"get": {
"description": "Fetch agent details.",
"operationId": "get-agent",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "../models/Agent.json"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": "Successfully fetched agent details."
}
},
"summary": "Get Agent",
"tags": [
"Agents"
],
"parameters": [
{
"description": "The agent symbol",
"in": "path",
"name": "agentSymbol",
"required": true,
"schema": {
"default": "FEBA66",
"type": "string"
}
}
],
"security": [
{},
{
"AgentToken": []
}
]
}
},
"/my/agent": {
"get": {
"description": "Fetch your agent's details.",