Skip to content

feat: allow to hide fields from documentation #7

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
silvadanilo merged 1 commit into from
Apr 11, 2025
Merged

feat: allow to hide fields from documentation #7

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion lib/open_api/open_api.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ defmodule EctoCommand.OpenApi do
Enum.reduce(@command_fields, {%{}, []}, fn field, {fields, required} ->
{name, type, opts} = field

if opts[:internal] != true do
if opts[:internal] != true and opts[:doc] != false do
required = if Enum.member?([true, []], opts[:required]), do: [name | required], else: required
fields = Map.put(fields, name, EctoCommand.OpenApi.schema_for(type, opts))
{fields, required}
Expand Down
5 changes: 5 additions & 0 deletions test/unit/command/open_api/open_api_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ defmodule Unit.EctoCommand.OpenApi.OpenApiTest do

command do
param :id, :string, doc: Type.uuid()
param :hidden_field, :string, required: true, inclusion: ["a", "b"], doc: false
param :numeric_id, :id
param :name, :string, required: true, length: [min: 2, max: 255], doc: [example: "Mario"]
param :email, :string, required: true, format: ~r/@/, length: [min: 6], doc: Type.email()
Expand Down Expand Up @@ -158,6 +159,8 @@ defmodule Unit.EctoCommand.OpenApi.OpenApiTest do
example: %{a: 1}
}
} == Sample.schema().properties

refute Map.has_key?(Sample.schema().properties, :hidden_field)
end

test "example is generated accordingly to properties" do
Expand Down Expand Up @@ -188,6 +191,8 @@ defmodule Unit.EctoCommand.OpenApi.OpenApiTest do
type_id: "string",
uploaded_at: "2023-04-03T10:21:00Z"
} == Sample.schema().example

refute Map.has_key?(Sample.schema().example, :hidden_field)
end

test "required fields list is generated correctly" do
Expand Down