[typescript-axios] Add detection for AWS IAM from schema by NiltiakSivad · Pull Request #21356 · OpenAPITools/openapi-generator

NiltiakSivad · 2025-05-30T18:38:57Z

Previous Efforts

I've taken over the effort that was originally started, here. It was suggested in this PR that rather than use a CLI flag like useAwsIamAuth, that we detect IAM Auth from the schema itself.

Summary

This is the first PR of 2. I thought it would be good to talk about the IAM auth detection mechanism before talking about the implementation method in the templates.

At a high-level I'm proposing 3 patterns for detecting AWS IAM Auth.

Check for AWS-specific extension
Check for common AWS V4 signature scheme names
Check for AWS API Gateway URL patterns in servers

It is up for discussion the pro/cons of each, and perhaps we end up with only 1 or a subset of the 3.

Deployment

This is a non-breaking change, as it is adding a variable to be returned to the templates, so I think merging into master is sufficient, but let me know if you think differently! I really hate Java and first PR contributing to this repo so looking for any and all feedback to follow standards/conventions. Any deviation from standards/conventions is not intentional so please lmk.

PR checklist

Read the contribution guidelines.
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.
Run the following to build the project and update samples:
```
./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
```
(For Windows users, please run the script in WSL)
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.
File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04) @joscha (2024/10)

NiltiakSivad · 2025-05-30T18:45:26Z

bin/configs/typescript-axios-aws-iam.yaml

+templateDir: modules/openapi-generator/src/main/resources/typescript-axios
+additionalProperties:
+  npmVersion: 1.0.0
+  npmName: '@openapitools/typescript-axios-with-aws-iam'


This is my setup, but let me know if you think I should add a specific combination

NiltiakSivad · 2025-05-30T18:46:04Z

