fix: cleanup examples for system and connections (#370)

This commit is contained in:
guarzo
2025-05-11 08:20:23 -04:00
committed by GitHub
parent 07e2196eb4
commit 8bf063a228
2 changed files with 11 additions and 11 deletions

View File

@@ -135,7 +135,7 @@ defmodule WandererAppWeb.MapConnectionAPIController do
description: "Map identifier (UUID or slug). Provide either a UUID or a slug.", description: "Map identifier (UUID or slug). Provide either a UUID or a slug.",
type: :string, type: :string,
required: true, required: true,
example: "00000000-0000-0000-0000-000000000000 or my-map-slug" example: "map-slug or map UUID"
], ],
solar_system_source: [in: :query, type: :integer, required: false], solar_system_source: [in: :query, type: :integer, required: false],
solar_system_target: [in: :query, type: :integer, required: false] solar_system_target: [in: :query, type: :integer, required: false]
@@ -190,7 +190,7 @@ defmodule WandererAppWeb.MapConnectionAPIController do
description: "Map identifier (UUID or slug). Provide either a UUID or a slug.", description: "Map identifier (UUID or slug). Provide either a UUID or a slug.",
type: :string, type: :string,
required: true, required: true,
example: "00000000-0000-0000-0000-000000000000 or my-map-slug" example: "map-slug or map UUID"
], ],
id: [in: :path, type: :string, required: false], id: [in: :path, type: :string, required: false],
solar_system_source: [in: :query, type: :integer, required: false], solar_system_source: [in: :query, type: :integer, required: false],
@@ -221,7 +221,7 @@ defmodule WandererAppWeb.MapConnectionAPIController do
description: "Map identifier (UUID or slug). Provide either a UUID or a slug.", description: "Map identifier (UUID or slug). Provide either a UUID or a slug.",
type: :string, type: :string,
required: true, required: true,
example: "00000000-0000-0000-0000-000000000000 or my-map-slug" example: "map-slug or map UUID"
], ],
system_id: [in: :path, type: :string, required: false] system_id: [in: :path, type: :string, required: false]
], ],
@@ -259,7 +259,7 @@ defmodule WandererAppWeb.MapConnectionAPIController do
description: "Map identifier (UUID or slug). Provide either a UUID or a slug.", description: "Map identifier (UUID or slug). Provide either a UUID or a slug.",
type: :string, type: :string,
required: true, required: true,
example: "00000000-0000-0000-0000-000000000000 or my-map-slug" example: "map-slug or map UUID"
], ],
id: [in: :path, type: :string, required: false], id: [in: :path, type: :string, required: false],
solar_system_source: [in: :query, type: :integer, required: false], solar_system_source: [in: :query, type: :integer, required: false],
@@ -347,7 +347,7 @@ defmodule WandererAppWeb.MapConnectionAPIController do
description: "Map identifier (UUID or slug). Provide either a UUID or a slug.", description: "Map identifier (UUID or slug). Provide either a UUID or a slug.",
type: :string, type: :string,
required: true, required: true,
example: "00000000-0000-0000-0000-000000000000 or my-map-slug" example: "map-slug or map UUID"
], ],
id: [in: :path, type: :string, required: false], id: [in: :path, type: :string, required: false],
solar_system_source: [in: :query, type: :integer, required: false], solar_system_source: [in: :query, type: :integer, required: false],

View File

@@ -293,7 +293,7 @@ defmodule WandererAppWeb.MapSystemAPIController do
description: "Map identifier (UUID or slug). Provide either a UUID or a slug.", description: "Map identifier (UUID or slug). Provide either a UUID or a slug.",
type: :string, type: :string,
required: true, required: true,
example: "00000000-0000-0000-0000-000000000000 or my-map-slug" example: "my-map-slug or map UUID"
] ]
], ],
responses: [ responses: [
@@ -317,7 +317,7 @@ defmodule WandererAppWeb.MapSystemAPIController do
description: "Map identifier (UUID or slug). Provide either a UUID or a slug.", description: "Map identifier (UUID or slug). Provide either a UUID or a slug.",
type: :string, type: :string,
required: true, required: true,
example: "00000000-0000-0000-0000-000000000000 or my-map-slug" example: "my-map-slug or map UUID"
], ],
id: [in: :path, type: :string, required: true] id: [in: :path, type: :string, required: true]
], ],
@@ -337,7 +337,7 @@ defmodule WandererAppWeb.MapSystemAPIController do
description: "Map identifier (UUID or slug). Provide either a UUID or a slug.", description: "Map identifier (UUID or slug). Provide either a UUID or a slug.",
type: :string, type: :string,
required: true, required: true,
example: "00000000-0000-0000-0000-000000000000 or my-map-slug" example: "my-map-slug or map UUID"
] ]
], ],
request_body: {"Systems+Connections upsert", "application/json", @batch_request_schema}, request_body: {"Systems+Connections upsert", "application/json", @batch_request_schema},
@@ -361,7 +361,7 @@ defmodule WandererAppWeb.MapSystemAPIController do
description: "Map identifier (UUID or slug). Provide either a UUID or a slug.", description: "Map identifier (UUID or slug). Provide either a UUID or a slug.",
type: :string, type: :string,
required: true, required: true,
example: "00000000-0000-0000-0000-000000000000 or my-map-slug" example: "my-map-slug or map UUID"
], ],
id: [in: :path, type: :string, required: true] id: [in: :path, type: :string, required: true]
], ],
@@ -384,7 +384,7 @@ defmodule WandererAppWeb.MapSystemAPIController do
description: "Map identifier (UUID or slug). Provide either a UUID or a slug.", description: "Map identifier (UUID or slug). Provide either a UUID or a slug.",
type: :string, type: :string,
required: true, required: true,
example: "00000000-0000-0000-0000-000000000000 or my-map-slug" example: "my-map-slug or map UUID"
] ]
], ],
request_body: {"Batch delete", "application/json", @batch_delete_schema}, request_body: {"Batch delete", "application/json", @batch_delete_schema},
@@ -431,7 +431,7 @@ defmodule WandererAppWeb.MapSystemAPIController do
description: "Map identifier (UUID or slug). Provide either a UUID or a slug.", description: "Map identifier (UUID or slug). Provide either a UUID or a slug.",
type: :string, type: :string,
required: true, required: true,
example: "00000000-0000-0000-0000-000000000000 or my-map-slug" example: "my-map-slug or map UUID"
], ],
id: [in: :path, type: :string, required: true] id: [in: :path, type: :string, required: true]
], ],