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

Request body documentation #46

Closed
Metalzoid opened this issue Aug 26, 2024 · 5 comments · Fixed by #49
Closed

Request body documentation #46

Metalzoid opened this issue Aug 26, 2024 · 5 comments · Fixed by #49
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Metalzoid
Copy link
Contributor

Hey !

I founded a issue with the request body :)
In the documentation, if i use that :

# @request_body The user to be created [!Hash{user: {name: String, age: Integer, password: String}}]

the doc return :

{
service: {missing-type-info}
}

But with that it's ok :

# @request_body The user to be created [!Hash{user: Hash{name: String, age: Integer, password: String}}]

Thanks !

@a-chacon
Copy link
Owner

The second is the correct way to document it. I change it in the version 0.5 for support deep structures.

Is there an example with the first structure?

@Metalzoid
Copy link
Contributor Author

Deep structures correctly work 👍
Just in your documentation github, it's always this :

# @request_body The user to be created [!Hash{user: {name: String, age: Integer, password: String}}]

and not that :

# @request_body The user to be created [!Hash{user: Hash{name: String, age: Integer, password: String}}]

@a-chacon
Copy link
Owner

ok. mm Is it possible that you fix it please? Is just modify the README file.

@Metalzoid
Copy link
Contributor Author

Make pull request for this =)

@a-chacon
Copy link
Owner

Thank you! Please don't close this manually. I link the PR to the issue and the issue is closed when the PR is merged hehe

@a-chacon a-chacon added bug Something isn't working documentation Improvements or additions to documentation and removed bug Something isn't working labels Aug 27, 2024
@a-chacon a-chacon linked a pull request Aug 27, 2024 that will close this issue
@github-staff github-staff deleted a comment from Lxx-c Oct 23, 2024
@github-staff github-staff deleted a comment from Lxx-c Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants
@a-chacon @Metalzoid and others