Docstest Operation.parameter/5

open-api-spex · Sep 13, 2023 · 7c05fa0 · 7c05fa0
1 parent f90bc11
commit 7c05fa0
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/lib/open_api_spex/operation.ex b/lib/open_api_spex/operation.ex
@@ -86,11 +86,27 @@ defmodule OpenApiSpex.Operation do
 
   @doc """
   Shorthand for constructing an `OpenApiSpex.Parameter` given name, location, type, description and optional examples
+
+  ## Examples
+
+      iex> Operation.parameter(
+      ...>   :status,
+      ...>   :query,
+      ...>   %OpenApiSpex.Schema{type: :string, enum: ["pending", "in_progress", "completed"]},
+      ...>   "The status of an entity"
+      ...> )
+      %OpenApiSpex.Parameter{
+        name: :status,
+        in: :query,
+        description: "The status of an entity",
+        required: false,
+        schema: %OpenApiSpex.Schema{enum: ["pending", "in_progress", "completed"], type: :string}
+      }
   """
   @spec parameter(
           name :: atom,
           location :: Parameter.location(),
-          type :: Reference.t() | Schema.t() | atom,
+          type :: Reference.t() | Schema.t() | Parameter.type() | atom(),
           description :: String.t(),
           opts :: keyword
         ) :: Parameter.t()

diff --git a/lib/open_api_spex/parameter.ex b/lib/open_api_spex/parameter.ex
@@ -73,11 +73,12 @@ defmodule OpenApiSpex.Parameter do
         }
 
   @type parameters :: %{String.t() => t | Reference.t()} | nil
+  @type type :: :boolean | :integer | :number | :string | :array | :object
 
   @doc """
   Sets the schema for a parameter from a simple type, reference or Schema
   """
-  @spec put_schema(t, Reference.t() | Schema.t() | atom) :: t
+  @spec put_schema(t, Reference.t() | Schema.t() | type) :: t
   def put_schema(parameter = %Parameter{}, type = %Reference{}) do
     %{parameter | schema: type}
   end

diff --git a/test/operation_test.exs b/test/operation_test.exs
@@ -4,6 +4,8 @@ defmodule OpenApiSpex.OperationTest do
   alias OpenApiSpex.Operation
   alias OpenApiSpexTest.UserController
 
+  doctest Operation
+
   describe "Operation" do
     test "from_route %Phoenix.Router.Route{}" do
       plug = UserController