Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[cpprestsdk] Implement Enum inside Objects #19919

Merged
merged 5 commits into from
Dec 4, 2024

Conversation

SaverioCode
Copy link
Contributor

@SaverioCode SaverioCode commented Oct 19, 2024

[#8937 #958(actually already closed)]
I added the support for enum type inside objects. They can be stand alone or inside vectors. Set of enums doesn't compile in favor of vectors(if necessary can be supported, if you think that set of enums are useful). Map with enums will be as before.

Other then the yaml/json from the issues I used:

{
  "openapi": "3.0.0",
  "info": {
    "title": "Enum Class Example",
    "version": "1.0.0"
  },
  "components": {
    "schemas": {
      "MyClass": {
        "type": "object",
        "properties": {
          "status": {
            	"type": "string",
		"enum": ["ACTIVE", "INACTIVE", "PENDING"]
          },
	  "test1": {
	  	"type": "array",
		"items": {
			"type": "string",
			"enum": ["available", "pending"],
			"default": "available"
		}	
	  },
	  "test2": {
		"type": "string"
	   },
	   "myMap2": {
	   	"type": "object",
		"propertyNames": {
			"type": "integer"
		},
		"additionalProperties": {
			"type": "string",
			"enum": ["PRIMO", "SECONDO", "TERZO"]
		}
	   },
	   "myMap3": {
		"type": "object",
		"propertyNames": {
			"type": "string"
		},
		"additionalProperties": {
			"type": "array",
			"items": {
				"type": "string",
				"enum": ["ARR_1", "ARR_2", "ARR_3"]
			}
		}
	   },
	   "myMap4": {
		"type": "object",
		"propertyNames": {
			"type": "string",
			"enum": ["MAP3_1", "MAP3_2", "MAP3_3"]
		},
		"additionalProperties": {
			"type": "string"
		}
	   },
	  "numVar": {
		"type": "integer",
		"format": "int32"
	  }
        }
      }
    }
  }
}

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 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    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.

@ravinikam @stkrwork @etherealjoy @MartinDelille @muttleyxd

… methods inside openapi-generator/modules/openapi-generator/src/main/resources/cpp-rest-sdk-client/modelbase-header.mustache, have also be added two missing body of methods definitions
@SaverioCode SaverioCode changed the title [cpprestsdk] Implement Enum inside Objects [cpprestsdk] Fix #8937 Implement Enum inside Objects Oct 21, 2024
@SaverioCode SaverioCode changed the title [cpprestsdk] Fix #8937 Implement Enum inside Objects [cpprestsdk] Implement Enum inside Objects Oct 21, 2024
@wing328
Copy link
Member

wing328 commented Nov 9, 2024

can you please add a test or 2 in modules/openapi-generator/src/test/resources/3_0/cpp-restsdk/petstore.yaml to test the change?

@wing328
Copy link
Member

wing328 commented Dec 4, 2024

let's give it a try. i will file a PR later to improve the code format a bit.

thanks for the PR

@wing328 wing328 merged commit 0183620 into OpenAPITools:master Dec 4, 2024
16 checks passed
@wing328 wing328 mentioned this pull request Dec 4, 2024
5 tasks
@SaverioCode
Copy link
Contributor Author

@wing328

Sorry but I have been very busy these weeks.

Thanks for taking care of code enhancement!

  1. For the test should I open another PR?
  2. I also wanted to propose a little improvement for debug purpose. To enclose in a try and catch block the single attributes converted from the json to the appropriate class, with fromJson. This because several times can happen that an error is raised but the message is generic and doesn't refer to any particular field. This of course make debugging complex.

@wing328
Copy link
Member

wing328 commented Dec 4, 2024

For the test should I open another PR?

yes please

I also wanted to propose a little improvement for debug purpose

yes please open a separate PR for easier review

thanks again for your contributions

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants