Skip to content
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.

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

"allow_blank" setting is not displayed in api doc #925

Closed
pekopekopekopayo opened this issue Apr 5, 2024 · 3 comments · Fixed by #926
Closed

"allow_blank" setting is not displayed in api doc #925

pekopekopekopayo opened this issue Apr 5, 2024 · 3 comments · Fixed by #926

Comments

@pekopekopekopayo
Copy link
Contributor

The "allow_blank" setting is not indicated in the API documentation.
but allow_nil is displaied
i want to add it

path:_params_plain.html.erb, _params.html.erb
        <%= param[:required] ? t('apipie.required') : t('apipie.optional') %>
        <%= param[:allow_nil] ? ', '+t('apipie.nil_allowed') : '' %>
        <%= param[:allow_blank] ? ', '+t('apipie.blank_allowed') : '' %>

Of course, I will also include the language

I want to submit a pull request but I don't know how. 😢

@pekopekopekopayo pekopekopekopayo changed the title "allow_blank" setting is not show in api doc "allow_blank" setting is not displaied in api doc Apr 5, 2024
@ekohl ekohl changed the title "allow_blank" setting is not displaied in api doc "allow_blank" setting is not displayed in api doc Apr 5, 2024
@ekohl
Copy link
Member

ekohl commented Apr 5, 2024

You already identified most of the files you need to change but you'll also need add blank_allowed to config/locales/en.yml so the translation function can work.

https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github looks like a decent start on how to submit a pull request.

@pekopekopekopayo
Copy link
Contributor Author

pekopekopekopayo commented Apr 5, 2024

@ekohl
Thank you!! i completed!
So sorry my english is so bad...
And I'm going to contribute for the first time

@ekohl ekohl linked a pull request Apr 5, 2024 that will close this issue
@ekohl
Copy link
Member

ekohl commented Apr 5, 2024

Your English is better than my Korean ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants