fix: add missing api doc on structure

eveseat · Jan 3, 2022 · 3dd510e · 3dd510e
1 parent 39afaf7
commit 3dd510e
Show file tree

Hide file tree

Showing 3 changed files with 172 additions and 0 deletions.
diff --git a/src/Models/Corporation/CorporationStructure.php b/src/Models/Corporation/CorporationStructure.php
@@ -32,6 +32,112 @@
  * Class CorporationStructure.
  *
  * @package Seat\Eveapi\Models\Corporation
+ *
+ * @OA\Schema(
+ *     description="Corporation Structure",
+ *     title="CorporationStructure",
+ *     type="object"
+ * )
+ *
+ * @OA\Property(
+ *     property="structure_id",
+ *     description="Structure unique identifier",
+ *     type="integer",
+ *     format="int64"
+ * )
+ *
+ * @OA\Property(
+ *     property="profile_id",
+ *     description="Security profile unique identifier applied to the tructure",
+ *     type="integer"
+ * )
+ *
+ * @OA\Property(
+ *     property="fuel_expires",
+ *     description="Date/time when the structure will reach out of fuel",
+ *     type="string",
+ *     format="date-time"
+ * )
+ *
+ * @OA\Property(
+ *     property="state_timer_start",
+ *     description="Date/Time when the current structure state has started",
+ *     type="string",
+ *     format="date-time"
+ * )
+ *
+ * @OA\Property(
+ *     property="state_timer_end",
+ *     description="Date/Time when the current structure state will be over",
+ *     type="string",
+ *     format="date-time"
+ * )
+ *
+ * @OA\Property(
+ *     property="unanchors_at",
+ *     description="Date/Time when the structure will be unanchored - if applicable",
+ *     type="string",
+ *     format="date-time"
+ * )
+ *
+ * @OA\Property(
+ *     property="state",
+ *     description="Current structure state",
+ *     type="string",
+ *     enum={"anchor_vulnerable", "anchoring", "armor_reinforce", "armor_vulnerable", "fitting_invulnerable", "hull_reinforce", "hull_vulnerable", "online_deprecated", "onlining_vulnerable", "shield_vulnerable", "unanchored", "unknown"}
+ * )
+ *
+ * @OA\Property(
+ *     property="reinforce_weekday",
+ *     description="Current structure reinforce weekday",
+ *     type="integer"
+ * )
+ *
+ * @OA\Property(
+ *     property="reinforce_hour",
+ *     description="Current structure reinforce hour",
+ *     type="integer"
+ * )
+ *
+ * @OA\Property(
+ *     property="next_reinforce_weekday",
+ *     description="Next weekday when the structure will be reinforceable",
+ *     type="integer"
+ * )
+ *
+ * @OA\Property(
+ *     property="next_reinforce_hour",
+ *     description="Next hour when the structure will be reinforceable",
+ *     type="integer"
+ * )
+ *
+ * @OA\Property(
+ *     property="next_reinforce_apply",
+ *     description="Date/Time when the structure will be reinforceable",
+ *     type="string",
+ *     format="date-time"
+ * )
+ *
+ * @OA\Property(
+ *     property="info",
+ *     ref="#/components/schemas/UniverseStructure"
+ * )
+ *
+ * @OA\Property(
+ *     property="type",
+ *     ref="#/components/schemas/InvType"
+ * )
+ *
+ * @OA\Property(
+ *     property="services",
+ *     type="array",
+ *     @OA\Items(ref="#/components/schemas/CorporationStructureService")
+ * )
+ *
+ * @OA\Property(
+ *     property="solar_system",
+ *     ref="#/components/schemas/SolarSystem"
+ * )
  */
 class CorporationStructure extends Model
 {
@@ -41,6 +147,11 @@ class CorporationStructure extends Model
 
     const DGM_STRUCTURE_SERVICE_ROLE_BONUS = 2339;
 
+    /**
+     * @var array
+     */
+    protected $hidden = ['corporation_id', 'type_id', 'system_id', 'created_at', 'updated_at'];
+
     /**
      * @var bool
      */

diff --git a/src/Models/Corporation/CorporationStructureService.php b/src/Models/Corporation/CorporationStructureService.php
@@ -29,11 +29,33 @@
  * Class CorporationStructureService.
  *
  * @package Seat\Eveapi\Models\Corporation
+ *
+ * @OA\Schema(
+ *     title="CorporationStructureService",
+ *     description="Corporation Structure Service",
+ *     type="object"
+ * )
+ *
+ * @OA\Property(
+ *     property="name",
+ *     type="string"
+ * )
+ *
+ * @OA\Property(
+ *     property="state",
+ *     type="string",
+ *     enum={"online", "offline", "cleanup"}
+ * )
  */
 class CorporationStructureService extends Model
 {
     use HasCompositePrimaryKey;
 
+    /**
+     * @var array
+     */
+    protected $hidden = ['structure_id', 'created_at', 'updated_at'];
+
     /**
      * @var bool
      */

diff --git a/src/Models/Sde/SolarSystem.php b/src/Models/Sde/SolarSystem.php
@@ -29,6 +29,45 @@
  * Class SolarSystem.
  *
  * @package Seat\Eveapi\Models\Sde
+ *
+ * @OA\Schema(
+ *     title="SolarSystem",
+ *     type="object",
+ *     description="Solar System"
+ * )
+ *
+ * @OA\Property(
+ *     property="system_id",
+ *     description="Solar System Unique Identifier",
+ *     type="integer",
+ *     format="int64"
+ * )
+ *
+ * @OA\Property(
+ *     property="constellation_id",
+ *     description="Constellation Unique Identifier",
+ *     type="integer",
+ *     format="int64"
+ * )
+ *
+ * @OA\Property(
+ *     property="region_id",
+ *     description="Region Unique Identifier",
+ *     type="integer",
+ *     format="int64"
+ * )
+ *
+ * @OA\Property(
+ *     property="name",
+ *     description="Solar System name",
+ *     type="string"
+ * )
+ *
+ * @OA\Propertu(
+ *     property="security",
+ *     description="Solar System Security Level",
+ *     type="double"
+ * )
  */
 class SolarSystem extends Model
 {