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

Generated Docs don't support list #347

Open
seoushi opened this issue Aug 10, 2023 · 3 comments
Open

Generated Docs don't support list #347

seoushi opened this issue Aug 10, 2023 · 3 comments

Comments

@seoushi
Copy link

seoushi commented Aug 10, 2023

I've noticed that if my input type has a list in it that the examples will not show up in the generated documentation. This is with Giraffe 6.2.0 and Fable.Remoting.Giraffe 5.14.0

Example Code

  type MyRequest =
  {
    ids : string list
  }

  type Api =
  {
    id : MyRequest -> Async<unit>
  }

   docBase.route <@ fun api -> api.id @> 
   |> docBase.alias "My func"
   |> docBase.description "Returns stuff"
   |> docBase.example <@ fun api -> api.id {ids = ["anId"] } @>

@Zaid-Ajaj
Copy link
Owner

Hi @seoushi I believe this should work 🤔 maybe docBase.route <@ fun api -> api.id l @> should just be docBase.route <@ fun api -> api.id @> without a parameter provided?

@seoushi
Copy link
Author

seoushi commented Oct 10, 2023

Looks like I made a typo there. I don't have extra parameters in my code. I updated my code above to remove that.

@Zaid-Ajaj
Copy link
Owner

I see, I will look into it sometime soon, will keep you posted of any progress

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

No branches or pull requests

2 participants