Allow extensions in all OpenApi structures

Swagger documentation is outdated (https://swagger.io/docs/specification/openapi-extensions/). Reading OpenApi sepcification (https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md) one can see that almost all objects can be extended with custom extensions.
open-api-spex · Mar 23, 2022 · f62061e · f62061e
1 parent 838594d
commit f62061e
Show file tree

Hide file tree

Showing 22 changed files with 172 additions and 63 deletions.
diff --git a/lib/open_api_spex/components.ex b/lib/open_api_spex/components.ex
@@ -25,7 +25,8 @@ defmodule OpenApiSpex.Components do
     :headers,
     :securitySchemes,
     :links,
-    :callbacks
+    :callbacks,
+    :extensions
   ]
 
   @type schemas_map :: %{String.t() => Schema.t() | Reference.t()}
@@ -47,6 +48,7 @@ defmodule OpenApiSpex.Components do
           headers: %{String.t() => Header.t() | Reference.t()} | nil,
           securitySchemes: %{String.t() => SecurityScheme.t() | Reference.t()} | nil,
           links: %{String.t() => Link.t() | Reference.t()} | nil,
-          callbacks: %{String.t() => Callback.t() | Reference.t()} | nil
+          callbacks: %{String.t() => Callback.t() | Reference.t()} | nil,
+          extensions: %{String.t() => any()} | nil
         }
 end
diff --git a/lib/open_api_spex/contact.ex b/lib/open_api_spex/contact.ex
@@ -6,7 +6,8 @@ defmodule OpenApiSpex.Contact do
   defstruct [
     :name,
     :url,
-    :email
+    :email,
+    extensions: nil
   ]
 
   @typedoc """
@@ -17,6 +18,7 @@ defmodule OpenApiSpex.Contact do
   @type t :: %__MODULE__{
           name: String.t() | nil,
           url: String.t() | nil,
-          email: String.t() | nil
+          email: String.t() | nil,
+          extensions: %{String.t() => any()} | nil
         }
 end
diff --git a/lib/open_api_spex/discriminator.ex b/lib/open_api_spex/discriminator.ex
@@ -8,7 +8,8 @@ defmodule OpenApiSpex.Discriminator do
   @enforce_keys :propertyName
   defstruct [
     :propertyName,
-    :mapping
+    :mapping,
+    :extensions
   ]
 
   @typedoc """
@@ -21,7 +22,8 @@ defmodule OpenApiSpex.Discriminator do
   """
   @type t :: %__MODULE__{
           propertyName: String.t(),
-          mapping: %{String.t() => String.t()} | nil
+          mapping: %{String.t() => String.t()} | nil,
+          extensions: %{String.t() => any()} | nil
         }
 
   @doc """

diff --git a/lib/open_api_spex/encoding.ex b/lib/open_api_spex/encoding.ex
@@ -9,7 +9,8 @@ defmodule OpenApiSpex.Encoding do
     :headers,
     :style,
     :explode,
-    :allowReserved
+    :allowReserved,
+    :extensions
   ]
 
   @typedoc """
@@ -22,6 +23,7 @@ defmodule OpenApiSpex.Encoding do
           headers: %{String.t() => Header.t() | Reference.t()} | nil,
           style: Parameter.style() | nil,
           explode: boolean | nil,
-          allowReserved: boolean | nil
+          allowReserved: boolean | nil,
+          extensions: %{String.t() => any()} | nil
         }
 end
diff --git a/lib/open_api_spex/example.ex b/lib/open_api_spex/example.ex
@@ -6,7 +6,8 @@ defmodule OpenApiSpex.Example do
     :summary,
     :description,
     :value,
-    :externalValue
+    :externalValue,
+    :extensions
   ]
 
   @typedoc """
@@ -18,6 +19,7 @@ defmodule OpenApiSpex.Example do
           summary: String.t() | nil,
           description: String.t() | nil,
           value: any,
-          externalValue: String.t() | nil
+          externalValue: String.t() | nil,
+          extensions: %{String.t() => any()} | nil
         }
 end
diff --git a/lib/open_api_spex/extendable.ex b/lib/open_api_spex/extendable.ex
@@ -9,14 +9,31 @@ end
 
 defimpl OpenApiSpex.Extendable,
   for: [
+    OpenApiSpex.Components,
+    OpenApiSpex.Contact,
+    OpenApiSpex.Discriminator,
+    OpenApiSpex.Encoding,
+    OpenApiSpex.Example,
+    OpenApiSpex.ExternalDocumentation,
+    OpenApiSpex.Header,
     OpenApiSpex.Info,
+    OpenApiSpex.License,
+    OpenApiSpex.Link,
+    OpenApiSpex.MediaType,
+    OpenApiSpex.OAuthFlow,
+    OpenApiSpex.OAuthFlows,
     OpenApiSpex.OpenApi,
     OpenApiSpex.Operation,
     OpenApiSpex.Parameter,
     OpenApiSpex.PathItem,
+    OpenApiSpex.RequestBody,
     OpenApiSpex.Response,
+    OpenApiSpex.Schema,
     OpenApiSpex.SecurityScheme,
-    OpenApiSpex.Tag
+    OpenApiSpex.Server,
+    OpenApiSpex.ServerVariable,
+    OpenApiSpex.Tag,
+    OpenApiSpex.Xml
   ] do
   def to_map(struct = %{extensions: e}) do
     struct

