improvement: fully specify filter in open api schema

zeadhani · Jun 25, 2024 · e38642e · e38642e
1 parent ca62a34
commit e38642e
Show file tree

Hide file tree

Showing 4 changed files with 441 additions and 125 deletions.
diff --git a/documentation/topics/open-api.md b/documentation/topics/open-api.md
@@ -86,3 +86,13 @@ To override any value in the OpenApi documentation you can use the `:modify_open
     }
   end
 ```
+
+## Known issues/limitations
+
+### Swagger UI
+
+SwaggerUI does not properly render recursive types. This affects the examples and type documentation for the `filter` parameter especially.
+
+### Redoc
+
+Redoc does not show all available schemas in the sidebar. This means that some schemas that are referenced only but have no endpoints that refer to them are effectively un-discoverable without downloading the spec and hunting them down yourself.
diff --git a/lib/ash_json_api/json_schema/json_schema.ex b/lib/ash_json_api/json_schema/json_schema.ex
@@ -1097,6 +1097,7 @@ defmodule AshJsonApi.JsonSchema do
 
   defp sortable?(_, _), do: false
 
+  @doc false
   def embedded?({:array, resource_or_type}) do
     embedded?(resource_or_type)
   end