-
-
Notifications
You must be signed in to change notification settings - Fork 7k
Add API/Model Docs to typescript-fetch codegen #18351
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
base: master
Are you sure you want to change the base?
Add API/Model Docs to typescript-fetch codegen #18351
Conversation
thanks for the PR cc |
can you please follow step 3 to update the samples to address https://github.com/OpenAPITools/openapi-generator/actions/runs/8640982079/job/23690384008?pr=18351 ? |
Yep, forgot to do it again after the fix. |
@wing328 Quick question, do you know how to ensure that the docs are generated inside a |
good question. you will need to override 2 functions to set the folders, e.g. |
Perfect, just added that |
samples/client/petstore/typescript-fetch/builds/allOf-nullable/Club.md
Outdated
Show resolved
Hide resolved
|
||
@Override | ||
public String modelDocFileFolder() { | ||
return (outputFolder + File.separator + modelDocPath); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you please add .replace('/', File.separatorChar)
?
output folder may contains /
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe I've updated it to what you wanted
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the build failed. please take a look when you've time.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@wing328 Not sure what the issue was but have pushed changes to run and test the build again
...generator/src/main/java/org/openapitools/codegen/languages/TypeScriptFetchClientCodegen.java
Outdated
Show resolved
Hide resolved
@wing328 Make some updates, should be good to rip another build? |
the tests still failed. please take another look when you've time |
@mason-at-pieces please rebase onto the lastest master branch and re-generate the samples. |
with this change, did you run a simple test to generate a petstore ts fetch client? did it fail? |
… into typescript-fetch-docs-generator
looks like a rebase/merge failed and resulted in lots of commits not authored by you included in this PR i would suggest you file a new one instead. |
Yeah, I will just create another branch on my fork and make a new pr from that 👍 |
Added support for generating api/model docs for
typescript-fetch
generator.Related issue: #18276
Related Technical Committee Members: @mkusaka
PR checklist
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*
.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master
(upcoming 7.1.0 minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)