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

fix: simplify tags

Browse Source
This commit is contained in:
Space Admiral 2022-10-16 17:06:16 -07:00
parent b0cc8e9699
commit 1a04d6299a
1 changed files with 113 additions and 168 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

281
reference/SpaceTraders.json
View File

@ -23,9 +23,7 @@
"/register": { "/register": {
"post": { "post": {
"summary": "Register New Agent", "summary": "Register New Agent",
"tags": [ "tags": [],
"agents"
],
"responses": { "responses": {
"201": { "201": {
"description": "OK", "description": "OK",
@ -136,9 +134,6 @@
"/my/ships": { "/my/ships": {
"get": { "get": {
"summary": "List Ships", "summary": "List Ships",
"tags": [
"ships"
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -354,12 +349,15 @@
{ {
"AgentToken": [] "AgentToken": []
} }
],
"tags": [
"fleet"
] ]
}, },
"post": { "post": {
"summary": "Purchase Ship", "summary": "Purchase Ship",
"tags": [ "tags": [
"shipyards" "fleet"
], ],
"responses": { "responses": {
"200": { "200": {
@ -461,7 +459,7 @@
"get": { "get": {
"summary": "View Ship", "summary": "View Ship",
"tags": [ "tags": [
"ships" "fleet"
], ],
"responses": { "responses": {
"200": { "200": {
@ -573,7 +571,7 @@
} }
], ],
"tags": [ "tags": [
"systems" "fleet"
] ]
}, },
"parameters": [ "parameters": [
@ -588,87 +586,6 @@
} }
] ]
}, },
"/my/contracts/{contractId}/deliver": {
"parameters": [
{
"schema": {
"type": "string"
},
"name": "contractId",
"in": "path",
"required": true,
"description": "The ID of the contract"
}
],
"post": {
"summary": "Deliver on Contract",
"tags": [
"contracts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"description": "",
"type": "object",
"x-examples": {
"example-1": {
"data": {
"tradeSymbol": "IRON_ORE",
"destination": "X1-OE-PM",
"units": 10000,
"fulfilled": -30000
}
}
},
"properties": {
"data": {
"$ref": "../models/ContractDelivery.yaml"
}
},
"required": [
"data"
]
}
}
}
}
},
"operationId": "deliver-contract",
"security": [
{
"AgentToken": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"shipSymbol": {
"type": "string"
},
"tradeSymbol": {
"type": "string"
},
"units": {
"type": "integer"
}
},
"required": [
"contractId",
"tradeSymbol"
]
}
}
}
},
"description": "Deliver cargo on a given contract."
}
},
"/my/ships/{shipSymbol}/jettison": { "/my/ships/{shipSymbol}/jettison": {
"parameters": [ "parameters": [
{ {
@ -683,7 +600,7 @@
"post": { "post": {
"summary": "Jettison Cargo", "summary": "Jettison Cargo",
"tags": [ "tags": [
"ships" "fleet"
], ],
"responses": { "responses": {
"200": { "200": {
@ -867,7 +784,7 @@
} }
], ],
"tags": [ "tags": [
"extract" "fleet"
] ]
}, },
"get": { "get": {
@ -931,7 +848,7 @@
} }
], ],
"tags": [ "tags": [
"extract" "fleet"
] ]
} }
}, },
@ -1126,13 +1043,13 @@
], ],
"description": "If you want to target specific yields for an extraction, you can survey a waypoint, such as an asteroid field, and send the survey in the body of the extract request. Each survey may have multiple deposits, and if a symbol shows up more than once, that indicates a higher chance of extracting that resource.\n\nYour ship will enter a cooldown between consecutive survey requests. Surveys will eventually expire after a period of time. Multiple ships can use the same survey for extraction.", "description": "If you want to target specific yields for an extraction, you can survey a waypoint, such as an asteroid field, and send the survey in the body of the extract request. Each survey may have multiple deposits, and if a symbol shows up more than once, that indicates a higher chance of extracting that resource.\n\nYour ship will enter a cooldown between consecutive survey requests. Surveys will eventually expire after a period of time. Multiple ships can use the same survey for extraction.",
"tags": [ "tags": [
"extract" "fleet"
] ]
}, },
"get": { "get": {
"summary": "Survey Cooldown", "summary": "Survey Cooldown",
"tags": [ "tags": [
"extract" "fleet"
], ],
"responses": { "responses": {
"200": { "200": {
@ -1185,8 +1102,9 @@
], ],
"post": { "post": {
"summary": "Jump Ship", "summary": "Jump Ship",
"description": "Jump your ship from one system to another.",
"tags": [ "tags": [
"navigation" "fleet"
], ],
"responses": { "responses": {
"201": { "201": {
@ -1335,7 +1253,7 @@
} }
], ],
"tags": [ "tags": [
"navigation" "fleet"
] ]
} }
}, },
@ -1353,7 +1271,7 @@
"post": { "post": {
"summary": "Purchase Cargo", "summary": "Purchase Cargo",
"tags": [ "tags": [
"trade" "fleet"
], ],
"responses": { "responses": {
"201": { "201": {
@ -1437,7 +1355,7 @@
"post": { "post": {
"summary": "Sell Cargo", "summary": "Sell Cargo",
"tags": [ "tags": [
"trade" "fleet"
], ],
"responses": { "responses": {
"200": { "200": {
@ -1523,7 +1441,7 @@
"post": { "post": {
"summary": "Refuel Ship", "summary": "Refuel Ship",
"tags": [ "tags": [
"navigation" "fleet"
], ],
"responses": { "responses": {
"200": { "200": {
@ -1599,7 +1517,7 @@
"post": { "post": {
"summary": "Deploy Asset", "summary": "Deploy Asset",
"tags": [ "tags": [
"markets" "fleet"
], ],
"responses": { "responses": {
"204": { "204": {
@ -1646,7 +1564,7 @@
"post": { "post": {
"summary": "Scan", "summary": "Scan",
"tags": [ "tags": [
"ships" "fleet"
], ],
"responses": { "responses": {
"201": { "201": {
@ -1916,7 +1834,7 @@
} }
], ],
"tags": [ "tags": [
"ships" "fleet"
] ]
} }
}, },
@ -1935,7 +1853,7 @@
"post": { "post": {
"summary": "Navigate Ship", "summary": "Navigate Ship",
"tags": [ "tags": [
"navigation" "fleet"
], ],
"responses": { "responses": {
"201": { "201": {
@ -2009,7 +1927,7 @@
"post": { "post": {
"summary": "Dock Ship", "summary": "Dock Ship",
"tags": [ "tags": [
"navigation" "fleet"
], ],
"responses": { "responses": {
"200": { "200": {
@ -2129,7 +2047,7 @@
], ],
"description": "Attempt to move your ship into orbit at it's current location. The request will only succeed if your ship is capable of moving into orbit at the time of the request.\n\nThe endpoint is idempotent - successive calls will succeed even if the ship is already in orbit.", "description": "Attempt to move your ship into orbit at it's current location. The request will only succeed if your ship is capable of moving into orbit at the time of the request.\n\nThe endpoint is idempotent - successive calls will succeed even if the ship is already in orbit.",
"tags": [ "tags": [
"navigation" "fleet"
] ]
} }
}, },
@ -2250,6 +2168,87 @@
"description": "Get the details of a contract by ID." "description": "Get the details of a contract by ID."
} }
}, },
"/my/contracts/{contractId}/deliver": {
"parameters": [
{
"schema": {
"type": "string"
},
"name": "contractId",
"in": "path",
"required": true,
"description": "The ID of the contract"
}
],
"post": {
"summary": "Deliver on Contract",
"tags": [
"contracts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"description": "",
"type": "object",
"x-examples": {
"example-1": {
"data": {
"tradeSymbol": "IRON_ORE",
"destination": "X1-OE-PM",
"units": 10000,
"fulfilled": -30000
}
}
},
"properties": {
"data": {
"$ref": "../models/ContractDelivery.yaml"
}
},
"required": [
"data"
]
}
}
}
}
},
"operationId": "deliver-contract",
"security": [
{
"AgentToken": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"shipSymbol": {
"type": "string"
},
"tradeSymbol": {
"type": "string"
},
"units": {
"type": "integer"
}
},
"required": [
"contractId",
"tradeSymbol"
]
}
}
}
},
"description": "Deliver cargo on a given contract."
}
},
"/my/contracts/{contractId}/accept": { "/my/contracts/{contractId}/accept": {
"parameters": [ "parameters": [
{ {
@ -2724,9 +2723,6 @@
"get": { "get": {
"summary": "Get Shipyard", "summary": "Get Shipyard",
"description": "", "description": "",
"tags": [
"shipyards"
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -2762,6 +2758,9 @@
{ {
"AgentToken": [] "AgentToken": []
} }
],
"tags": [
"systems"
] ]
} }
}, },
@ -2788,9 +2787,6 @@
], ],
"get": { "get": {
"summary": "View Market", "summary": "View Market",
"tags": [
"markets"
],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@ -2818,6 +2814,9 @@
{ {
"AgentToken": [] "AgentToken": []
} }
],
"tags": [
"systems"
] ]
} }
}, },
@ -2869,70 +2868,16 @@
"name": "factions" "name": "factions"
}, },
{ {
"name": "ships" "name": "fleet"
},
{
"name": "markets"
},
{
"name": "trade"
},
{
"name": "sell"
},
{
"name": "purchase"
},
{
"name": "navigation"
},
{
"name": "agents"
},
{
"name": "dock"
},
{
"name": "orbit"
},
{
"name": "jettison"
},
{
"name": "jump"
},
{
"name": "refuel"
},
{
"name": "scan"
}, },
{ {
"name": "contracts" "name": "contracts"
}, },
{
"name": "chart"
},
{
"name": "extract"
},
{
"name": "mining"
},
{
"name": "deliver"
},
{
"name": "survey"
},
{ {
"name": "systems" "name": "systems"
}, },
{ {
"name": "waypoints" "name": "agents"
},
{
"name": "shipyards"
} }
], ],
"components": { "components": {