Merge upstream open_api_spex master

.github/workflows/elixir.yml

@@ -15,14 +15,14 @@ jobs:
         otp: ["26"]
         elixir: ["1.16"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1
         id: beam
         with:
           otp-version: ${{matrix.otp}}
           elixir-version: ${{matrix.elixir}}
       - name: PLT cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           key: |
             ${{ runner.os }}-${{ steps.beam.outputs.elixir-version }}-${{ steps.beam.outputs.otp-version }}-plt
@@ -34,20 +34,22 @@ jobs:
       - run: mix compile --warnings-as-errors
       - run: mix format --check-formatted
       - run: mix credo --strict --all
-      - run: mix dialyzer
+      - run: mix dialyzer --format github
+      - run: mix docs --warnings-as-errors
 
   test_examples:
     runs-on: ubuntu-latest
     name: Test Sample Applications
     env:
       MIX_ENV: test
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1
+        id: beam
         with:
           otp-version: 26
           elixir-version: 1.16
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           key: |
             ${{ runner.os }}-${{ steps.beam.outputs.elixir-version }}-${{ steps.beam.outputs.otp-version }}-plug-build
@@ -61,28 +63,28 @@ jobs:
         run: mix do deps.get, test
 
   test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     name: Test (OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}})
     strategy:
       matrix:
-        otp: ["23", "24", "25", "26"]
-        elixir: ["1.14", "1.15", "1.16"]
+        otp: ["24", "25", "26"]
+        elixir: ["1.14", "1.15", "1.16", "1.18"]
         # Test each elixir version with lowest and highest compatible OTP version, exclude others
         # See https://hexdocs.pm/elixir/compatibility-and-deprecations.html#between-elixir-and-erlang-otp
         exclude:
           - { otp: "24", elixir: "1.14" }
+          - { otp: "24", elixir: "1.18" }
           - { otp: "25", elixir: "1.14" }
-          - { otp: "23", elixir: "1.15" }
           - { otp: "25", elixir: "1.15" }
-          - { otp: "23", elixir: "1.16" }
           - { otp: "25", elixir: "1.16" }
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1
+        id: beam
         with:
           otp-version: ${{matrix.otp}}
           elixir-version: ${{matrix.elixir}}
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           key: |
             ${{ runner.os }}-${{ steps.beam.outputs.elixir-version }}-${{ steps.beam.outputs.otp-version }}-build

CHANGELOG.md

@@ -5,6 +5,38 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v3.22.3 - 2026-05-05
+
+* chore: removed unused require(s) by @David-Klemenc in https://github.com/open-api-spex/open_api_spex/pull/700
+* Relax decimal requirement by @josevalim in https://github.com/open-api-spex/open_api_spex/pull/702
+
+## v3.22.2 - 2026-01-08
+
+* fix: type warnings Elixir 1.19 by @davydog187 in https://github.com/open-api-spex/open_api_spex/pull/693
+
+## v3.22.1 - 2025-11-21
+
+* Fix elixir 1.19 support by @adamcstephens in https://github.com/open-api-spex/open_api_spex/pull/685
+
+## v3.22.0 - 2025-08-05
+
+* Support multiple apps in Plug.SwaggerUI by @zorbash in https://github.com/open-api-spex/open_api_spex/pull/676
+* Validate keys given to operation/2 macro by @xxdavid in https://github.com/open-api-spex/open_api_spex/pull/675
+
+## v3.21.5 - 2025-07-08
+
+* Fix assert_operation_response/2 references by @zorbash in https://github.com/open-api-spex/open_api_spex/pull/673
+
+## v3.21.4 - 2025-07-01
+
+* Fix OTP-28 support by @bopm in https://github.com/open-api-spex/open_api_spex/pull/672
+
+## v3.21.3 - 2025-06-25
+
+* Fix cast x-validate when decoded schema by @GPrimola in https://github.com/open-api-spex/open_api_spex/pull/647
+* Add examples property to Schema by @madjar in https://github.com/open-api-spex/open_api_spex/pull/654
+* Document schema resolver duplicate titles behaviour by @zorbash in https://github.com/open-api-spex/open_api_spex/pull/656
+* Fix 1.18 compilation warnings by @zorbash in https://github.com/open-api-spex/open_api_spex/pull/665
 
 ## v3.21.2 - 2024-10-02
 

examples/phoenix_app/lib/phoenix_app/accounts/accounts.ex

@@ -2,8 +2,19 @@ defmodule PhoenixApp.Accounts do
   alias PhoenixApp.Accounts.User
   alias PhoenixApp.Repo
 
-  def list_users() do
-    Repo.all(User)
+  import Ecto.Query
+
+  def list_users(filters) do
+    query = from(u in User, order_by: [asc: u.id])
+
+    query =
+      if filters[:ids] do
+        from(u in query, where: u.id in ^filters[:ids])
+      else
+        query
+      end
+
+    Repo.all(query)
   end
 
   def get_user!(id) do

