api-docs/models/Agent.json
Keith Jackson ccbbedd73f
Remove $ref siblings, Agent.shipCount NOT optional, typos (#82)
* Typo and descriptions

* Remove $ref suiblings.

* missed one when refactoring ShipNavRouteWaypointDeprecated to keep deprecated flag.

* Agent.shipCount always seems to be returned. Why would this be optional?
2023-12-16 08:46:48 -08:00

44 lines
1.0 KiB
JSON

{
"description": "Agent details.",
"type": "object",
"properties": {
"accountId": {
"type": "string",
"minLength": 1,
"description": "Account ID that is tied to this agent. Only included on your own agent."
},
"symbol": {
"type": "string",
"minLength": 3,
"maxLength": 14,
"description": "Symbol of the agent."
},
"headquarters": {
"type": "string",
"minLength": 1,
"description": "The headquarters of the agent."
},
"credits": {
"type": "integer",
"format": "int64",
"description": "The number of credits the agent has available. Credits can be negative if funds have been overdrawn."
},
"startingFaction": {
"type": "string",
"minLength": 1,
"description": "The faction the agent started with."
},
"shipCount": {
"type": "integer",
"description": "How many ships are owned by the agent."
}
},
"required": [
"symbol",
"headquarters",
"credits",
"startingFaction",
"shipCount"
]
}