From 45b1b5198515ce68a4a9a1bb81d0e3ecfeff6f31 Mon Sep 17 00:00:00 2001 From: Joel Brubaker Date: Tue, 13 Sep 2022 20:49:35 -0700 Subject: [PATCH] updates to the chart description --- reference/SpaceTraders.yaml | 427 ++++++++++++++++++------------------ 1 file changed, 217 insertions(+), 210 deletions(-) diff --git a/reference/SpaceTraders.yaml b/reference/SpaceTraders.yaml index 3efb1d6..b6bd22d 100644 --- a/reference/SpaceTraders.yaml +++ b/reference/SpaceTraders.yaml @@ -7,14 +7,14 @@ info: name: Joel Brubaker email: joel@spacetraders.io license: - name: "No" - url: "https://choosealicense.com/no-permission/" + name: 'No' + url: 'https://choosealicense.com/no-permission/' description: |- SpaceTraders is a multiplayer sci-fi strategy game where you acquire and manage a fleet of ships across a growing and dynamic universe. Similar to games such as Eve Online, you work with or against other players to establish trade routes, chart new systems, mine precious ores, patrol for pirates, spy on factions, and discover hidden treasures. - But what makes our game unique? SpaceTraders is entirely accessible through open and well-documented Web API endpoints. In fact, SpaceTraders doesn't have a first-class client to play the game - if you want to take it for a spin, you should try one of our community-created web clients, or use the API documentation to see how you might play a game through an API. + But what makes SpaceTraders unique is that the game is entirely accessible through open and well-documented API endpoints. In fact, SpaceTraders doesn't have a first-class client to play the game - if you want to take it for a spin, you should try one of our community-created web clients, or use the API documentation to see how you might play a game through an API. If this sounds fun and interesting to you, please drop into our Discord and get to know the community. We are actively working on new clients, new ideas and sharing tips for how to play the game. @@ -26,7 +26,7 @@ info: } ``` servers: - - url: "https://v2-0-0.alpha.spacetraders.io" + - url: 'https://v2-0-0.alpha.spacetraders.io' description: v2.0.0-alpha paths: /agents: @@ -35,7 +35,7 @@ paths: tags: - agents responses: - "201": + '201': description: OK content: application/json: @@ -80,7 +80,7 @@ paths: faction: COMMERCE_REPUBLIC type: PROCUREMENT terms: - deadline: "2022-03-11T05:16:59.113Z" + deadline: '2022-03-11T05:16:59.113Z' payment: onAccepted: 20000 onFulfilled: 100000 @@ -91,7 +91,7 @@ paths: fulfilled: 0 accepted: false fulfilled: false - expiresAt: "2022-03-09T05:16:59.112Z" + expiresAt: '2022-03-09T05:16:59.112Z' ship: symbol: string frame: string @@ -149,14 +149,14 @@ paths: type: string default: COMMERCE_REPUBLIC description: The faction you choose determines your headquarters. - description: "" + description: '' /my/agent: get: summary: My Agent Details tags: - agents responses: - "200": + '200': description: OK content: application/json: @@ -177,11 +177,11 @@ paths: security: - AgentToken: [] description: Fetch your agent's details. - "/my/ships/{shipSymbol}/chart": + '/my/ships/{shipSymbol}/chart': post: summary: Chart Waypoint responses: - "200": + '200': description: OK content: application/json: @@ -202,8 +202,15 @@ paths: submitted: - X1-ZZ - X1-ZZ-7-EE - operationId: "post-my-ships-:shipSymbol-chart" - description: "Chart a new system or waypoint. Returns an array of the symbols that have been charted, including the system and the waypoint if both were uncharted, or just the waypoint." + operationId: 'post-my-ships-:shipSymbol-chart' + description: |- + Command a ship to chart the current system and/or waypoint. + + Systems and waypoints in the universe are uncharted by default. These locations will not show up in the API until they have been charted by a ship. + + Charting a location will record your agent as the one who created the chart. + + Returns an array of system / waypoint symbols that have been charted. security: - AgentToken: [] tags: @@ -215,7 +222,7 @@ paths: in: path required: true description: The symbol of the ship - "/my/ships/{shipSymbol}/deliver": + '/my/ships/{shipSymbol}/deliver': parameters: - schema: type: string @@ -228,12 +235,12 @@ paths: tags: - contracts responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -266,7 +273,7 @@ paths: - contractId - tradeSymbol description: Deliver cargo on a given contract. - "/my/ships/{shipSymbol}/dock": + '/my/ships/{shipSymbol}/dock': parameters: - schema: type: string @@ -279,12 +286,12 @@ paths: tags: - navigation responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object properties: data: @@ -309,7 +316,7 @@ paths: security: - AgentToken: [] description: Transition your ship from orbit to docked. Consecutive calls to this endpoint will succeed. - "/my/ships/{shipSymbol}/orbit": + '/my/ships/{shipSymbol}/orbit': parameters: - schema: type: string @@ -320,12 +327,12 @@ paths: post: summary: Orbit Ship responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -350,7 +357,7 @@ paths: description: Transition your ship from docked into orbit. Ships are placed into orbit by default when arriving at a destination. Consecutive calls to this endpoint will continue to return a 200 response status. tags: - navigation - "/my/ships/{shipSymbol}/jettison": + '/my/ships/{shipSymbol}/jettison': parameters: - schema: type: string @@ -362,12 +369,12 @@ paths: tags: - ships responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object properties: data: @@ -409,7 +416,7 @@ paths: units: type: integer minimum: 1 - "/my/ships/{shipSymbol}/extract": + '/my/ships/{shipSymbol}/extract': parameters: - schema: type: string @@ -420,12 +427,12 @@ paths: post: summary: Extract Resources responses: - "201": + '201': description: Created content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -437,7 +444,7 @@ paths: units: 16 cooldown: duration: 119 - expiration: "2022-03-12T00:41:29.371Z" + expiration: '2022-03-12T00:41:29.371Z' properties: data: type: object @@ -462,7 +469,7 @@ paths: units: 16 cooldown: duration: 119 - expiration: "2022-03-12T00:41:29.371Z" + expiration: '2022-03-12T00:41:29.371Z' operationId: post-my-ships-shipSymbol-extract requestBody: content: @@ -470,7 +477,7 @@ paths: schema: type: - object - - "null" + - 'null' properties: survey: $ref: ../models/Survey.yaml @@ -483,8 +490,8 @@ paths: signature: X1-OE-D2DD38 deposits: - COPPER_ORE - expiration: "2022-03-08T05:41:55.514Z" - description: "" + expiration: '2022-03-08T05:41:55.514Z' + description: '' description: Extract resources from the waypoint into your ship. Send a survey as the payload to target specific yields. The entire survey must be sent as it contains a signature that the backend verifies. security: - AgentToken: [] @@ -494,19 +501,19 @@ paths: summary: Extraction Cooldown operationId: get-my-ships-shipSymbol-extract responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: data: cooldown: duration: 119 - expiration: "2022-03-12T00:41:29.285Z" + expiration: '2022-03-12T00:41:29.285Z' properties: data: type: object @@ -523,13 +530,13 @@ paths: data: cooldown: duration: 119 - expiration: "2022-03-12T00:41:29.285Z" + expiration: '2022-03-12T00:41:29.285Z' description: Get the status of your last extraction. security: - AgentToken: [] tags: - extract - "/my/ships/{shipSymbol}/survey": + '/my/ships/{shipSymbol}/survey': parameters: - schema: type: string @@ -539,12 +546,12 @@ paths: post: summary: Survey Waypoint responses: - "201": + '201': description: Created content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -552,47 +559,47 @@ paths: - signature: X1-OE-D2DD38 deposits: - COPPER_ORE - expiration: "2022-03-08T05:41:55.514Z" + expiration: '2022-03-08T05:41:55.514Z' - signature: X1-OE-B58FEB deposits: - ALUMINUM_ORE - ALUMINUM_ORE - ALUMINUM_ORE - expiration: "2022-03-08T05:39:15.519Z" + expiration: '2022-03-08T05:39:15.519Z' - signature: X1-OE-0E326C deposits: - ALUMINUM_ORE - SILICON - expiration: "2022-03-08T05:20:27.521Z" + expiration: '2022-03-08T05:20:27.521Z' - signature: X1-OE-5CDFA4 deposits: - COPPER_ORE - COPPER_ORE - COPPER_ORE - IRON_ORE - expiration: "2022-03-08T05:44:34.522Z" + expiration: '2022-03-08T05:44:34.522Z' - signature: X1-OE-86C3A1 deposits: - COPPER_ORE - COPPER_ORE - IRON_ORE - expiration: "2022-03-08T05:43:45.522Z" + expiration: '2022-03-08T05:43:45.522Z' - signature: X1-OE-C97BEA deposits: - ALUMINUM_ORE - COPPER_ORE - QUARTZ - QUARTZ - expiration: "2022-03-08T05:22:39.523Z" + expiration: '2022-03-08T05:22:39.523Z' - signature: X1-OE-9913BD deposits: - QUARTZ - expiration: "2022-03-08T05:37:45.523Z" + expiration: '2022-03-08T05:37:45.523Z' - signature: X1-OE-8D87D2 deposits: - COPPER_ORE - SILICON - expiration: "2022-03-08T05:32:57.524Z" + expiration: '2022-03-08T05:32:57.524Z' properties: data: type: object @@ -611,40 +618,40 @@ paths: data: cooldown: duration: 899 - expiration: "2022-03-12T02:11:35.618Z" + expiration: '2022-03-12T02:11:35.618Z' surveys: - signature: X1-OE-397C82 deposits: - SILICON - expiration: "2022-03-12T02:00:19.622Z" + expiration: '2022-03-12T02:00:19.622Z' - signature: X1-OE-4413F6 deposits: - ALUMINUM_ORE - ALUMINUM_ORE - COPPER_ORE - IRON_ORE - expiration: "2022-03-12T02:20:08.625Z" + expiration: '2022-03-12T02:20:08.625Z' - signature: X1-OE-E6480F deposits: - ALUMINUM_ORE - IRON_ORE - QUARTZ - SILICON - expiration: "2022-03-12T02:18:00.626Z" + expiration: '2022-03-12T02:18:00.626Z' - signature: X1-OE-660BE9 deposits: - ALUMINUM_ORE - expiration: "2022-03-12T02:20:45.626Z" + expiration: '2022-03-12T02:20:45.626Z' - signature: X1-OE-D64798 deposits: - COPPER_ORE - QUARTZ - SILICON - expiration: "2022-03-12T02:07:33.626Z" + expiration: '2022-03-12T02:07:33.626Z' - signature: X1-OE-F799F3 deposits: - IRON_ORE - expiration: "2022-03-12T02:23:16.627Z" + expiration: '2022-03-12T02:23:16.627Z' operationId: post-my-ships-shipSymbol-survey security: - AgentToken: [] @@ -659,7 +666,7 @@ paths: tags: - extract responses: - "200": + '200': description: OK content: application/json: @@ -677,10 +684,10 @@ paths: data: cooldown: duration: 899 - expiration: "2022-03-12T02:11:35.618Z" + expiration: '2022-03-12T02:11:35.618Z' operationId: get-my-ships-shipSymbol-survey - description: "Executing a survey will initiate a cooldown for a number of seconds before you can call it again. This endpoint returns the details of your cooldown, or a 404 if there is no cooldown for the survey action." - "/my/ships/{shipSymbol}/jump": + description: 'Executing a survey will initiate a cooldown for a number of seconds before you can call it again. This endpoint returns the details of your cooldown, or a 404 if there is no cooldown for the survey action.' + '/my/ships/{shipSymbol}/jump': parameters: - schema: type: string @@ -692,12 +699,12 @@ paths: tags: - navigation responses: - "201": + '201': description: Created content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -707,7 +714,7 @@ paths: destination: 00E0B1 cooldown: duration: 719 - expiration: "2022-03-12T00:52:56.735Z" + expiration: '2022-03-12T00:52:56.735Z' properties: data: type: object @@ -740,7 +747,7 @@ paths: destination: 00E0B1 cooldown: duration: 719 - expiration: "2022-03-12T00:52:56.735Z" + expiration: '2022-03-12T00:52:56.735Z' operationId: post-my-ships-shipSymbol-jump security: - AgentToken: [] @@ -757,19 +764,19 @@ paths: summary: Jump Cooldown operationId: get-my-ships-shipSymbol-jump responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: data: cooldown: duration: 719 - expiration: "2022-03-12T00:52:56.735Z" + expiration: '2022-03-12T00:52:56.735Z' properties: data: type: object @@ -784,7 +791,7 @@ paths: - AgentToken: [] tags: - navigation - "/my/ships/{shipSymbol}/purchase": + '/my/ships/{shipSymbol}/purchase': parameters: - schema: type: string @@ -796,12 +803,12 @@ paths: tags: - trade responses: - "201": + '201': description: Created content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -836,7 +843,7 @@ paths: type: string units: type: integer - "/my/ships/{shipSymbol}/sell": + '/my/ships/{shipSymbol}/sell': parameters: - schema: type: string @@ -848,12 +855,12 @@ paths: tags: - trade responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -889,8 +896,8 @@ paths: type: string units: type: integer - description: "" - "/my/ships/{shipSymbol}/refuel": + description: '' + '/my/ships/{shipSymbol}/refuel': parameters: - schema: type: string @@ -902,12 +909,12 @@ paths: tags: - navigation responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object properties: data: @@ -936,7 +943,7 @@ paths: operationId: post-my-ships-shipSymbol-refuel security: - AgentToken: [] - "/my/ships/{shipSymbol}/deploy": + '/my/ships/{shipSymbol}/deploy': parameters: - schema: type: string @@ -949,7 +956,7 @@ paths: tags: - markets responses: - "204": + '204': description: OK operationId: post-my-ships-shipSymbol-deploy security: @@ -968,7 +975,7 @@ paths: type: string required: - tradeSymbol - "/my/ships/{shipSymbol}/scan": + '/my/ships/{shipSymbol}/scan': parameters: - schema: type: string @@ -980,12 +987,12 @@ paths: tags: - ships responses: - "201": + '201': description: Created content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -998,7 +1005,7 @@ paths: frameSymbol: FRAME_HEAVY_FREIGHTER reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-08T05:20:14.725Z" + expiration: '2022-03-08T05:20:14.725Z' - symbol: ZANZIBAR_TRIKES-DF0AAF registration: factionSymbol: ZANZIBAR_TRIKES @@ -1006,7 +1013,7 @@ paths: frameSymbol: FRAME_SHUTTLE reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_II - expiration: "2022-03-08T05:20:00.725Z" + expiration: '2022-03-08T05:20:00.725Z' - symbol: ZANZIBAR_TRIKES-9B80BE registration: factionSymbol: ZANZIBAR_TRIKES @@ -1014,7 +1021,7 @@ paths: frameSymbol: FRAME_TRANSPORT reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-08T05:20:06.725Z" + expiration: '2022-03-08T05:20:06.725Z' - symbol: COMMERCE_REPUBLIC-117520 registration: factionSymbol: COMMERCE_REPUBLIC @@ -1022,7 +1029,7 @@ paths: frameSymbol: FRAME_SHUTTLE reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_II - expiration: "2022-03-08T05:19:55.725Z" + expiration: '2022-03-08T05:19:55.725Z' - symbol: SPACERS_GUILD-609AA5 registration: factionSymbol: SPACERS_GUILD @@ -1030,7 +1037,7 @@ paths: frameSymbol: FRAME_FRIGATE reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-08T05:19:38.725Z" + expiration: '2022-03-08T05:19:38.725Z' - symbol: MINERS_COLLECTIVE-7AD322 registration: factionSymbol: MINERS_COLLECTIVE @@ -1038,7 +1045,7 @@ paths: frameSymbol: FRAME_SHUTTLE reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-08T05:19:11.725Z" + expiration: '2022-03-08T05:19:11.725Z' - symbol: ZANZIBAR_TRIKES-AE6D78 registration: factionSymbol: ZANZIBAR_TRIKES @@ -1046,7 +1053,7 @@ paths: frameSymbol: FRAME_SHUTTLE reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_II - expiration: "2022-03-08T05:20:44.725Z" + expiration: '2022-03-08T05:20:44.725Z' - symbol: SPACERS_GUILD-92828B registration: factionSymbol: SPACERS_GUILD @@ -1054,7 +1061,7 @@ paths: frameSymbol: FRAME_LIGHT_FREIGHTER reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_II - expiration: "2022-03-08T05:20:49.726Z" + expiration: '2022-03-08T05:20:49.726Z' - symbol: ZANZIBAR_TRIKES-B5EAD1 registration: factionSymbol: ZANZIBAR_TRIKES @@ -1062,7 +1069,7 @@ paths: frameSymbol: FRAME_TRANSPORT reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-08T05:20:25.726Z" + expiration: '2022-03-08T05:20:25.726Z' - symbol: ZANZIBAR_TRIKES-6A4E0D registration: factionSymbol: ZANZIBAR_TRIKES @@ -1070,7 +1077,7 @@ paths: frameSymbol: FRAME_EXPLORER reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_II - expiration: "2022-03-08T05:19:19.726Z" + expiration: '2022-03-08T05:19:19.726Z' cooldown: 60 properties: data: @@ -1106,7 +1113,7 @@ paths: data: cooldown: duration: 59 - expiration: "2022-03-12T00:42:44.220Z" + expiration: '2022-03-12T00:42:44.220Z' ships: - symbol: SPACERS_GUILD-65E1BA registration: @@ -1115,7 +1122,7 @@ paths: frameSymbol: FRAME_LIGHT_FREIGHTER reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-12T00:44:14.222Z" + expiration: '2022-03-12T00:44:14.222Z' - symbol: MINERS_COLLECTIVE-C6ACCA registration: factionSymbol: MINERS_COLLECTIVE @@ -1123,7 +1130,7 @@ paths: frameSymbol: FRAME_INTERCEPTOR reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-12T00:44:38.222Z" + expiration: '2022-03-12T00:44:38.222Z' - symbol: COMMERCE_REPUBLIC-866DC7 registration: factionSymbol: COMMERCE_REPUBLIC @@ -1131,7 +1138,7 @@ paths: frameSymbol: FRAME_LIGHT_FREIGHTER reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-12T00:45:21.222Z" + expiration: '2022-03-12T00:45:21.222Z' - symbol: SPACERS_GUILD-2B1D01 registration: factionSymbol: SPACERS_GUILD @@ -1139,7 +1146,7 @@ paths: frameSymbol: FRAME_HEAVY_FREIGHTER reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-12T00:44:53.222Z" + expiration: '2022-03-12T00:44:53.222Z' - symbol: MINERS_COLLECTIVE-2F238C registration: factionSymbol: MINERS_COLLECTIVE @@ -1147,7 +1154,7 @@ paths: frameSymbol: FRAME_SHUTTLE reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_II - expiration: "2022-03-12T00:44:07.222Z" + expiration: '2022-03-12T00:44:07.222Z' - symbol: ZANZIBAR_TRIKES-ACF237 registration: factionSymbol: ZANZIBAR_TRIKES @@ -1155,7 +1162,7 @@ paths: frameSymbol: FRAME_INTERCEPTOR reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_II - expiration: "2022-03-12T00:44:22.223Z" + expiration: '2022-03-12T00:44:22.223Z' - symbol: SPACERS_GUILD-94A474 registration: factionSymbol: SPACERS_GUILD @@ -1163,7 +1170,7 @@ paths: frameSymbol: FRAME_SHUTTLE reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-12T00:43:51.223Z" + expiration: '2022-03-12T00:43:51.223Z' - symbol: ZANZIBAR_TRIKES-648BA8 registration: factionSymbol: ZANZIBAR_TRIKES @@ -1171,7 +1178,7 @@ paths: frameSymbol: FRAME_SHUTTLE reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-12T00:44:56.223Z" + expiration: '2022-03-12T00:44:56.223Z' - symbol: COMMERCE_REPUBLIC-1EED24 registration: factionSymbol: COMMERCE_REPUBLIC @@ -1179,7 +1186,7 @@ paths: frameSymbol: FRAME_EXPLORER reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_II - expiration: "2022-03-12T00:45:23.223Z" + expiration: '2022-03-12T00:45:23.223Z' - symbol: ZANZIBAR_TRIKES-A5600D registration: factionSymbol: ZANZIBAR_TRIKES @@ -1187,13 +1194,13 @@ paths: frameSymbol: FRAME_FRIGATE reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_II - expiration: "2022-03-12T00:44:00.223Z" + expiration: '2022-03-12T00:44:00.223Z' Departing Ships: value: data: cooldown: duration: 59 - expiration: "2022-03-12T00:42:44.220Z" + expiration: '2022-03-12T00:42:44.220Z' ships: - symbol: SPACERS_GUILD-65E1BA registration: @@ -1202,7 +1209,7 @@ paths: frameSymbol: FRAME_LIGHT_FREIGHTER reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-12T00:44:14.222Z" + expiration: '2022-03-12T00:44:14.222Z' - symbol: MINERS_COLLECTIVE-C6ACCA registration: factionSymbol: MINERS_COLLECTIVE @@ -1210,7 +1217,7 @@ paths: frameSymbol: FRAME_INTERCEPTOR reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-12T00:44:38.222Z" + expiration: '2022-03-12T00:44:38.222Z' - symbol: COMMERCE_REPUBLIC-866DC7 registration: factionSymbol: COMMERCE_REPUBLIC @@ -1218,7 +1225,7 @@ paths: frameSymbol: FRAME_LIGHT_FREIGHTER reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-12T00:45:21.222Z" + expiration: '2022-03-12T00:45:21.222Z' - symbol: SPACERS_GUILD-2B1D01 registration: factionSymbol: SPACERS_GUILD @@ -1226,7 +1233,7 @@ paths: frameSymbol: FRAME_HEAVY_FREIGHTER reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-12T00:44:53.222Z" + expiration: '2022-03-12T00:44:53.222Z' - symbol: MINERS_COLLECTIVE-2F238C registration: factionSymbol: MINERS_COLLECTIVE @@ -1234,7 +1241,7 @@ paths: frameSymbol: FRAME_SHUTTLE reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_II - expiration: "2022-03-12T00:44:07.222Z" + expiration: '2022-03-12T00:44:07.222Z' - symbol: ZANZIBAR_TRIKES-ACF237 registration: factionSymbol: ZANZIBAR_TRIKES @@ -1242,7 +1249,7 @@ paths: frameSymbol: FRAME_INTERCEPTOR reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_II - expiration: "2022-03-12T00:44:22.223Z" + expiration: '2022-03-12T00:44:22.223Z' - symbol: SPACERS_GUILD-94A474 registration: factionSymbol: SPACERS_GUILD @@ -1250,7 +1257,7 @@ paths: frameSymbol: FRAME_SHUTTLE reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-12T00:43:51.223Z" + expiration: '2022-03-12T00:43:51.223Z' - symbol: ZANZIBAR_TRIKES-648BA8 registration: factionSymbol: ZANZIBAR_TRIKES @@ -1258,7 +1265,7 @@ paths: frameSymbol: FRAME_SHUTTLE reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_I - expiration: "2022-03-12T00:44:56.223Z" + expiration: '2022-03-12T00:44:56.223Z' - symbol: COMMERCE_REPUBLIC-1EED24 registration: factionSymbol: COMMERCE_REPUBLIC @@ -1266,7 +1273,7 @@ paths: frameSymbol: FRAME_EXPLORER reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_II - expiration: "2022-03-12T00:45:23.223Z" + expiration: '2022-03-12T00:45:23.223Z' - symbol: ZANZIBAR_TRIKES-A5600D registration: factionSymbol: ZANZIBAR_TRIKES @@ -1274,19 +1281,19 @@ paths: frameSymbol: FRAME_FRIGATE reactorSymbol: REACTOR_FUSION_I engineSymbol: ENGINE_ION_DRIVE_II - expiration: "2022-03-12T00:44:00.223Z" + expiration: '2022-03-12T00:44:00.223Z' System Scan: value: data: cooldown: duration: 0 - expiration: "2022-03-12T00:42:44.220Z" + expiration: '2022-03-12T00:42:44.220Z' system: symbol: X1-OE sector: X1 type: RED_STAR x: 0 - "y": 0 + 'y': 0 waypoints: - X1-OE-PM - X1-OE-PM01 @@ -1303,13 +1310,13 @@ paths: data: cooldown: duration: 0 - expiration: "2022-03-12T00:42:44.220Z" + expiration: '2022-03-12T00:42:44.220Z' waypoint: system: X1-OE symbol: X1-OE-25X type: JUMP_GATE x: -1 - "y": -59 + 'y': -59 orbitals: [] faction: SPACERS_GUILD features: [] @@ -1319,7 +1326,7 @@ paths: operationId: post-my-ships-shipSymbol-scan security: - AgentToken: [] - description: "Execute a ship scan to view approach / departing ships, system information or details about a waypoint. Send a scan mode to select the type of scan performed by your ship." + description: 'Execute a ship scan to view approach / departing ships, system information or details about a waypoint. Send a scan mode to select the type of scan performed by your ship.' requestBody: content: application/json: @@ -1342,12 +1349,12 @@ paths: Departing Ships: value: mode: APPROACHING_SHIPS - description: "" + description: '' get: summary: Scan Cooldown operationId: get-my-ships-shipSymbol-scan responses: - "200": + '200': description: OK content: application/json: @@ -1365,12 +1372,12 @@ paths: data: cooldown: duration: 59 - expiration: "2022-03-12T00:42:44.220Z" + expiration: '2022-03-12T00:42:44.220Z' security: - AgentToken: [] tags: - ships - "/my/ships/{shipSymbol}/navigate": + '/my/ships/{shipSymbol}/navigate': parameters: - schema: type: string @@ -1383,12 +1390,12 @@ paths: tags: - navigation responses: - "201": + '201': description: Created content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -1435,12 +1442,12 @@ paths: summary: Navigation Status operationId: get-my-ships-shipSymbol-navigate responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -1473,7 +1480,7 @@ paths: - AgentToken: [] tags: - navigation - "/my/ships/{shipSymbol}": + '/my/ships/{shipSymbol}': parameters: - schema: type: string @@ -1485,12 +1492,12 @@ paths: tags: - ships responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -1507,7 +1514,7 @@ paths: - MOUNT_MINING_LASER_I registration: factionSymbol: COMMERCE_REPUBLIC - agentSymbol: "653298" + agentSymbol: '653298' fee: 100 role: EXCAVATOR integrity: @@ -1532,12 +1539,12 @@ paths: tags: - ships responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -1554,7 +1561,7 @@ paths: - MOUNT_MINING_LASER_I registration: factionSymbol: COMMERCE_REPUBLIC - agentSymbol: "653298" + agentSymbol: '653298' fee: 100 role: EXCAVATOR integrity: @@ -1576,7 +1583,7 @@ paths: - MOUNT_MINING_LASER_I registration: factionSymbol: COMMERCE_REPUBLIC - agentSymbol: "653298" + agentSymbol: '653298' fee: 100 role: EXCAVATOR integrity: @@ -1598,7 +1605,7 @@ paths: - MOUNT_MINING_LASER_I registration: factionSymbol: COMMERCE_REPUBLIC - agentSymbol: "653298" + agentSymbol: '653298' fee: 100 role: EXCAVATOR integrity: @@ -1620,7 +1627,7 @@ paths: - MOUNT_MINING_LASER_I registration: factionSymbol: COMMERCE_REPUBLIC - agentSymbol: "653298" + agentSymbol: '653298' fee: 100 role: EXCAVATOR integrity: @@ -1642,7 +1649,7 @@ paths: - MOUNT_MINING_LASER_I registration: factionSymbol: COMMERCE_REPUBLIC - agentSymbol: "653298" + agentSymbol: '653298' fee: 100 role: EXCAVATOR integrity: @@ -1664,7 +1671,7 @@ paths: - MOUNT_MINING_LASER_I registration: factionSymbol: COMMERCE_REPUBLIC - agentSymbol: "653298" + agentSymbol: '653298' fee: 100 role: EXCAVATOR integrity: @@ -1845,12 +1852,12 @@ paths: tags: - shipyards responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -1907,12 +1914,12 @@ paths: tags: - contracts responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -1921,7 +1928,7 @@ paths: faction: COMMERCE_REPUBLIC type: PROCUREMENT terms: - deadline: "2022-03-11T05:16:59.113Z" + deadline: '2022-03-11T05:16:59.113Z' payment: onAccepted: 20000 onFulfilled: 100000 @@ -1932,12 +1939,12 @@ paths: fulfilled: 0 accepted: false fulfilled: false - expiresAt: "2022-03-09T05:16:59.112Z" + expiresAt: '2022-03-09T05:16:59.112Z' - id: cl0hok3920023kv0jflbjpltg faction: COMMERCE_REPUBLIC type: PROCUREMENT terms: - deadline: "2022-03-11T05:16:59.123Z" + deadline: '2022-03-11T05:16:59.123Z' payment: onAccepted: 20000 onFulfilled: 100000 @@ -1948,7 +1955,7 @@ paths: fulfilled: 0 accepted: false fulfilled: false - expiresAt: "2022-03-09T05:16:59.122Z" + expiresAt: '2022-03-09T05:16:59.122Z' meta: total: 2 page: 1 @@ -1973,7 +1980,7 @@ paths: faction: COMMERCE_REPUBLIC type: PROCUREMENT terms: - deadline: "2022-03-11T05:16:59.113Z" + deadline: '2022-03-11T05:16:59.113Z' payment: onAccepted: 20000 onFulfilled: 100000 @@ -1984,7 +1991,7 @@ paths: fulfilled: 0 accepted: false fulfilled: false - expiresAt: "2022-03-09T05:16:59.112Z" + expiresAt: '2022-03-09T05:16:59.112Z' meta: total: 10 page: 1 @@ -1993,7 +2000,7 @@ paths: security: - AgentToken: [] description: List all of your contracts. - "/my/contracts/{contractId}": + '/my/contracts/{contractId}': parameters: - schema: type: string @@ -2006,7 +2013,7 @@ paths: tags: - contracts responses: - "200": + '200': description: OK content: application/json: @@ -2023,7 +2030,7 @@ paths: faction: COMMERCE_REPUBLIC type: PROCUREMENT terms: - deadline: "2022-03-11T05:16:59.113Z" + deadline: '2022-03-11T05:16:59.113Z' payment: onAccepted: 20000 onFulfilled: 100000 @@ -2034,12 +2041,12 @@ paths: fulfilled: 0 accepted: false fulfilled: false - expiresAt: "2022-03-09T05:16:59.112Z" + expiresAt: '2022-03-09T05:16:59.112Z' operationId: get-my-contracts-contractId security: - AgentToken: [] description: Get the details of a contract by ID. - "/my/contracts/{contractId}/accept": + '/my/contracts/{contractId}/accept': parameters: - schema: type: string @@ -2051,7 +2058,7 @@ paths: tags: - contracts responses: - "200": + '200': description: OK content: application/json: @@ -2070,12 +2077,12 @@ paths: tags: - systems responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -2084,7 +2091,7 @@ paths: sector: X1 type: RED_STAR x: 0 - "y": 0 + 'y': 0 waypoints: - X1-OE-PM - X1-OE-PM01 @@ -2100,7 +2107,7 @@ paths: sector: X1 type: ORANGE_STAR x: 3 - "y": 4 + 'y': 4 waypoints: - X1-EV-A004 factions: @@ -2111,7 +2118,7 @@ paths: sector: X1 type: BLUE_STAR x: -2 - "y": 11 + 'y': 11 waypoints: [] factions: [] charted: false @@ -2140,7 +2147,7 @@ paths: sector: X1 type: RED_STAR x: 0 - "y": 0 + 'y': 0 waypoints: - X1-OE-PM - X1-OE-PM01 @@ -2160,7 +2167,7 @@ paths: description: Return a list of all systems. security: - AgentToken: [] - "/systems/{systemSymbol}": + '/systems/{systemSymbol}': parameters: - schema: type: string @@ -2174,12 +2181,12 @@ paths: tags: - systems responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -2188,7 +2195,7 @@ paths: sector: X1 type: BLUE_STAR x: -2 - "y": 9 + 'y': 9 waypoints: [] factions: [] charted: false @@ -2206,7 +2213,7 @@ paths: sector: X1 type: BLUE_STAR x: -2 - "y": 9 + 'y': 9 waypoints: [] factions: [] charted: false @@ -2214,7 +2221,7 @@ paths: operationId: get-systems-systemSymbol security: - AgentToken: [] - "/systems/{systemSymbol}/shipyards": + '/systems/{systemSymbol}/shipyards': parameters: - schema: type: string @@ -2227,12 +2234,12 @@ paths: tags: - shipyards responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -2259,7 +2266,7 @@ paths: security: - AgentToken: [] description: Returns a list of all shipyards in a system. - "/systems/{systemSymbol}/shipyards/{waypointSymbol}": + '/systems/{systemSymbol}/shipyards/{waypointSymbol}': parameters: - schema: type: string @@ -2278,7 +2285,7 @@ paths: tags: - shipyards responses: - "200": + '200': description: OK content: application/json: @@ -2290,7 +2297,7 @@ paths: operationId: get-systems-systemSymbol-shipyards-waypointSymbol security: - AgentToken: [] - "/systems/{systemSymbol}/shipyards/{waypointSymbol}/ships": + '/systems/{systemSymbol}/shipyards/{waypointSymbol}/ships': parameters: - schema: type: string @@ -2309,12 +2316,12 @@ paths: tags: - shipyards responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -2350,7 +2357,7 @@ paths: operationId: get-systems-systemSymbol-shipyards-waypointSymbol-ships security: - AgentToken: [] - "/trade/{tradeSymbol}/imports": + '/trade/{tradeSymbol}/imports': parameters: - schema: type: string @@ -2363,12 +2370,12 @@ paths: tags: - markets responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object properties: data: @@ -2386,7 +2393,7 @@ paths: operationId: get-trade-tradeSymbol-imports security: - AgentToken: [] - "/trade/{tradeSymbol}/exports": + '/trade/{tradeSymbol}/exports': parameters: - schema: type: string @@ -2399,12 +2406,12 @@ paths: tags: - markets responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object properties: data: @@ -2422,7 +2429,7 @@ paths: operationId: get-trade-tradeSymbol-exports security: - AgentToken: [] - "/trade/{tradeSymbol}/exchange": + '/trade/{tradeSymbol}/exchange': parameters: - schema: type: string @@ -2435,12 +2442,12 @@ paths: tags: - markets responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object properties: data: @@ -2458,7 +2465,7 @@ paths: operationId: get-trade-tradeSymbol-exchange security: - AgentToken: [] - "/systems/{systemSymbol}/markets": + '/systems/{systemSymbol}/markets': parameters: - schema: type: string @@ -2471,12 +2478,12 @@ paths: tags: - markets responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -2519,7 +2526,7 @@ paths: To install a communications relay at a market, look at the `my/ships/{shipSymbol}/deploy` endpoint. security: - AgentToken: [] - "/systems/{systemSymbol}/markets/{waypointSymbol}": + '/systems/{systemSymbol}/markets/{waypointSymbol}': parameters: - schema: type: string @@ -2538,12 +2545,12 @@ paths: tags: - markets responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -2617,7 +2624,7 @@ paths: See `/my/ships/{shipSymbol}/deploy` for deploying relays at a location. security: - AgentToken: [] - "/systems/{systemSymbol}/waypoints": + '/systems/{systemSymbol}/waypoints': parameters: - schema: type: string @@ -2630,12 +2637,12 @@ paths: tags: - systems responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -2644,7 +2651,7 @@ paths: symbol: X1-OE-PM type: PLANET x: 10 - "y": 5 + 'y': 5 orbitals: - X1-OE-PM01 faction: COMMERCE_REPUBLIC @@ -2663,7 +2670,7 @@ paths: symbol: X1-OE-PM01 type: MOON x: 10 - "y": 5 + 'y': 5 orbitals: [] faction: COMMERCE_REPUBLIC features: @@ -2676,7 +2683,7 @@ paths: symbol: X1-OE-A005 type: ASTEROID_FIELD x: -1 - "y": -29 + 'y': -29 orbitals: [] faction: MINERS_COLLECTIVE features: [] @@ -2688,7 +2695,7 @@ paths: symbol: X1-OE-25X type: JUMP_GATE x: -38 - "y": 47 + 'y': 47 orbitals: [] faction: SPACERS_GUILD features: [] @@ -2719,7 +2726,7 @@ paths: symbol: X1-OE-PM type: PLANET x: 10 - "y": 5 + 'y': 5 orbitals: - X1-OE-PM01 faction: COMMERCE_REPUBLIC @@ -2738,7 +2745,7 @@ paths: symbol: X1-OE-PM01 type: MOON x: 10 - "y": 5 + 'y': 5 orbitals: [] faction: COMMERCE_REPUBLIC features: @@ -2751,7 +2758,7 @@ paths: symbol: X1-OE-A005 type: ASTEROID_FIELD x: -1 - "y": -29 + 'y': -29 orbitals: [] faction: MINERS_COLLECTIVE features: [] @@ -2763,7 +2770,7 @@ paths: symbol: X1-OE-25X type: JUMP_GATE x: -38 - "y": 47 + 'y': 47 orbitals: [] faction: SPACERS_GUILD features: [] @@ -2778,7 +2785,7 @@ paths: security: - AgentToken: [] description: Fetch all of the waypoints for a given system. System must be charted or a ship must be present to return waypoint details. - "/systems/{systemSymbol}/waypoints/{waypointSymbol}": + '/systems/{systemSymbol}/waypoints/{waypointSymbol}': parameters: - schema: type: string @@ -2797,12 +2804,12 @@ paths: tags: - systems responses: - "200": + '200': description: OK content: application/json: schema: - description: "" + description: '' type: object x-examples: example-1: @@ -2811,7 +2818,7 @@ paths: symbol: X1-OE-PM type: PLANET x: 10 - "y": 5 + 'y': 5 orbitals: - X1-OE-PM01 faction: COMMERCE_REPUBLIC @@ -2830,7 +2837,7 @@ paths: symbol: X1-OE-PM01 type: MOON x: 10 - "y": 5 + 'y': 5 orbitals: [] faction: COMMERCE_REPUBLIC features: @@ -2843,7 +2850,7 @@ paths: symbol: X1-OE-A005 type: ASTEROID_FIELD x: -1 - "y": -29 + 'y': -29 orbitals: [] faction: MINERS_COLLECTIVE features: [] @@ -2855,7 +2862,7 @@ paths: symbol: X1-OE-25X type: JUMP_GATE x: -38 - "y": 47 + 'y': 47 orbitals: [] faction: SPACERS_GUILD features: [] @@ -2886,7 +2893,7 @@ paths: symbol: X1-OE-PM type: PLANET x: 10 - "y": 5 + 'y': 5 orbitals: - X1-OE-PM01 faction: COMMERCE_REPUBLIC @@ -2905,7 +2912,7 @@ paths: symbol: X1-OE-PM01 type: MOON x: 10 - "y": 5 + 'y': 5 orbitals: [] faction: COMMERCE_REPUBLIC features: @@ -2918,7 +2925,7 @@ paths: symbol: X1-OE-A005 type: ASTEROID_FIELD x: -1 - "y": -29 + 'y': -29 orbitals: [] faction: MINERS_COLLECTIVE features: [] @@ -2930,7 +2937,7 @@ paths: symbol: X1-OE-25X type: JUMP_GATE x: -38 - "y": 47 + 'y': 47 orbitals: [] faction: SPACERS_GUILD features: []