feat: [OpenAPI] Exclusion of paths and properties #745

newtork · 2025-03-04T09:49:49Z

Context

https://github.com/SAP/ai-sdk-java-backlog/issues/171

Enable Exclusion of Paths and Properties.

Demo for new feature toggles:

chore: [OpenAI] use code generation ai-sdk-java#370

Feature scope:

Usage:

<plugin>
  <groupId>com.sap.cloud.sdk.datamodel</groupId>
  <artifactId>openapi-generator-maven-plugin</artifactId>
  <configuration>
    <additionalProperties>
    
      <!-- new: exclude paths -->
      <excludePaths>
          /deployments/{deployment-id}/completions
          /deployments/{deployment-id}/audio/transcriptions
          /deployments/{deployment-id}/audio/translations
          /deployments/{deployment-id}/images/generations
      </excludePaths>
    
      <!-- new: exclude properties -->
      <excludeProperties>
          chatCompletionResponseMessage.context
          createChatCompletionRequest.data_sources
      </excludeProperties>
    
      <!-- new: remove unassigned components -->
      <removeUnusedComponents>true</removeUnusedComponents>
    </additionalProperties>
  </configuration>
</plugin>

New generator customizations to exclude paths, to exclude parameters and to remove unused schema components

Definition of Done

Functionality scope stated & covered
Tests cover the scope above
~~Error handling created / updated & covered by the tests above~~
~~Documentation updated~~
~~Release notes updated~~

…elGeneratorIntegrationTest/openai-2024-10-21/output/com/sap/cloud/sdk/services/openai/api/DefaultApi.java

…d/sdk/datamodel/openapi/generator/DataModelGeneratorIntegrationTest.java

…f-bigdecimal-list # Conflicts: # datamodel/openapi/openapi-generator/src/main/java/com/sap/cloud/sdk/datamodel/openapi/generator/GenerationConfigurationConverter.java # datamodel/openapi/openapi-generator/src/main/java/com/sap/cloud/sdk/datamodel/openapi/generator/GeneratorCustomProperties.java # datamodel/openapi/openapi-generator/src/test/java/com/sap/cloud/sdk/datamodel/openapi/generator/DataModelGeneratorIntegrationTest.java # datamodel/openapi/openapi-generator/src/test/resources/DataModelGeneratorIntegrationTest/api-class-for-ai-sdk/output/com/sap/cloud/sdk/services/builder/model/Soda.java

…l-list' into float-array-instead-of-bigdecimal-list

Co-authored-by: Roshin Rajan Panackal <[email protected]>

…ation # Conflicts: # datamodel/openapi/openapi-generator/src/main/java/com/sap/cloud/sdk/datamodel/openapi/generator/CustomJavaClientCodegen.java # datamodel/openapi/openapi-generator/src/main/java/com/sap/cloud/sdk/datamodel/openapi/generator/GeneratorCustomProperties.java

…ation

CharlesDuboisSAP

Can I see this code in action in a unit test?

...r/src/main/java/com/sap/cloud/sdk/datamodel/openapi/generator/GeneratorCustomProperties.java

Jonas-Isr

Only very minor comment

...tor/src/main/java/com/sap/cloud/sdk/datamodel/openapi/generator/CustomJavaClientCodegen.java

Please find the additional test for the three new feature toggles

dc7f90c

…ation

CharlesDuboisSAP · 2025-03-12T07:34:12Z

...tor/src/main/java/com/sap/cloud/sdk/datamodel/openapi/generator/CustomJavaClientCodegen.java

+            removed |= remove.test(s);
+
+            // check for allOf, anyOf, oneOf
+            for( final List<Schema> list : Arrays.asList(s.getAllOf(), s.getAnyOf(), s.getOneOf()) ) {


How could you pass an opportunity for recursion? (the while)
Also the allOf case is not tested.

How could you pass an opportunity for recursion? (the while)

Recursion is a poisoned fruit. Looks nice on the outside, but makes you sick when problems appear.

Also the allOf case is not tested.

I added a test case: 2bf64ff -> f7da471

a-d and others added 23 commits February 25, 2025 17:07

Test with

7077014

Revert changes

5e50752

Add fix

592a389

Add test

0076de5

Format

ed8532a

Fix PMD

5f8c291

Fix merge

947ee19

Delete datamodel/openapi/openapi-generator/src/test/resources/DataMod…

54fb0b3

…elGeneratorIntegrationTest/openai-2024-10-21/output/com/sap/cloud/sdk/services/openai/api/DefaultApi.java

Update datamodel/openapi/openapi-generator/src/test/java/com/sap/clou…

9f8eb8a

…d/sdk/datamodel/openapi/generator/DataModelGeneratorIntegrationTest.java

Merge

a7dd05f

Merge remote-tracking branch 'origin/float-array-instead-of-bigdecima…

4b51e58

…l-list' into float-array-instead-of-bigdecimal-list

Adapting equals and hashcode generation for float[] (#737)

2b502a1

Co-authored-by: Roshin Rajan Panackal <[email protected]>

Move out the custom gen feature login

d27fa30

change access to package private

9966ed8

service loader pattern, visitor like pattern

fd64019

PoC

c6ea658

Refine chained strategy pattern

693f5d0

Fix naming; add Javadoc

15919d9

Fix log level

83276ee

Fix merge; Move files

2b2ad23

Fix PMD, re-order methods

1fb0561

newtork changed the title ~~feat: [OpenAPI] Exclusion of paths and properties~~ feat: [OpenAPI] Refactor customizations and add Exclusion of paths and properties Mar 4, 2025

a-d added 2 commits March 4, 2025 11:30

Minor format improvement

9118f7e

Fix checkstyle

a912116

newtork mentioned this pull request Mar 4, 2025

chore: [OpenAI] use code generation SAP/ai-sdk-java#370

Merged

10 tasks

Fix PMD

231f62b

newtork added please merge Request to merge a pull request please review Request to review a pull request labels Mar 10, 2025

a-d added 3 commits March 10, 2025 11:20

Merge remote-tracking branch 'origin/main' into openapi/partial-gener…

85bdc58

…ation

Revert refactoring

2cb2e39

Fix PMD

a72b09d

newtork changed the title ~~feat: [OpenAPI] Refactor customizations and add Exclusion of paths and properties~~ feat: [OpenAPI] Exclusion of paths and properties Mar 10, 2025

CharlesDuboisSAP previously requested changes Mar 11, 2025

View reviewed changes

...r/src/main/java/com/sap/cloud/sdk/datamodel/openapi/generator/GeneratorCustomProperties.java Outdated Show resolved Hide resolved

Jonas-Isr reviewed Mar 11, 2025

View reviewed changes

...tor/src/main/java/com/sap/cloud/sdk/datamodel/openapi/generator/CustomJavaClientCodegen.java Outdated Show resolved Hide resolved

a-d added 5 commits March 11, 2025 15:15

Employ feedback

d354645

Fix case of missing schema when attempting to remove property

4c24133

Add test case BEFORE

3f591b1

Update test case AFTER

dc7f90c

Format

791c124

a-d added 2 commits March 11, 2025 16:08

Add comments; Minor code style improvement

9124c26

Merge remote-tracking branch 'origin/main' into openapi/partial-gener…

72d8343

…ation

CharlesDuboisSAP reviewed Mar 12, 2025

View reviewed changes

a-d added 4 commits March 12, 2025 11:15

Null check, minor simplification

3ecafe3

Add test case BEFORE

2bf64ff

Add test case AFTER

f7da471

Fix assertion

68f86d6

CharlesDuboisSAP approved these changes Mar 12, 2025

View reviewed changes

newtork merged commit ce30d56 into main Mar 12, 2025
14 checks passed

newtork deleted the openapi/partial-generation branch March 12, 2025 12:25

newtork mentioned this pull request Mar 14, 2025

[OpenAPI Generator] Enable allow-list for API and Model classes newtork/cloud-sdk-java#3

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: [OpenAPI] Exclusion of paths and properties #745

feat: [OpenAPI] Exclusion of paths and properties #745

Uh oh!

newtork commented Mar 4, 2025 •

edited

Loading

Uh oh!

CharlesDuboisSAP left a comment

Uh oh!

Uh oh!

Jonas-Isr left a comment

Uh oh!

Uh oh!

CharlesDuboisSAP Mar 12, 2025 •

edited

Loading

Uh oh!

newtork Mar 12, 2025

Uh oh!

Uh oh!

Uh oh!

feat: [OpenAPI] Exclusion of paths and properties #745

feat: [OpenAPI] Exclusion of paths and properties #745

Uh oh!

Conversation

newtork commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Feature scope:

Definition of Done

Uh oh!

CharlesDuboisSAP left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Jonas-Isr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

CharlesDuboisSAP Mar 12, 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!

newtork Mar 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

newtork commented Mar 4, 2025 •

edited

Loading

CharlesDuboisSAP Mar 12, 2025 •

edited

Loading