Skip to content

Improve documentation for anyOf with lists in them #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wolfadex merged 1 commit into from
Feb 12, 2026
+28 −22
Merged

Improve documentation for anyOf with lists in them #270

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 28 additions & 22 deletions src/SchemaUtils.elm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,22 +226,8 @@ schemaToType seen schema =

Json.Schema.Definitions.ItemDefinition itemSchema ->
CliMonad.map
(\{ type_, documentation } ->
{ type_ = Common.List type_
, documentation =
[ subSchema.description
, Maybe.map
(\doc ->
if String.contains "\n" doc then
"A list of:\n" ++ doc

else
"A list of: " ++ doc
)
documentation
]
|> joinIfNotEmpty "\n\n"
}
(\item ->
toListType subSchema.description item
)
(schemaToType seen itemSchema)

Expand All @@ -259,12 +245,7 @@ schemaToType seen schema =
case areAllArrays schemas of
Just innerSchemas ->
oneOfToType innerSchemas
|> CliMonad.map
(\t ->
{ type_ = Common.List t.type_
, documentation = t.documentation
}
)
|> CliMonad.map (toListType subSchema.description)

Nothing ->
let
Expand Down Expand Up @@ -507,6 +488,31 @@ schemaToType seen schema =
)


toListType :
Maybe String
->
{ type_ : Common.Type
, documentation : Maybe String
}
-> { type_ : Common.Type, documentation : Maybe String }
toListType description { type_, documentation } =
{ type_ = Common.List type_
, documentation =
[ description
, Maybe.map
(\doc ->
if String.contains "\n" doc then
"A list of:\n" ++ doc

else
"A list of: " ++ doc
)
documentation
]
|> joinIfNotEmpty "\n\n"
}


areAllArrays : List Json.Schema.Definitions.Schema -> Maybe (List Json.Schema.Definitions.Schema)
areAllArrays schemas =
schemas
Expand Down