modules/openapi-generator/src/main/resources/typescript-axios/package.mustache

  },
  "dependencies": {
-    "axios": "{{axiosVersion}}"
+    "axios": "{{axiosVersion}}"{{#withAWSV4Signature}},


Can remove this before merge but wanted to show it working with a conditional

NiltiakSivad · 2025-05-30T19:12:34Z

modules/openapi-generator/src/test/resources/3_0/typescript-axios/with-aws-iam.yaml

+  version: 1.0.0
+  description: Test API for AWS IAM authentication detection
+servers:
+  - url: https://abc123.execute-api.us-east-1.amazonaws.com/prod


can you add comments to each pattern so its still clear after the PR is merged?

Totally! Added

NiltiakSivad · 2025-05-30T19:12:51Z

modules/openapi-generator/src/test/resources/3_0/typescript-axios/with-aws-iam.yaml

+      type: apiKey
+      name: Authorization
+      in: header
+      x-amazon-apigateway-authtype: awsSigv4


NiltiakSivad · 2025-05-30T19:19:16Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenSecurity.java

    // isHttpSignature is to support HTTP signature authorization scheme.
    // https://datatracker.ietf.org/doc/draft-cavage-http-signatures/
-    public Boolean isBasicBasic, isBasicBearer, isHttpSignature;
+    public Boolean isBasicBasic, isBasicBearer, isHttpSignature, isAWSV4Signature;


Surprised this wasn't already here given AWS IAM is supported in the go generator? Anticipating some feedback 👂

NiltiakSivad · 2025-05-30T19:20:39Z

modules/openapi-generator/src/test/resources/3_0/typescript-axios/with-aws-iam.yaml

+servers:
+  - url: https://abc123.execute-api.us-east-1.amazonaws.com/prod
+security:
+  - iam: []


Pattern 2, which reflects on line 64, 16, 30, 51

NiltiakSivad · 2025-05-30T19:24:20Z

samples/client/petstore/typescript-axios/builds/with-aws-iam/client/default-api.ts

+            const localVarQueryParameter = {} as any;
+
+            // authentication iam required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)


In the next PR this would be replaced with something that returns the signed AWS headers

NiltiakSivad · 2025-06-03T19:20:07Z

Rebased against master to capture latest updates

NiltiakSivad · 2025-06-09T13:07:48Z

Hey @wing328 @jimschubert @cbornet @jmini @etherealjoy, apologies to tag you here, but looking for a PR review. Did I not tag the right people or follow the correct process?

macjohnny · 2025-06-17T14:55:33Z

modules/openapi-generator/src/test/resources/3_0/typescript-axios/with-aws-iam.yaml

+  version: 1.0.0
+  description: Test API for AWS IAM authentication detection
+servers:
+  - url: https://abc123.execute-api.us-east-1.amazonaws.com/prod


can you add comments to each pattern so its still clear after the PR is merged?

macjohnny · 2025-06-17T14:59:02Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenSecurity.java

        this.isBasic = original.isBasic;
        this.isBasicBasic = original.isBasicBasic;
        this.isHttpSignature = original.isHttpSignature;
+        this.isAWSV4Signature = original.isAWSV4Signature;


is this only used in the test or also in the template?

This will be used in the template to dynamically generate different code.

I figured stopping at the detection of using AWS Auth was a good way to separate out for smaller PRs for earlier feedback since what I have here in this PR doesn't break anything and only expands functionality

macjohnny · 2025-06-17T15:01:18Z

...generator/src/main/java/org/openapitools/codegen/languages/TypeScriptAxiosClientCodegen.java

    }

+    @Override
+    public void preprocessOpenAPI(OpenAPI openAPI) {


i would suggest to move it to the core, since its not typescript-specific, right?
also, i don't understand where the withAWSV4Signature is used in the template?

@macjohnny Thanks for your review! It isn't used in the templates yet, I was saving that for a Part 2 in an effort to keep the PR small and to collect feedback early. However, in package.mustache I made a small modification to show that the variable is being passed.

By moving to "core" do you mean modifying the DefaultCodegen or making changes to the openapi-generator-core module?

agreed with johnny suggestion to move it to the "core" : https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java#L5623-L5718

also agreed with your reply to do it in another PR instead to keep this PR small for easier review

NiltiakSivad · 2025-06-20T19:13:49Z

...rc/test/java/org/openapitools/codegen/typescript/axios/TypeScriptAxiosClientCodegenTest.java

+
+    @Test
+    public void testDetectsAwsIamAuthenticationWithNaming() {
+        OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/typescript-axios/with-aws-iam.yaml");


This test is technically the same as the above at the moment. I wanted to see if others felt good about the 3 different detection mechanisms. I can split the example out into multiple so that all 3 patterns are not found in 1 file, and each can be tested in isolation without the potential for a false positive.

NiltiakSivad mentioned this pull request May 30, 2025

[typescript-axios] Add support for AWSv4 Signature #18215

Closed

5 tasks

NiltiakSivad commented May 30, 2025

View reviewed changes

NiltiakSivad force-pushed the typescript-axios-detect-iam-auth branch from 9028339 to 621588e Compare May 30, 2025 18:53

NiltiakSivad mentioned this pull request May 30, 2025

[REQ] Support for withAWSV4Signature in TypeScript Axios Generator #7034

Open

NiltiakSivad force-pushed the typescript-axios-detect-iam-auth branch from 621588e to f9c7ce4 Compare May 30, 2025 19:12

NiltiakSivad commented May 30, 2025

View reviewed changes

NiltiakSivad changed the title ~~[typescript-axios] Add detection for AWS IAM~~ [typescript-axios] Add detection for AWS IAM from schema May 30, 2025

NiltiakSivad commented May 30, 2025

View reviewed changes

OpenAPITools deleted a comment May 31, 2025

NiltiakSivad added 2 commits June 3, 2025 13:19

Detect AWS IAM Auth by looking for common patterns

cc2a444

Add sample demonstrating passed withAwsSignature variable works

910a15d

NiltiakSivad force-pushed the typescript-axios-detect-iam-auth branch from f9c7ce4 to 910a15d Compare June 3, 2025 19:19

macjohnny reviewed Jun 17, 2025

View reviewed changes

Add comments to yaml example file calling out the patterns

d145b9e

NiltiakSivad force-pushed the typescript-axios-detect-iam-auth branch from c95d147 to d145b9e Compare June 20, 2025 18:55

NiltiakSivad commented Jun 20, 2025

View reviewed changes

Uh oh!

Conversation

NiltiakSivad commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Previous Efforts

Summary

Deployment

PR checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NiltiakSivad May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NiltiakSivad May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NiltiakSivad May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NiltiakSivad commented Jun 3, 2025

Uh oh!

NiltiakSivad commented Jun 9, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NiltiakSivad Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

NiltiakSivad commented May 30, 2025 •

edited

Loading

NiltiakSivad May 30, 2025 •

edited

Loading

NiltiakSivad May 30, 2025 •

edited

Loading

NiltiakSivad May 30, 2025 •

edited

Loading

NiltiakSivad Jun 20, 2025 •

edited

Loading