Skip to content

fix: typescript docs not being put in a docs directory #22124

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.

Sign up for GitHub

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

Merged
wing328 merged 2 commits into from
Oct 15, 2025
+9 −0
Merged

fix: typescript docs not being put in a docs directory #22124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc8421e
fix: typescript docs not being put in a docs directory
robertmarsal Oct 13, 2025
12c84d2
fix: platform agnostic path separator
robertmarsal Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions ...i-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ public class TypeScriptClientCodegen extends AbstractTypeScriptClientCodegen imp
private final DateTimeFormatter iso8601Date = DateTimeFormatter.ISO_DATE;
private final DateTimeFormatter iso8601DateTime = DateTimeFormatter.ISO_DATE_TIME;

protected String apiDocPath = "docs/";

public TypeScriptClientCodegen() {
super();

Expand Down Expand Up @@ -400,6 +402,11 @@ public ModelsMap postProcessModels(ModelsMap objs) {
return objs;
}

@Override
public String apiDocFileFolder() {
return (outputFolder + "/" + apiDocPath).replace('/', File.separatorChar);
}

Copy link
Member

@wing328 wing328 Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion:

    @Override
    public String apiDocFileFolder() {
        return (outputFolder + "/" + apiDocPath).replace('/', File.separatorChar);
    }

Copy link
Contributor

@joscha joscha Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ agree with this as it means the apiDocPath becomes system-agnostic.

Copy link
Contributor Author

@robertmarsal robertmarsal Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, pushed a commit to do this.

private List<Map<String, String>> toTsImports(CodegenModel cm, Set<String> imports) {
List<Map<String, String>> tsImports = new ArrayList<>();
for (String im : imports) {
Expand Down Expand Up @@ -432,6 +439,8 @@ public void processOpts() {
apiPackage = this.apiPackage + ".apis";
testPackage = this.testPackage + ".tests";

additionalProperties.put("apiDocPath", apiDocPath);
Copy link
Member

@macjohnny macjohnny Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this even needed?

Copy link
Contributor Author

@robertmarsal robertmarsal Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not at the moment but when the README will be updated to be consistent with the other generators and include the docs, it is used there, see the Java README for example:

openapi-generator/modules/openapi-generator/src/main/resources/Java/README.mustache

Line 194 in cf2435f

{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{commonPath}}{{path}} | {{summary}}


additionalProperties.putIfAbsent(FRAMEWORK_SWITCH, FRAMEWORKS[0]);
supportingFiles.add(new SupportingFile("index.mustache", "index.ts"));

Expand Down
Loading