examples/phoenix_app/lib/phoenix_app_web/controllers/user_controller.ex

@@ -21,13 +21,22 @@ defmodule PhoenixAppWeb.UserController do
   operation :index,
     summary: "List users",
     description: "List all users",
+    parameters: [
+      OpenApiSpex.Operation.parameter(
+        :ids,
+        :query,
+        %Schema{type: :array, items: %Schema{type: :integer}},
+        "Filter by user ids"
+      )
+    ],
     responses: [
       ok: {"User List Response", "application/json", Schemas.UsersResponse},
       unprocessable_entity: %Reference{"$ref": "#/components/responses/unprocessable_entity"}
     ]
 
-  def index(conn, _params) do
-    users = Accounts.list_users()
+  def index(conn, params) do
+    users = Accounts.list_users(params)
+
     render(conn, "index.json", users: users)
   end
 
@@ -37,8 +46,7 @@ defmodule PhoenixAppWeb.UserController do
     parameters: [
       group_id: [in: :path, type: :integer, description: "Group ID", example: 1]
     ],
-    request_body:
-      {"The user attributes", "application/json", Schemas.UserRequest, required: true},
+    request_body: {"The user attributes", "application/json", Schemas.UserRequest, required: true},
     responses: [
       created: {"User", "application/json", Schemas.UserResponse}
     ]
@@ -88,8 +96,7 @@ defmodule PhoenixAppWeb.UserController do
         required: true
       ]
     ],
-    request_body:
-      {"The user attributes", "application/json", Schemas.UserRequest, required: true},
+    request_body: {"The user attributes", "application/json", Schemas.UserRequest, required: true},
     responses: [
       ok: {"User", "application/json", Schemas.UserResponse}
     ]

examples/phoenix_app/lib/phoenix_app_web/controllers/user_controller_with_struct_specs.ex

@@ -4,8 +4,10 @@ defmodule PhoenixAppWeb.UserControllerWithStructSpecs do
   of using the ExDoc-based operation specs.
   """
   use PhoenixAppWeb, :controller
+
   import OpenApiSpex.Operation, only: [parameter: 5, request_body: 4, response: 3]
-  alias OpenApiSpex.{Operation, Reference}
+
+  alias OpenApiSpex.{Operation, Reference, Schema}
   alias PhoenixApp.{Accounts, Accounts.User}
   alias PhoenixAppWeb.Schemas
 
@@ -34,15 +36,24 @@ defmodule PhoenixAppWeb.UserControllerWithStructSpecs do
       summary: "List users",
       description: "List all useres",
       operationId: "UserController.index",
+      parameters: [
+        OpenApiSpex.Operation.parameter(
+          :ids,
+          :query,
+          %Schema{type: :array, items: %Schema{type: :integer}},
+          "Filter by user ids"
+        )
+      ],
       responses: %{
         200 => response("User List Response", "application/json", Schemas.UsersResponse),
         422 => %Reference{"$ref": "#/components/responses/unprocessable_entity"}
       }
     }
   end
 
-  def index(conn, _params) do
-    users = Accounts.list_users()
+  def index(conn, params) do
+    users = Accounts.list_users(params)
+
     render(conn, "index.json", users: users)
   end
 
@@ -56,9 +67,7 @@ defmodule PhoenixAppWeb.UserControllerWithStructSpecs do
         Operation.parameter(:group_id, :path, :integer, "Group ID", example: 1)
       ],
       requestBody:
-        request_body("The user attributes", "application/json", Schemas.UserRequest,
-          required: true
-        ),
+        request_body("The user attributes", "application/json", Schemas.UserRequest, required: true),
       responses: %{
         201 => response("User", "application/json", Schemas.UserResponse)
       }

examples/phoenix_app/mix.exs

@@ -31,7 +31,8 @@ defmodule PhoenixApp.Mixfile do
   defp aliases() do
     [
       test: ["ecto.create --quiet", "ecto.migrate", "test"],
-      spec: ["openapi.spec.json  --spec PhoenixAppWeb.ApiSpec \"priv/static/swagger.json\""]
+      spec: ["openapi.spec.json  --spec PhoenixAppWeb.ApiSpec \"priv/static/swagger.json\""],
+      "spec.yaml": ["openapi.spec.yaml --spec PhoenixAppWeb.ApiSpec \"priv/static/swagger.yaml\""]
     ]
   end
 
@@ -48,6 +49,7 @@ defmodule PhoenixApp.Mixfile do
       {:phoenix_view, "~> 2.0"},
       {:plug_cowboy, "~> 2.0"},
       {:jason, "~> 1.0"},
+      {:ymlr, "~> 5.0"},
       {:dialyxir, "1.0.0-rc.6", only: [:dev], runtime: false}
     ]
   end