diff --git a/lib/open_api_spex/external_documentation.ex b/lib/open_api_spex/external_documentation.ex
@@ -6,7 +6,8 @@ defmodule OpenApiSpex.ExternalDocumentation do
   @enforce_keys :url
   defstruct [
     :description,
-    :url
+    :url,
+    :extensions
   ]
 
   @typedoc """
@@ -16,6 +17,7 @@ defmodule OpenApiSpex.ExternalDocumentation do
   """
   @type t :: %__MODULE__{
           description: String.t() | nil,
-          url: String.t()
+          url: String.t(),
+          extensions: %{String.t() => any()} | nil
         }
 end
diff --git a/lib/open_api_spex/header.ex b/lib/open_api_spex/header.ex
@@ -13,6 +13,7 @@ defmodule OpenApiSpex.Header do
     :schema,
     :example,
     :examples,
+    :extensions,
     style: :simple
   ]
 
@@ -34,6 +35,7 @@ defmodule OpenApiSpex.Header do
           explode: boolean | nil,
           schema: Schema.t() | Reference.t() | nil,
           example: any,
-          examples: %{String.t() => Example.t() | Reference.t()} | nil
+          examples: %{String.t() => Example.t() | Reference.t()} | nil,
+          extensions: %{String.t() => any()} | nil
         }
 end
diff --git a/lib/open_api_spex/license.ex b/lib/open_api_spex/license.ex
@@ -6,7 +6,8 @@ defmodule OpenApiSpex.License do
   @enforce_keys :name
   defstruct [
     :name,
-    :url
+    :url,
+    :extensions
   ]
 
   @typedoc """
@@ -16,6 +17,7 @@ defmodule OpenApiSpex.License do
   """
   @type t :: %__MODULE__{
           name: String.t(),
-          url: String.t() | nil
+          url: String.t() | nil,
+          extensions: %{String.t() => any()} | nil
         }
 end
diff --git a/lib/open_api_spex/link.ex b/lib/open_api_spex/link.ex
@@ -10,7 +10,8 @@ defmodule OpenApiSpex.Link do
     :parameters,
     :requestBody,
     :description,
-    :server
+    :server,
+    :extensions
   ]
 
   @typedoc """
@@ -34,6 +35,7 @@ defmodule OpenApiSpex.Link do
           parameters: %{String.t() => any} | nil,
           requestBody: any,
           description: String.t() | nil,
-          server: Server.t() | nil
+          server: Server.t() | nil,
+          extensions: %{String.t() => any()} | nil
         }
 end
diff --git a/lib/open_api_spex/media_type.ex b/lib/open_api_spex/media_type.ex
@@ -8,7 +8,8 @@ defmodule OpenApiSpex.MediaType do
     :schema,
     :example,
     :examples,
-    :encoding
+    :encoding,
+    :extensions
   ]
 
   @typedoc """
@@ -20,6 +21,7 @@ defmodule OpenApiSpex.MediaType do
           schema: Schema.t() | Reference.t() | nil,
           example: any,
           examples: %{String.t() => Example.t() | Reference.t()} | nil,
-          encoding: %{String => Encoding.t()} | nil
+          encoding: %{String => Encoding.t()} | nil,
+          extensions: %{String.t() => any()} | nil
         }
 end
diff --git a/lib/open_api_spex/oauth_flow.ex b/lib/open_api_spex/oauth_flow.ex
@@ -6,7 +6,8 @@ defmodule OpenApiSpex.OAuthFlow do
     :authorizationUrl,
     :tokenUrl,
     :refreshUrl,
-    :scopes
+    :scopes,
+    :extensions
   ]
 
   @typedoc """
@@ -18,6 +19,7 @@ defmodule OpenApiSpex.OAuthFlow do
           authorizationUrl: String.t() | nil,
           tokenUrl: String.t() | nil,
           refreshUrl: String.t() | nil,
-          scopes: %{String.t() => String.t()} | nil
+          scopes: %{String.t() => String.t()} | nil,
+          extensions: %{String.t() => any()} | nil
         }
 end
diff --git a/lib/open_api_spex/oauth_flows.ex b/lib/open_api_spex/oauth_flows.ex
@@ -8,7 +8,8 @@ defmodule OpenApiSpex.OAuthFlows do
     :implicit,
     :password,
     :clientCredentials,
-    :authorizationCode
+    :authorizationCode,
+    :extensions
   ]
 
   @typedoc """
@@ -20,6 +21,7 @@ defmodule OpenApiSpex.OAuthFlows do
           implicit: OAuthFlow.t() | nil,
           password: OAuthFlow.t() | nil,
           clientCredentials: OAuthFlow.t() | nil,
-          authorizationCode: OAuthFlow.t() | nil
+          authorizationCode: OAuthFlow.t() | nil,
+          extensions: %{String.t() => any()} | nil
         }
 end