openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

Improving Docs of TypeScript-Axios, TypesScript-Fetch

Open tobiashochguertel opened this issue 3 years ago • 4 comments

#2594, #14259

Adds same type of docs as for the javascript client generator to the generators:, typescript-axios and typescript-fetch.

So far I worked mostley on the typescript-axios generator and will continue to work on the typescript-fetch generator.

I hope to get this early in, so that we can test it in master branch and get an unstable docker image, which I can use with my gitlab pipeline to test it?

TypeScript (Axios): @nicokoenig TypeScript (Fetch): @leonyu

Minor changes in the docs for javascript as well:

Javascript/NodeJS: @jfiala JavaScript (Apollo DataSource): @erithmetic JavaScript (Closure-annotated Angular) @achew22 JavaScript (Flow types) @jaypea

PR checklist

  • [X] Read the contribution guidelines.
  • [X] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [X] Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH.
  • [x] File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

tobiashochguertel avatar Dec 15 '22 10:12 tobiashochguertel

@tobiashochguertel thanks for the PR. can you please resolve the merge conflicts when you've time?

wing328 avatar Feb 17 '23 16:02 wing328

@tobiashochguertel thanks for the PR. can you please resolve the merge conflicts when you've time?

yes, I'm working on it.

tobiashochguertel avatar Feb 18 '23 08:02 tobiashochguertel

I'm not sure if I can done this at the weekend. Can we move it do antoher release? Can we shorten the changes per Release?

tobiashochguertel avatar Feb 18 '23 10:02 tobiashochguertel

take your time.

v6.3.0 took longer than expected to release.

wing328 avatar Feb 24 '23 07:02 wing328