Skip to content

Documentation about client generation some improvements that should be added #2047

Open
@Grummfy

Description

@Grummfy

Hello,
I think some improvement is required on the documentation about client-generation (so /create-client)

  1. All page in this section should have a link to the troubleshooting page (/create-client/troubleshooting/)
  2. The troubleshooting page should have some extra elements
  • # Authenticated API forget to tell that that the generator now include --bearer or --username & --password options. And perhaps being more explicit about which endpoint should be accessible or not (and link to the doc the page of configuration if required)
  • A general advice on using --help could also ease some solution
  1. Add example of generated files (if it exist, I miss them)
  2. Add example of custom template for existing generator (it's possible but except if we read the code, I don't think it's really usable)

Should I create separated issue for that? I will try to find some times to add some of theses elements in the doc

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions