[C][Client] Support a custom data type (IntOrString) #11074
Conversation
Looks like this should be described as |
|
@ityuhui would it be possible for you to provide the whole API file?? As wing328 said, it will be oneOf parameter. I have local copy of Generator which I have modified to support oneOf in C. But as they are modifying lot of core I haven't pushed the PR yet. But if it works, then may be you can help me to complete the PR and add this as a supported feature to codegen. |
|
Thank you @wing328 and @zhemant The complete swagger file is https://raw.githubusercontent.com/kubernetes-client/java/master/kubernetes/swagger.json I think the version of Kubernetes API swagger is v2.0 |
|
@ityuhui I created api's with the following YAML file: openapi: 3.0.0
servers:
- url: 'http://petstore.swagger.io/v2'
info:
version: 1.0.0
title: OpenAPI Petstore
paths:
/pet:
post:
tags:
- pet
summary: Add a new pet to the store
operationId: addPet
responses:
'200':
description: successful operation
'405':
description: Invalid input
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
components:
schemas:
Pet:
title: Pet Order
description: An order for a pets from the pet store
type: object
properties:
id:
type: integer
format: int64
petId:
$ref: '#/components/schemas/Pet1'
Pet1:
oneOf:
- type: integer
- type: stringI was able to generate a pet1 model with following struct: typedef struct openapi_petstore_pet1_t {
int _int; // number - _int
char *_char; // string - _char -
} openapi_petstore_pet1_t;I am working on fixing json creation in parent object: // openapi_petstore_pet->pet_id
if (openapi_petstore_pet->pet_id) {
cJSON *pet_id_local_JSON = openapi_petstore_pet1_convertToJSON( openapi_petstore_pet->pet_id);
if (pet_id_local_JSON == NULL) {
goto end; // model
}
cJSON_AddItemToObject(item, "petId", pet_id_local_JSON);
}As of now the function cJSON *
openapi_petstore_pet1_convertToJSON(openapi_petstore_pet1_t *openapi_petstore_pet1)
{
cJSON *item = cJSON_CreateObject();
if (!openapi_petstore_pet1) {
goto end;
}
// openapi_petstore_pet1->_int
if ((openapi_petstore_pet1->_int && openapi_petstore_pet1->_int)) {
if (cJSON_AddNumberToObject(item, "_int", openapi_petstore_pet1->_int) == NULL) {
goto end; // Numeric
}
}
// openapi_petstore_pet1->_char
if (openapi_petstore_pet1->_char) {
if (cJSON_AddStringToObject(item, "_char", openapi_petstore_pet1->_char) == NULL) {
goto end; // String
}
}
return item;I want to modify it to generate a function like this when its oneof: cJSON *
openapi_petstore_pet1_convertToJSON(phoenix_mem_t *mem_pool, openapi_petstore_pet1_t *openapi_petstore_pet1)
{
cJSON *item = NULL;
if (!openapi_petstore_pet1) {
goto end;
}
// openapi_petstore_pet1->_int
if ((openapi_petstore_pet1->_int && openapi_petstore_pet1->_int)) {
item = cJSON_AddNumberToObject(openapi_petstore_pet1->_int)
}
// openapi_petstore_pet1->_char
if (openapi_petstore_pet1->_char) {
item = cJSON_CreateString(openapi_petstore_pet1->_char)
}
return item;The problem with C is that data is mandatory not like other language where we just have to declare variable. So to achieve this we will have to add flag to set Let me know if you are looking for something similar then may be we can connect and try to figure out a way to fix this problem. |
|
Hi @zhemant I created the source files for "IntOrString" by manal https://github.com/ityuhui/c/blob/yh-int-or-string-1129/kubernetes/model/int_or_string.h I think below struct is reasonable for oneOf typedef enum {
IOS_DATA_TYPE_INT = 1,
IOS_DATA_TYPE_STRING = 2
} ios_data_type_t;
typedef struct int_or_string_t {
ios_data_type_t type;
union {
int i;
char *s;
};
} int_or_string_t;I admit "oneOf" should be handled by c generator automatically. But for my case(kubernetes open API spec), the OpenAPI version is 2.0, so I need the change of this PR which does not conflict with your implementation for Open API v3.0 |
|
@ityuhui understood that kubernetes spec is still v2.0 and there's no concrete plan to upgrade to v3.x at the moment. What about working around the issue in the C client generator to "redefine" Usually we don't tailor-made a solution for a custom format in the project itself but we can give it a try in this case as Kubernetes C client is probably one of the most important use cases out there. |
|
Hi @wing328 Almost all other Kubernetes clients (e.g. Java, CSharp, Javascript) use the same method of this PR to handle For the |
|
OK. Thanks for the explanation. Let's go with this change to start with. Later if @zhemant or anyone can come up with better implementation of oneOf/anyOf, we can always consider that as a replacement to this workaround. |
|
Thank you @wing328 |
There is a custom data type from Kubernetes swagger specification:
And the model log (-DdebugModels) of openapi-generator-cli shows:
So this is a data type with below attributes:
I add the support for this data type in C generator.
BTW: The header and implementation files of the custom data type cannot be provided by this PR because they need to be implemented by users themselves.
Hi @wing328 @zhemant @michelealbano
Could you please reivew this code change ? Thanks !
PR checklist
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*.For Windows users, please run the script in Git BASH.
master(5.3.0),6.0.x