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 do not display examples with > 5 parameters #199

Open
Freymaurer opened this issue Nov 25, 2020 · 3 comments
Open

Generated Docs do not display examples with > 5 parameters #199

Freymaurer opened this issue Nov 25, 2020 · 3 comments

Comments

@Freymaurer
Copy link

I hate to be that guy, but i just noticed that the docs don't show examples with more than 5 parameters.
As i did not find anything about this restriction in the docs i thought i would mention it here.

type ITestAPI = {
    //will show examples
    getTestString1               : string*string*string*string*string                   -> Async<string>
    // will not show examples
    getTestString2               : string*string*string*string*string*string            -> Async<string>
}
@Zaid-Ajaj
Copy link
Owner

I hate to be that guy, but i just noticed that the docs don't show examples with more than 5 parameters

Bug reports are always appreciated! I will have a look and see why it isn't working. Just to be sure, this is happening on latest Giraffe v4.13?

@Freymaurer
Copy link
Author

I use paket for packet managing and my packet.lock does show Fable.Remoting.Giraffe (4.13) and Giraffe (4.1), which should be the newest non-preview version: https://www.nuget.org/packages/Giraffe/ .

@Numpsy
Copy link

Numpsy commented Apr 28, 2021

Hi,
fwiw, I tried it with the latest version using

type ITunesStore = {
        createAlbum : string*string*string*string*string*string*string -> Async<Option<Album>>
    }

and

let exampleInput = ("A", "B", "C", "D", "E", "F", "G")

    let tunesStoreDocs = 

        Remoting.documentation "Tunes" [

            tunesDocs.route <@ fun api -> api.createAlbum @> 
            |> tunesDocs.description "Creates a tune"
            |> tunesDocs.example <@ fun api -> api.createAlbum exampleInput @>

        ]

and that seems to work ok:

image

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

3 participants