Handle Union Return Types to Union Guide Instead of Scalars

podium · Sep 26, 2024 · 5d39f09 · 5d39f09
1 parent bfb8839
commit 5d39f09
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.4.2 - 2024-09-26
+
+### Fixed
+
+* Links to union return types handled correctly
+
 ## 0.4.1 - 2024-09-25
 
 ### Fixed

diff --git a/lib/graphql_markdown/multi_page.ex b/lib/graphql_markdown/multi_page.ex
@@ -192,6 +192,9 @@ defmodule GraphqlMarkdown.MultiPage do
         "ENUM" ->
           "enums.html#" <> Schema.field_type(field["type"])
 
+        "UNION" ->
+          "unions.html#" <> Schema.field_type(field["type"])
+
         _ ->
           "scalars.html#" <> Schema.field_type(field["type"])
       end

diff --git a/mix.exs b/mix.exs
@@ -2,7 +2,7 @@ defmodule GraphqlMarkdown.MixProject do
   use Mix.Project
 
   @project_url "https://github.com/podium/graphql_markdown"
-  @version "0.4.1"
+  @version "0.4.2"
 
   def project do
     [

diff --git a/test/graphql_markdown_test.exs b/test/graphql_markdown_test.exs
@@ -81,6 +81,10 @@ defmodule GraphqlMarkdownTest do
       # anchors need to be downcased to match other parts of the generated markdown
       content = File.read!("guides/queries.md")
       assert content =~ "Type: [Droid](scalars.html#droid)"
+
+      # union types need to be a valid type for links
+      content = File.read!("guides/mutations.md")
+      assert content =~ "Type: [LoginResponseV2](unions.html#loginresponsev2)"
     end
 
     test "fails to load the file" do