From 1c25aa6e66b27cf497d4f42bec55963078b14fd1 Mon Sep 17 00:00:00 2001
From: Space Admiral <joel@spacetraders.io>
Date: Tue, 21 Feb 2023 08:30:25 -0800
Subject: [PATCH] update: add scan waypoints endpoint

---
 models/ScannedWaypoint.json | 51 +++++++++++++++++++++++++++++++
 reference/SpaceTraders.json | 61 +++++++++++++++++++++++++++++++++++++
 2 files changed, 112 insertions(+)
 create mode 100644 models/ScannedWaypoint.json

diff --git a/models/ScannedWaypoint.json b/models/ScannedWaypoint.json
new file mode 100644
index 0000000..b0ab1a2
--- /dev/null
+++ b/models/ScannedWaypoint.json
@@ -0,0 +1,51 @@
+{
+  "description": "A waypoint is a location that ships can travel to such as a Planet, Moon or Space Station.",
+  "type": "object",
+  "properties": {
+    "symbol": {
+      "type": "string",
+      "minLength": 1
+    },
+    "type": {
+      "$ref": "./WaypointType.json"
+    },
+    "systemSymbol": {
+      "type": "string",
+      "minLength": 1
+    },
+    "x": {
+      "type": "integer"
+    },
+    "y": {
+      "type": "integer"
+    },
+    "orbitals": {
+      "type": "array",
+      "items": {
+        "$ref": "./WaypointOrbital.json"
+      }
+    },
+    "faction": {
+      "$ref": "./WaypointFaction.json"
+    },
+    "traits": {
+      "type": "array",
+      "description": "The traits of the waypoint.",
+      "items": {
+        "$ref": "./WaypointTrait.json"
+      }
+    },
+    "chart": {
+      "$ref": "./Chart.json"
+    }
+  },
+  "required": [
+    "symbol",
+    "type",
+    "systemSymbol",
+    "x",
+    "y",
+    "orbitals",
+    "traits"
+  ]
+}
\ No newline at end of file
diff --git a/reference/SpaceTraders.json b/reference/SpaceTraders.json
index 6c56f93..ec841ba 100644
--- a/reference/SpaceTraders.json
+++ b/reference/SpaceTraders.json
@@ -2105,6 +2105,67 @@
         ]
       }
     },
+    "/my/ships/{shipSymbol}/scan/waypoints": {
+      "parameters": [
+        {
+          "in": "path",
+          "name": "shipSymbol",
+          "required": true,
+          "schema": {
+            "type": "string"
+          }
+        }
+      ],
+      "post": {
+        "description": "Activate your ship's sensor arrays to scan for waypoint information.",
+        "operationId": "create-ship-waypoint-scan",
+        "responses": {
+          "201": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "description": "",
+                  "properties": {
+                    "data": {
+                      "properties": {
+                        "cooldown": {
+                          "$ref": "../models/Cooldown.json"
+                        },
+                        "waypoints": {
+                          "items": {
+                            "$ref": "../models/ScannedWaypoint.json"
+                          },
+                          "type": "array"
+                        }
+                      },
+                      "required": [
+                        "cooldown",
+                        "waypoints"
+                      ],
+                      "type": "object"
+                    }
+                  },
+                  "required": [
+                    "data"
+                  ],
+                  "type": "object"
+                }
+              }
+            },
+            "description": "Created"
+          }
+        },
+        "security": [
+          {
+            "AgentToken": []
+          }
+        ],
+        "summary": "Scan Waypoints",
+        "tags": [
+          "fleet"
+        ]
+      }
+    },
     "/my/ships/{shipSymbol}/scan/ships": {
       "parameters": [
         {