You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We just found that our JavaScript docs being created by Swagger are incorrect. Our API takes variables like "grant_type" in the POST body. However, the SDK docs tell the user to use "grantType". We see that the Javascript CodeGen camelizes all the variables for the documentation, which confuses the dev reading the documentation.
GrantRequestClient:
type: objectproperties:
grant_type:
type: stringdefault: client_credentialsdescription: The type of access token you are requesting.client_id:
type: stringdescription: The value given within the BlueJeans Enterprise Administration console.client_secret:
type: stringdescription: The value given within the BlueJeans Enterprise Administration console.required:
- grant_type
- client_id
- client_secret
@brandonfuller Similar to Typescript, we can add an option to use the "original" name of the variable:
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
Would you have time to add this feature to the JavaScript generator? If yes, I can show you some good starting points.
I suggest that, it should be "original" by default. This is because a software should not impose naming convention (opinion). Because we had fallen into the same problem (even after the issue was solve in 2018) and solved it by searching the issues. If it would original by default then this problem would not have occurred again even after fix.
Description
We just found that our JavaScript docs being created by Swagger are incorrect. Our API takes variables like "grant_type" in the POST body. However, the SDK docs tell the user to use "grantType". We see that the Javascript CodeGen camelizes all the variables for the documentation, which confuses the dev reading the documentation.
Here is a sample documentation page:
https://github.com/bluejeans/api-rest-onvideo/blob/master/libs/javascript/docs/GrantRequestClient.md
Swagger-codegen version
2.2.3. Looks to have always been this way.
Swagger declaration file content or url
Command line used for generation
java -jar swagger-codegen-cli.jar generate -i ../swagger.yaml -l javascript -o ../libs/javascript --config config.javascript.json
Config just contains:
{
"moduleName":"X",
"projectName":"Y",
"projectDescription":"Z",
"projectLicenseName":"MIT",
"gitUserId":"A",
"gitRepoId":"B#npm-repo"
}
Steps to reproduce
Related issues/PRs
Suggest a fix/enhancement
Can we stop camelizing variables in the docs that should not be modified?
The text was updated successfully, but these errors were encountered: