feat: Organizations Api Uptake for twilio-csharp and support for bearer token/ no token authentication #595

AsabuHere · 2024-07-23T03:24:32Z

Fixes

A short description of what this PR does.

Checklist

If you have questions, please create a GitHub Issue in this repository.

sonarqubecloud · 2024-07-23T03:27:00Z

Quality Gate passed for 'twilio-oai-generator-java'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

sbansla · 2024-09-16T11:22:43Z

src/main/java/com/twilio/oai/api/CsharpApiResourceBuilder.java

@@ -62,6 +66,13 @@ public IApiResourceBuilder setImports(DirectoryStructureService directoryStructu
                metaAPIProperties.put("array-exists-options", true);
            }
        });
+
+        if(this.authMethod == "BearerToken"){
+            metaAPIProperties.put("auth_method-bearer-token", true);


Authmethod can be basic and bearer token. We need to handle that as well.

sbansla · 2024-09-16T11:23:19Z

src/main/java/com/twilio/oai/api/CsharpApiResourceBuilder.java

@@ -62,6 +66,13 @@ public IApiResourceBuilder setImports(DirectoryStructureService directoryStructu
                metaAPIProperties.put("array-exists-options", true);
            }
        });
+
+        if(this.authMethod == "BearerToken"){


Store'BearerToken' in enum and refer from there

sbansla · 2024-09-16T11:29:18Z

src/main/java/com/twilio/oai/api/CsharpApiResourceBuilder.java

+
+    public void processAuthMethods(List<CodegenOperation> opList) {
+        if(opList != null){
+            List<CodegenSecurity> authMethods = opList.get(0).authMethods;


We have to decide rest client on operation not on group of operations.

sbansla · 2024-09-16T11:30:22Z

src/main/java/com/twilio/oai/api/CsharpApiResourceBuilder.java

+            if(authMethods != null){
+                for(CodegenSecurity c : authMethods){
+                    if(c.isOAuth == true){
+                        this.authMethod = "BearerToken";


public apis will have basic and token based authentication, We don't want to re-write this code again for OAuth for public APIs.

If Oauth is added to public(Non Orgs) APIs, This code will break existing public APIs by modifying its rest client.
This code should not break existing written code if OAuth is added to public APIs.

sbansla · 2024-09-16T11:55:19Z

src/main/java/com/twilio/oai/api/CsharpApiResourceBuilder.java

@@ -175,7 +203,7 @@ public ApiResourceBuilder updateResponseModel(Resolver<CodegenProperty> codegenP
                    modelName = response.baseType;
                }
                Optional<CodegenModel> responseModel = Utility.getModel(allModels, modelName, recordKey, codegenOperation);
-                if (responseModel.isEmpty()) {
+                if ((responseModel == null) || responseModel.isEmpty() || (Integer.parseInt(response.code) >= 400)) {


We discussed before that, all twilio APIs uses common exception models and Orgs API follows the same exception model.
Exception Model: https://www.twilio.com/docs/usage/twilios-response#response-formats-exceptions
(Athira has tested that this exception model is used by Orgs API as well)
So we can ignore all error models from generating.

I will think about it and we can re-visit it later.

sbansla · 2024-09-16T12:06:08Z

src/main/java/com/twilio/oai/common/Utility.java

@@ -118,7 +118,7 @@ public Optional<CodegenModel> getModel(final List<CodegenModel> models,
                .map(CodegenProperty::getComplexType)
                .map(classname -> getModelByClassname(models, classname))
                .findFirst()
-                .orElseThrow();
+                .orElse(null);


Why we are changing to orElse(null) ?

sbansla · 2024-09-16T12:09:44Z

src/main/java/com/twilio/oai/resolver/csharp/CsharpCodegenModelDataTypeResolver.java

-                ? Utility.removeEnumName(property.complexType) + ApplicationConstants.ENUM 
+        if(property.complexType != null){
+            property.enumName = property.complexType.contains("Enum") || property.complexType.contains("enum")
+                ? Utility.removeEnumName(property.complexType) + ApplicationConstants.ENUM


Check if it is not breaking existing code.
Also test if an Enum defined as referenced and is used at multiple places as a property or property and parameter.
For Example:
Enum is defined under component.schema
component.schema.UpdateStatusEnum

And above enum is referenced at 2 or more places.

sbansla · 2024-09-16T12:10:59Z

src/main/resources/twilio-csharp/Pagination.mustache

        {
-            client = client ?? TwilioClient.GetRestClient();
+            client = client ?? Twilio{{domainClassPrefix}}Client.Get{{restClientClassName}}RestClient();


Use similar to {{clientName}}

sbansla · 2024-09-16T12:12:42Z

src/main/resources/twilio-csharp/Pagination.mustache


-            var request = new Request(
+            var request = new {{requestName}}Request(


Do we need to have different request model ?
What if we use AuthStrategy class as discussed.
AuthStrategy can have child classes which will handle different types of Authentication mechanism
For Example
BasicAuthStrategy, TokenAuthStrategy, NoAuthStrategy.

# Fixes # In twilio-node, read operation does not handle required query params correctly, see [here](https://github.com/twilio/twilio-oai-generator/blob/main/src/main/resources/twilio-node/api-single.mustache#L139). Till now, the existing APIs do not have such use case, but now some APIs are trying to pass required query params. This needs to be supported in twilio-node. ### Checklist - [x] I acknowledge that all my contributions will be made under the project's license - [ ] Run `make test-docker` - [ ] Verify affected language: - [ ] Generate [twilio-go](https://github.com/twilio/twilio-go) from our [OpenAPI specification](https://github.com/twilio/twilio-oai) using the [build_twilio_go.py](./examples/build_twilio_go.py) using `python examples/build_twilio_go.py path/to/twilio-oai/spec/yaml path/to/twilio-go` and inspect the diff - [ ] Run `make test` in `twilio-go` - [ ] Create a pull request in `twilio-go` - [ ] Provide a link below to the pull request - [ ] I have made a material change to the repo (functionality, testing, spelling, grammar) - [ ] I have read the [Contribution Guidelines](https://github.com/twilio/twilio-oai-generator/blob/main/CONTRIBUTING.md) and my PR follows them - [ ] I have titled the PR appropriately - [ ] I have updated my branch with the main branch - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have added the necessary documentation about the functionality in the appropriate .md file - [ ] I have added inline documentation to the code I modified If you have questions, please create a GitHub Issue in this repository.

# Fixes # In python, the instancePathParams were not being used to initialize response models in constructors. So removing those unused params.

# Fixes # Removing local file paths ### Checklist - [x] I acknowledge that all my contributions will be made under the project's license - [ ] Run `make test-docker` - [ ] Verify affected language: - [ ] Generate [twilio-go](https://github.com/twilio/twilio-go) from our [OpenAPI specification](https://github.com/twilio/twilio-oai) using the [build_twilio_go.py](./examples/build_twilio_go.py) using `python examples/build_twilio_go.py path/to/twilio-oai/spec/yaml path/to/twilio-go` and inspect the diff - [ ] Run `make test` in `twilio-go` - [ ] Create a pull request in `twilio-go` - [ ] Provide a link below to the pull request - [ ] I have made a material change to the repo (functionality, testing, spelling, grammar) - [ ] I have read the [Contribution Guidelines](https://github.com/twilio/twilio-oai-generator/blob/main/CONTRIBUTING.md) and my PR follows them - [ ] I have titled the PR appropriately - [ ] I have updated my branch with the main branch - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have added the necessary documentation about the functionality in the appropriate .md file - [ ] I have added inline documentation to the code I modified If you have questions, please create a GitHub Issue in this repository.

Removing run_openapi_generator from for loop which was causing too much delay with pipelines

…file as versionless (#606)

# Fixes # Added a null check for content_v1 file before removing it. ### Checklist - [x] I acknowledge that all my contributions will be made under the project's license - [ ] Run `make test-docker` - [ ] Verify affected language: - [ ] Generate [twilio-go](https://github.com/twilio/twilio-go) from our [OpenAPI specification](https://github.com/twilio/twilio-oai) using the [build_twilio_go.py](./examples/build_twilio_go.py) using `python examples/build_twilio_go.py path/to/twilio-oai/spec/yaml path/to/twilio-go` and inspect the diff - [ ] Run `make test` in `twilio-go` - [ ] Create a pull request in `twilio-go` - [ ] Provide a link below to the pull request - [ ] I have made a material change to the repo (functionality, testing, spelling, grammar) - [ ] I have read the [Contribution Guidelines](https://github.com/twilio/twilio-oai-generator/blob/main/CONTRIBUTING.md) and my PR follows them - [ ] I have titled the PR appropriately - [ ] I have updated my branch with the main branch - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have added the necessary documentation about the functionality in the appropriate .md file - [ ] I have added inline documentation to the code I modified If you have questions, please create a GitHub Issue in this repository.

fixed contentType for twilio-java

sonarqubecloud · 2024-09-23T13:00:59Z

Quality Gate passed for 'twilio-oai-generator-php'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

sonarqubecloud · 2024-09-23T13:01:19Z

Quality Gate passed for 'twilio-oai-generator-java'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

sonarqubecloud · 2024-09-23T13:01:43Z

Quality Gate passed for 'twilio-oai-generator-python'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

sonarqubecloud · 2024-09-23T13:01:53Z

Quality Gate passed for 'twilio-oai-generator-node'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

AsabuHere added 6 commits July 23, 2024 08:40

orgs api uptake for twilio csharp

35d2736

orgs api uptake for twilio csharp

29f595e

orgs api uptake for twilio csharp

c6f0eea

orgs api uptake for twilio csharp

0541dc7

orgs api uptake for twilio csharp

c4eee19

orgs api uptake for twilio csharp

d4e7086

AsabuHere requested a review from sbansla July 23, 2024 03:24

AsabuHere requested a review from tiwarishubham635 August 23, 2024 04:42

AsabuHere added 5 commits September 4, 2024 17:13

remove null pointer exceptions for error objects

d0e0933

renaming TwilioBearerToken client to TwilioOrgsToken client

3bfe21d

renaming request classes

b3eeb87

renaming resourcset

55364db

Renaming rest clients in mustache files

622f931

sbansla reviewed Sep 16, 2024

View reviewed changes

AsabuHere and others added 7 commits September 17, 2024 10:44

moving constant references to enum file

e3bc20b

renamed mustache configurations for domain class name

a53ecc6

Renaming rest client get method in mustache files

0441b5c

Changes to auth method handler

21325de

chore: removing unused params from python model constructor (#597)

20af68b

# Fixes # In python, the instancePathParams were not being used to initialize response models in constructors. So removing those unused params.

manisha1997 and others added 21 commits September 23, 2024 15:52

chore: librarian time check (#594)

b9f4793

Removing run_openapi_generator from for loop which was causing too much delay with pipelines

chore: fixing nullable attributes (#591)

c1416ef

chore: revert changes (#603)

ec82cc3

chore: ignore content_v1 spec for release and iam_organizations spec …

6f7372b

…file as versionless (#606)

chore: setting contentType correctly in java (#608)

457304d

fixed contentType for twilio-java

chore: skipping isOverridden flag in distinctResponseModels (#611)

bbe6473

resolving merge conflicts

6508649

orgs api uptake for twilio csharp

b9176c3

orgs api uptake for twilio csharp

80b24aa

orgs api uptake for twilio csharp

6ddab76

Merge branch 'main' into csharp_orgs_api_uptake

1afdc1b

resolving conflicts

7bc8f1e

auth method processing changes

b3929d2

removing unwanted changes

98b9f19

excluding other languages from generation

a9dbbd4

test files

918725d

test files

4e2c9e1

test files

11af9e5

test files

f97bec6

test files

6147a38

sbansla approved these changes Sep 24, 2024

View reviewed changes

AsabuHere merged commit c483d12 into main Sep 24, 2024
16 of 20 checks passed

AsabuHere deleted the csharp_orgs_api_uptake branch September 24, 2024 05:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Organizations Api Uptake for twilio-csharp and support for bearer token/ no token authentication #595

feat: Organizations Api Uptake for twilio-csharp and support for bearer token/ no token authentication #595

AsabuHere commented Jul 23, 2024

sonarqubecloud bot commented Jul 23, 2024

sbansla Sep 16, 2024

sbansla Sep 16, 2024

sbansla Sep 16, 2024

sbansla Sep 16, 2024

sbansla Sep 16, 2024 •

edited

Loading

sbansla Sep 16, 2024

sbansla Sep 16, 2024

sbansla Sep 16, 2024

sbansla Sep 16, 2024 •

edited

Loading

sbansla Sep 16, 2024

sbansla Sep 16, 2024

sonarqubecloud bot commented Sep 23, 2024

sonarqubecloud bot commented Sep 23, 2024

sonarqubecloud bot commented Sep 23, 2024

sonarqubecloud bot commented Sep 23, 2024


		var request = new Request(
		var request = new {{requestName}}Request(

feat: Organizations Api Uptake for twilio-csharp and support for bearer token/ no token authentication #595

feat: Organizations Api Uptake for twilio-csharp and support for bearer token/ no token authentication #595

Conversation

AsabuHere commented Jul 23, 2024

Fixes

Checklist

sonarqubecloud bot commented Jul 23, 2024

Quality Gate passed for 'twilio-oai-generator-java'

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbansla Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbansla Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Sep 23, 2024

Quality Gate passed for 'twilio-oai-generator-php'

sonarqubecloud bot commented Sep 23, 2024

Quality Gate passed for 'twilio-oai-generator-java'

sonarqubecloud bot commented Sep 23, 2024

Quality Gate passed for 'twilio-oai-generator-python'

sonarqubecloud bot commented Sep 23, 2024

Quality Gate passed for 'twilio-oai-generator-node'

sbansla Sep 16, 2024 •

edited

Loading

sbansla Sep 16, 2024 •

edited

Loading