diff --git a/404.html b/404.html index 3a9a9433c19..3fa74426004 100644 --- a/404.html +++ b/404.html @@ -15,13 +15,13 @@ - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/assets/js/b6a32428.1fa00187.js b/assets/js/b6a32428.53e34af9.js similarity index 98% rename from assets/js/b6a32428.1fa00187.js rename to assets/js/b6a32428.53e34af9.js index a1e152ae2c3..4d6c496ffaa 100644 --- a/assets/js/b6a32428.1fa00187.js +++ b/assets/js/b6a32428.53e34af9.js @@ -1 +1 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[7e3],{3905:function(e,t,n){n.d(t,{Zo:function(){return m},kt:function(){return g}});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=a.createContext({}),s=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},m=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,p=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),u=s(n),c=o,g=u["".concat(p,".").concat(c)]||u[c]||d[c]||r;return n?a.createElement(g,i(i({ref:t},m),{},{components:n})):a.createElement(g,i({ref:t},m))}));function g(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=c;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[u]="string"==typeof e?e:o,i[1]=l;for(var s=2;s\n org.openapitools\n openapi-generator-maven-plugin\n ${openapi-generator-version}\n \n \n generate-client-code\n \n generate\n \n \n my-codegen\n \x3c!-- other configuration ... --\x3e\n \n \n \n \n \n org.openapitools\n my-codegen-openapi-generator\n 1.0.0\n \n \n\n")),(0,r.kt)("p",null,"If you publish your artifact to a distant maven repository, do not forget to add this repository as ",(0,r.kt)("inlineCode",{parentName:"p"},"pluginRepository")," for your project."),(0,r.kt)("h2",{id:"selective-generation"},"Selective generation"),(0,r.kt)("p",null,"You may not want to generate ",(0,r.kt)("em",{parentName:"p"},"all")," models in your project. Likewise, you may want just one or two apis to be written. If that's the case, you can use system properties or ",(0,r.kt)("a",{parentName:"p",href:"/docs/globals"},"global properties")," to control the output."),(0,r.kt)("p",null,"The default is to generate ",(0,r.kt)("em",{parentName:"p"},"everything")," supported by the specific library. Once you enable a feature, it will restrict the contents generated:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"# generate only models\n--global-property models\n\n# generate only apis\n--global-property apis\n\n# generate only supporting files\n--global-property supportingFiles\n\n# generate models and supporting files\n--global-property models,supportingFiles\n")),(0,r.kt)("p",null,"To control the specific files being generated, you can pass a CSV list of what you want:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},'# generate the User and Pet models only\n--global-property models="User:Pet"\n\n# generate the User model and the supportingFile `StringUtil.java`:\n--global-property models=User,supportingFiles=StringUtil.java\n')),(0,r.kt)("p",null,"To control generation of docs and tests for api and models, pass false to the option. For api, these options are ",(0,r.kt)("inlineCode",{parentName:"p"},"--global-property apiTests=false,apiDocs=false"),". For models, ",(0,r.kt)("inlineCode",{parentName:"p"},"--global-property modelTests=false,modelDocs=false"),".\nThese options default to true and don't limit the generation of the feature options listed above (like ",(0,r.kt)("inlineCode",{parentName:"p"},"--global-property api"),"):"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},'# generate only models (with tests and documentation)\n--global-property models\n\n# generate only models (with tests but no documentation)\n--global-property models,modelDocs=false\n\n# generate only User and Pet models (no tests and no documentation)\n--global-property models="User:Pet",modelTests=false\n\n# generate only apis (without tests)\n--global-property apis,apiTests=false\n\n# generate only apis (modelTests option is ignored)\n--global-property apis,modelTests=false\n')),(0,r.kt)("p",null,"When using selective generation, ",(0,r.kt)("em",{parentName:"p"},"only")," the templates needed for the specific generation will be used."),(0,r.kt)("p",null,'To skip models defined as the form parameters in "requestBody", please use ',(0,r.kt)("inlineCode",{parentName:"p"},"skipFormModel")," (default to ",(0,r.kt)("inlineCode",{parentName:"p"},"true"),") (this option is introduced at v3.2.2 and ",(0,r.kt)("inlineCode",{parentName:"p"},"true")," by default starting from v5.0.0)."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"--global-property skipFormModel=true\n")),(0,r.kt)("p",null,"This option will be helpful to skip model generation due to the form parameter, which is defined differently in OAS3 as there's no form parameter in OAS3"),(0,r.kt)("h2",{id:"ignore-file-format"},"Ignore file format"),(0,r.kt)("p",null,"OpenAPI Generator supports a ",(0,r.kt)("inlineCode",{parentName:"p"},".openapi-generator-ignore")," file, similar to ",(0,r.kt)("inlineCode",{parentName:"p"},".gitignore")," or ",(0,r.kt)("inlineCode",{parentName:"p"},".dockerignore")," you're probably already familiar with."),(0,r.kt)("p",null,"The ignore file allows for better control over overwriting existing files than the ",(0,r.kt)("inlineCode",{parentName:"p"},"--skip-overwrite")," flag. With the ignore file, you can specify individual files or directories can be ignored. This can be useful, for example if you only want a subset of the generated code."),(0,r.kt)("p",null,"Examples:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"# OpenAPI Generator Ignore\n# Lines beginning with a # are comments\n\n# This should match build.sh located anywhere.\nbuild.sh\n\n# Matches build.sh in the root\n/build.sh\n\n# Exclude all recursively\ndocs/**\n\n# Explicitly allow files excluded by other rules\n!docs/UserApi.md\n\n# Recursively exclude directories named Api\n# You can't negate files below this directory.\nsrc/**/Api/\n\n# When this file is nested under /Api (excluded above),\n# this rule is ignored because parent directory is excluded by previous rule.\n!src/**/PetApiTests.cs\n\n# Exclude a single, nested file explicitly\nsrc/Org.OpenAPITools.Test/Model/AnimalFarmTests.cs\n")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},".openapi-generator-ignore")," file must exist in the root of the output directory."),(0,r.kt)("p",null,"Upon first code generation, you may also pass the CLI option ",(0,r.kt)("inlineCode",{parentName:"p"},"--ignore-file-override=/path/to/ignore_file")," for greater control over generated outputs. Note that this is a complete override, and will override the ",(0,r.kt)("inlineCode",{parentName:"p"},".openapi-generator-ignore")," file in an output directory when regenerating code."),(0,r.kt)("p",null,"Editor support for ",(0,r.kt)("inlineCode",{parentName:"p"},".openapi-generator-ignore")," files is available in IntelliJ via the ",(0,r.kt)("a",{parentName:"p",href:"https://plugins.jetbrains.com/plugin/7495--ignore"},".ignore plugin"),"."),(0,r.kt)("p",null,"One may want to pre-populate ",(0,r.kt)("inlineCode",{parentName:"p"},".openapi-generator-ignore")," with a list of entries during the code generation process and the global/general option ",(0,r.kt)("inlineCode",{parentName:"p"},"openapiGeneatorIgnoreList")," (e.g. --openapi-generator-ignore-list in CLI) can do exactly that. For example,"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},'java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g spring -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/spring --additional-properties useTags=true --openapi-generator-ignore-list "README.md,pom.xml,docs/*.md,src/main/java/org/openapitools/model/*"\n')),(0,r.kt)("h2",{id:"customizing-the-generator"},"Customizing the generator"),(0,r.kt)("p",null,"There are different aspects of customizing the code generator beyond just creating or modifying templates. Each language has a supporting configuration file to handle different type mappings, etc:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"$ ls -1 modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/\nAbstractJavaJAXRSServerCodegen.java\nAbstractTypeScriptClientCodegen.java\n... (results omitted)\nTypeScriptAngularClientCodegen.java\nTypeScriptNodeClientCodegen.java\n")),(0,r.kt)("p",null,"Each of these files creates reasonable defaults so you can get running quickly. But if you want to configure package names, prefixes, model folders, etc. you can use a json config file to pass the values."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \\\n -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml \\\n -g java \\\n -o samples/client/petstore/java \\\n -c path/to/config.json\n")),(0,r.kt)("p",null,"and ",(0,r.kt)("inlineCode",{parentName:"p"},"config.json")," contains the following as an example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'{\n "apiPackage" : "petstore"\n}\n')),(0,r.kt)("p",null,"You can use also ",(0,r.kt)("inlineCode",{parentName:"p"},"config.yml")," with following equivalent example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},'apiPackage: "petstore"\n')),(0,r.kt)("p",null,"Another example of config file can be found in ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/sampleConfig.json"},"modules/openapi-generator/src/test/resources/sampleConfig.json")),(0,r.kt)("p",null,"Supported config options can be different per language. Running ",(0,r.kt)("inlineCode",{parentName:"p"},"config-help -g {lang}")," will show available options.\n",(0,r.kt)("strong",{parentName:"p"},"These options are applied via configuration file (e.g. config.json or config.yml) or by passing them with ",(0,r.kt)("inlineCode",{parentName:"strong"},"-p {optionName}={optionValue}")),". (If ",(0,r.kt)("inlineCode",{parentName:"p"},"-p {optionName}")," does not work, please open a ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/openapitools/openapi-generator/issues/new"},"ticket")," and we'll look into it)"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar config-help -g java\n")),(0,r.kt)("p",null,"Output"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"CONFIG OPTIONS\n modelPackage\n package for generated models\n\n apiPackage\n package for generated api classes\n...... (results omitted)\n library\n library template (sub-template) to use:\n jersey2 - HTTP client: Jersey client 2.6\n feign - HTTP client: Netflix Feign 8.1.1. JSON processing: Jackson 2.6.3\n okhttp-gson (default) - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1\n retrofit - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1 (Retrofit 1.9.0)\n retrofit2 - HTTP client: OkHttp 2.5.0. JSON processing: Gson 2.4 (Retrofit 2.0.0-beta2)\n google-api-client - HTTP client: google-api-client 1.23.0. JSON processing: Jackson 2.8.9\n rest-assured - HTTP client: rest-assured : 4.3.0. JSON processing: Gson 2.8.6. Only for Java8\n")),(0,r.kt)("p",null,"Your config file for Java can look like"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'{\n "groupId":"com.my.company",\n "artifactId":"MyClient",\n "artifactVersion":"1.2.0",\n "library":"feign"\n}\n')),(0,r.kt)("p",null,"Or if you prefer yaml format it can look like"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},'groupId: "com.my.company"\nartifactId: "MyClient"\nartifactVersion: "1.2.0"\nlibrary: "feign"\n')),(0,r.kt)("p",null,"For all the unspecified options default values will be used."),(0,r.kt)("p",null,"Another way to override default options is to extend the config class for the specific language.\nTo change, for example, the prefix for the Objective-C generated files, simply subclass the ",(0,r.kt)("inlineCode",{parentName:"p"},"ObjcClientCodegen.java"),":"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-java"},'package com.mycompany.openapitools.codegen;\n\nimport org.openapitools.codegen.languages.*;\n\npublic class MyObjcCodegen extends ObjcClientCodegen {\n static {\n PREFIX = "HELLO";\n }\n}\n')),(0,r.kt)("p",null,"and specify the ",(0,r.kt)("inlineCode",{parentName:"p"},"classname")," when running the generator:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"-g com.mycompany.openapitools.codegen.MyObjcCodegen\n")),(0,r.kt)("p",null,"Your subclass will now be loaded and overrides the ",(0,r.kt)("inlineCode",{parentName:"p"},"PREFIX")," value in the superclass."),(0,r.kt)("h2",{id:"bringing-your-own-models"},"Bringing your own models"),(0,r.kt)("p",null,"Sometimes you don't want a model generated. In this case, you can simply specify an import mapping to tell\nthe codegen what ",(0,r.kt)("em",{parentName:"p"},"not")," to create. When doing this, every location that references a specific model will\nrefer back to your classes. Note, this may not apply to all languages..."),(0,r.kt)("p",null,"To specify an import mapping, use the ",(0,r.kt)("inlineCode",{parentName:"p"},"--import-mappings")," argument and specify the model-to-import logic as such:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"--import-mappings Pet=my.models.MyPet\n")),(0,r.kt)("p",null,"Or for multiple mappings:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"--import-mappings Pet=my.models.MyPet,Order=my.models.MyOrder\n")),(0,r.kt)("p",null,"or"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"--import-mappings Pet=my.models.MyPet --import-mappings Order=my.models.MyOrder\n")),(0,r.kt)("h2",{id:"name-mapping"},"Name Mapping"),(0,r.kt)("p",null,"One can map the property name using ",(0,r.kt)("inlineCode",{parentName:"p"},"nameMappings")," option and parameter name using ",(0,r.kt)("inlineCode",{parentName:"p"},"parameterNameMappings")," option to something else. Consider the following schema:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"}," PropertyNameCollision:\n properties:\n _type:\n type: string\n type:\n type: string\n type_:\n type: string\n type: object\n")),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"_type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type_")," will result in property name collision in the Java client generator for example. We can resolve the issue using ",(0,r.kt)("inlineCode",{parentName:"p"},"nameMappings")," by mapping ",(0,r.kt)("inlineCode",{parentName:"p"},"_type")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"underscoreType"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type_")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"typeWithUnderscore"),"."),(0,r.kt)("p",null,"Here is an example to use ",(0,r.kt)("inlineCode",{parentName:"p"},"nameMappings")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"parameterNameMapping")," in CLI:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/java/petstore-with-fake-endpoints-models-for-testing-okhttp-gson.yaml -o /tmp/java2/ --name-mappings _type=underscoreType,type_=typeWithUnderscore, --parameter-name-mappings _type=paramType,type_=typeParam\n")),(0,r.kt)("p",null,"To map model names, use ",(0,r.kt)("inlineCode",{parentName:"p"},"modelNameMappings")," option, e.g."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g csharp -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/csharp/ --model-name-mappings Tag=Label\n")),(0,r.kt)("p",null,"will rename the ",(0,r.kt)("inlineCode",{parentName:"p"},"Tag")," schema to ",(0,r.kt)("inlineCode",{parentName:"p"},"Label")," instead."),(0,r.kt)("p",null,"To map enum names, use ",(0,r.kt)("inlineCode",{parentName:"p"},"enumNameMappings")," option, e.g."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java/ --enum-name-mappings sold=UNAVAILABLE\n")),(0,r.kt)("p",null,"will rename SOLD to UNAVAILABLE instead."),(0,r.kt)("p",null,"Not all generators support thess features yet. Please give it a try to confirm the behaviour and open an issue (ticket) to let us know which generators you would like to have this feature enabled and we'll prioritize accordingly. We also welcome PRs to add these features to generators. Related PRs for reference: #16209, #16234 (modelNameMappings), #16194, #16206 (nameMappings, parameterNameMappings), #17108 (enumNameMappings)."),(0,r.kt)("p",null,"NOTE: some generators use ",(0,r.kt)("inlineCode",{parentName:"p"},"baseName")," (original name obtained direclty from OpenAPI spec, e.g. ",(0,r.kt)("inlineCode",{parentName:"p"},"shipping-date"),") mustache tag in the templates so the mapping feature won't work."),(0,r.kt)("p",null,"To map ",(0,r.kt)("inlineCode",{parentName:"p"},"operationId")," (used in method naming) to something else, use ",(0,r.kt)("inlineCode",{parentName:"p"},"operationIdNameMappings")," option, e.g."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java/ --operation-id-name-mappings getPetById=returnPetById\n")),(0,r.kt)("p",null,"will name the API method as ",(0,r.kt)("inlineCode",{parentName:"p"},"returnPetById")," instead of ",(0,r.kt)("inlineCode",{parentName:"p"},"getPetById")," obtained from OpenAPI doc/spec."),(0,r.kt)("h2",{id:"schema-mapping"},"Schema Mapping"),(0,r.kt)("p",null,"One can map the schema to something else (e.g. external objects/models outside of the package) using the ",(0,r.kt)("inlineCode",{parentName:"p"},"schemaMappings")," option, e.g. in CLI"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/type-alias.yaml -o /tmp/java2/ --schema-mappings TypeAlias=foo.bar.TypeAlias\n")),(0,r.kt)("p",null,"Another example (in conjunction with --type-mappings):"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i /tmp/alias.yaml -o /tmp/alias/ --schema-mappings stream=org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody --type-mappings string+binary=stream\n")),(0,r.kt)("p",null,"while /tmp/alias.yaml is as follows:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},"openapi: 3.0.3\ninfo:\n title: Demo app\n version: 1.0.0\nservers:\n - url: /api/v1\npaths:\n /demo:\n get:\n summary: Demo\n operationId: demo\n responses:\n '200':\n description: Demo response\n content:\n text/csv:\n schema:\n type: string\n format: binary\n")),(0,r.kt)("h2",{id:"inline-schema-naming"},"Inline Schema Naming"),(0,r.kt)("p",null,"Inline schemas are created as separate schemas automatically and the auto-generated schema name may not look good to everyone. One can customize the name using the ",(0,r.kt)("inlineCode",{parentName:"p"},"title")," field or the ",(0,r.kt)("inlineCode",{parentName:"p"},"inlineSchemaNameMapping")," option. For exmaple, run the following,"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/inline_model_resolver.yaml -o /tmp/java3/ --skip-validate-spec --inline-schema-name-mappings inline_object_2=SomethingMapped,inline_object_4=nothing_new\n")),(0,r.kt)("p",null,"will show the following in the console:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"[main] INFO o.o.codegen.InlineModelResolver - Inline schema created as arbitraryObjectRequestBodyProperty_request. To have complete control of the model name, set the `title` field or use the inlineSchemaNameMapping option (--inline-schema-name-mappings in CLI).\n[main] INFO o.o.codegen.InlineModelResolver - Inline schema created as meta_200_response. To have complete control of the model name, set the `title` field or use the inlineSchemaNameMapping option (--inline-schema-name-mappings in CLI).\n")),(0,r.kt)("p",null,"For example, to name the inline schema ",(0,r.kt)("inlineCode",{parentName:"p"},"meta_200_response")," as ",(0,r.kt)("inlineCode",{parentName:"p"},"MetaObject"),", use the ",(0,r.kt)("inlineCode",{parentName:"p"},"--inline-schema-name-mappings")," option as follows:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/inline_model_resolver.yaml -o /tmp/java3/ --skip-validate-spec --inline-schema-name-mappings meta_200_response=MetaObject,arbitraryObjectRequestBodyProperty_request=ArbitraryRequest\n")),(0,r.kt)("p",null,"Another useful option is ",(0,r.kt)("inlineCode",{parentName:"p"},"inlineSchemaOptions"),", which allows you to customize how inline schemas are handled or named"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"--inline-schema-options ARRAY_ITEM_SUFFIX=_array_item,MAP_ITEM_SUFFIX=_map_item,RESOLVE_INLINE_ENUMS=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ARRAY_ITEM_SUFFIX")," sets the array item suffix"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"MAP_ITEM_SUFFIX")," set the map item suffix"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SKIP_SCHEMA_REUSE=true")," is a special value to skip reusing inline schemas during refactoring"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"REFACTOR_ALLOF_INLINE_SCHEMAS=true")," will restore the 6.x (or below) behaviour to refactor allOf inline schemas into $ref. (v7.0.0 will skip the refactoring of these allOf inline schmeas by default)"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"RESOLVE_INLINE_ENUMS=true")," will refactor inline enum definitions into $ref")),(0,r.kt)("h2",{id:"openapi-normalizer"},"OpenAPI Normalizer"),(0,r.kt)("p",null,"OpenAPI Normalizer transforms the input OpenAPI doc/spec (which may not perfectly conform to the specification) to make it workable with OpenAPI Generator. A few rules are switched on by default since 7.0.0 release:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"SIMPLIFY_ONEOF_ANYOF "),(0,r.kt)("li",{parentName:"ul"},"SIMPLIFY_BOOLEAN_ENUM")),(0,r.kt)("p",null,"(One can use ",(0,r.kt)("inlineCode",{parentName:"p"},"DISABLE_ALL=true")," to disable all the rules)"),(0,r.kt)("p",null,"Here is a list of rules supported:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"REF_AS_PARENT_IN_ALLOF"),": when set to ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", child schemas in ",(0,r.kt)("inlineCode",{parentName:"li"},"allOf")," is considered a parent if it's a ",(0,r.kt)("inlineCode",{parentName:"li"},"$ref")," (instead of inline schema).")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/allOf_extension_parent.yaml -o /tmp/java-okhttp/ --openapi-normalizer REF_AS_PARENT_IN_ALLOF=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"REMOVE_ANYOF_ONEOF_AND_KEEP_PROPERTIES_ONLY"),": when set to ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", oneOf/anyOf schema with only required properies only in a schema with properties will be removed. ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/removeAnyOfOneOfAndKeepPropertiesOnly_test.yaml"},"(example)"))),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/removeAnyOfOneOfAndKeepPropertiesOnly_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer REMOVE_ANYOF_ONEOF_AND_KEEP_PROPERTIES_ONLY=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SIMPLIFY_ANYOF_STRING_AND_ENUM_STRING"),": when set to ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", simplify anyOf schema with string and enum of string to just ",(0,r.kt)("inlineCode",{parentName:"li"},"string"))),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/simplifyAnyOfStringAndEnumString_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SIMPLIFY_ANYOF_STRING_AND_ENUM_STRING=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SIMPLIFY_BOOLEAN_ENUM"),": when set to ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", convert boolean enum to just enum.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/simplifyBooleanEnum_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SIMPLIFY_BOOLEAN_ENUM=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SIMPLIFY_ONEOF_ANYOF"),": when set to ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", simplify oneOf/anyOf by 1) removing null (sub-schema) or enum of null (sub-schema) and setting nullable to true instead, and 2) simplifying oneOf/anyOf with a single sub-schema to just the sub-schema itself.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/simplifyOneOfAnyOf_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SIMPLIFY_ONEOF_ANYOF=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"KEEP_ONLY_FIRST_TAG_IN_OPERATION"),": when set to ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", only keep the first tag in operation if there are more than one tag defined.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/enableKeepOnlyFirstTagInOperation_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer KEEP_ONLY_FIRST_TAG_IN_OPERATION=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SET_TAGS_FOR_ALL_OPERATIONS"),": when set to a string value, tags in all operations will reset to the string value provided.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/enableKeepOnlyFirstTagInOperation_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_TAGS_FOR_ALL_OPERATIONS=another_tag_name\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SET_TAGS_TO_OPERATIONID"),': when set to true, tags in all operations will be set to operationId or "default" if operationId is empty')),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_TAGS_TO_OPERATIONID=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ADD_UNSIGNED_TO_INTEGER_WITH_INVALID_MAX_VALUE"),": when set to true, auto fix integer with maximum value 4294967295 (2^32-1) or long with 18446744073709551615 (2^64-1) by adding x-unsigned to the schema")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/addUnsignedToIntegerWithInvalidMaxValue_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer ADD_UNSIGNED_TO_INTEGER_WITH_INVALID_MAX_VALUE=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"REFACTOR_ALLOF_WITH_PROPERTIES_ONLY"),": When set to true, refactor schema with allOf and properties in the same level to a schema with allOf only and, the allOf contains a new schema containing the properties in the top level.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/allOf_extension_parent.yaml -o /tmp/java-okhttp/ --openapi-normalizer REFACTOR_ALLOF_WITH_PROPERTIES_ONLY=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"REMOVE_X_INTERNAL"),": Set to true if you want to disable the default behavior of removing/hiding the x-internal in operations and model")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/enableKeepOnlyFirstTagInOperation_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer REMOVE_X_INTERNAL=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"FILTER"),": When set to ",(0,r.kt)("inlineCode",{parentName:"li"},"operationId:addPet|getPetById")," for example, it will add ",(0,r.kt)("inlineCode",{parentName:"li"},"x-internal:true")," to operations with operationId not equal to addPet/getPetById (which will have x-internal set to false) so that these operations marked as internal won't be generated.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},'java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer FILTER="operationId:addPet|getPetById"\n')),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SET_CONTAINER_TO_NULLABLE"),": When set to ",(0,r.kt)("inlineCode",{parentName:"li"},"array|set|map")," (or just ",(0,r.kt)("inlineCode",{parentName:"li"},"array"),") for example, it will set ",(0,r.kt)("inlineCode",{parentName:"li"},"nullable")," in array, set and map to true.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},'java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_CONTAINER_TO_NULLABLE="array|map"\n')),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SET_PRIMITIVE_TYPES_TO_NULLABLE"),": When set to ",(0,r.kt)("inlineCode",{parentName:"li"},"string|integer|number|boolean")," (or just ",(0,r.kt)("inlineCode",{parentName:"li"},"string"),") for example, it will set the type to ",(0,r.kt)("inlineCode",{parentName:"li"},"nullable")," (nullable: true)")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},'java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_PRIMITIVE_TYPES_TO_NULLABLE="integer|number"\n')))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[7e3],{3905:function(e,t,n){n.d(t,{Zo:function(){return m},kt:function(){return g}});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=a.createContext({}),s=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},m=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,p=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),u=s(n),c=o,g=u["".concat(p,".").concat(c)]||u[c]||d[c]||r;return n?a.createElement(g,i(i({ref:t},m),{},{components:n})):a.createElement(g,i({ref:t},m))}));function g(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=c;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[u]="string"==typeof e?e:o,i[1]=l;for(var s=2;s\n org.openapitools\n openapi-generator-maven-plugin\n ${openapi-generator-version}\n \n \n generate-client-code\n \n generate\n \n \n my-codegen\n \x3c!-- other configuration ... --\x3e\n \n \n \n \n \n org.openapitools\n my-codegen-openapi-generator\n 1.0.0\n \n \n\n")),(0,r.kt)("p",null,"If you publish your artifact to a distant maven repository, do not forget to add this repository as ",(0,r.kt)("inlineCode",{parentName:"p"},"pluginRepository")," for your project."),(0,r.kt)("h2",{id:"selective-generation"},"Selective generation"),(0,r.kt)("p",null,"You may not want to generate ",(0,r.kt)("em",{parentName:"p"},"all")," models in your project. Likewise, you may want just one or two apis to be written. If that's the case, you can use system properties or ",(0,r.kt)("a",{parentName:"p",href:"/docs/globals"},"global properties")," to control the output."),(0,r.kt)("p",null,"The default is to generate ",(0,r.kt)("em",{parentName:"p"},"everything")," supported by the specific library. Once you enable a feature, it will restrict the contents generated:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"# generate only models\n--global-property models\n\n# generate only apis\n--global-property apis\n\n# generate only supporting files\n--global-property supportingFiles\n\n# generate models and supporting files\n--global-property models,supportingFiles\n")),(0,r.kt)("p",null,"To control the specific files being generated, you can pass a CSV list of what you want:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},'# generate the User and Pet models only\n--global-property models="User:Pet"\n\n# generate the User model and the supportingFile `StringUtil.java`:\n--global-property models=User,supportingFiles=StringUtil.java\n')),(0,r.kt)("p",null,"To control generation of docs and tests for api and models, pass false to the option. For api, these options are ",(0,r.kt)("inlineCode",{parentName:"p"},"--global-property apiTests=false,apiDocs=false"),". For models, ",(0,r.kt)("inlineCode",{parentName:"p"},"--global-property modelTests=false,modelDocs=false"),".\nThese options default to true and don't limit the generation of the feature options listed above (like ",(0,r.kt)("inlineCode",{parentName:"p"},"--global-property api"),"):"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},'# generate only models (with tests and documentation)\n--global-property models\n\n# generate only models (with tests but no documentation)\n--global-property models,modelDocs=false\n\n# generate only User and Pet models (no tests and no documentation)\n--global-property models="User:Pet",modelTests=false\n\n# generate only apis (without tests)\n--global-property apis,apiTests=false\n\n# generate only apis (modelTests option is ignored)\n--global-property apis,modelTests=false\n')),(0,r.kt)("p",null,"When using selective generation, ",(0,r.kt)("em",{parentName:"p"},"only")," the templates needed for the specific generation will be used."),(0,r.kt)("p",null,'To skip models defined as the form parameters in "requestBody", please use ',(0,r.kt)("inlineCode",{parentName:"p"},"skipFormModel")," (default to ",(0,r.kt)("inlineCode",{parentName:"p"},"true"),") (this option is introduced at v3.2.2 and ",(0,r.kt)("inlineCode",{parentName:"p"},"true")," by default starting from v5.0.0)."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"--global-property skipFormModel=true\n")),(0,r.kt)("p",null,"This option will be helpful to skip model generation due to the form parameter, which is defined differently in OAS3 as there's no form parameter in OAS3"),(0,r.kt)("h2",{id:"ignore-file-format"},"Ignore file format"),(0,r.kt)("p",null,"OpenAPI Generator supports a ",(0,r.kt)("inlineCode",{parentName:"p"},".openapi-generator-ignore")," file, similar to ",(0,r.kt)("inlineCode",{parentName:"p"},".gitignore")," or ",(0,r.kt)("inlineCode",{parentName:"p"},".dockerignore")," you're probably already familiar with."),(0,r.kt)("p",null,"The ignore file allows for better control over overwriting existing files than the ",(0,r.kt)("inlineCode",{parentName:"p"},"--skip-overwrite")," flag. With the ignore file, you can specify individual files or directories can be ignored. This can be useful, for example if you only want a subset of the generated code."),(0,r.kt)("p",null,"Examples:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"# OpenAPI Generator Ignore\n# Lines beginning with a # are comments\n\n# This should match build.sh located anywhere.\nbuild.sh\n\n# Matches build.sh in the root\n/build.sh\n\n# Exclude all recursively\ndocs/**\n\n# Explicitly allow files excluded by other rules\n!docs/UserApi.md\n\n# Recursively exclude directories named Api\n# You can't negate files below this directory.\nsrc/**/Api/\n\n# When this file is nested under /Api (excluded above),\n# this rule is ignored because parent directory is excluded by previous rule.\n!src/**/PetApiTests.cs\n\n# Exclude a single, nested file explicitly\nsrc/Org.OpenAPITools.Test/Model/AnimalFarmTests.cs\n")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},".openapi-generator-ignore")," file must exist in the root of the output directory."),(0,r.kt)("p",null,"Upon first code generation, you may also pass the CLI option ",(0,r.kt)("inlineCode",{parentName:"p"},"--ignore-file-override=/path/to/ignore_file")," for greater control over generated outputs. Note that this is a complete override, and will override the ",(0,r.kt)("inlineCode",{parentName:"p"},".openapi-generator-ignore")," file in an output directory when regenerating code."),(0,r.kt)("p",null,"Editor support for ",(0,r.kt)("inlineCode",{parentName:"p"},".openapi-generator-ignore")," files is available in IntelliJ via the ",(0,r.kt)("a",{parentName:"p",href:"https://plugins.jetbrains.com/plugin/7495--ignore"},".ignore plugin"),"."),(0,r.kt)("p",null,"One may want to pre-populate ",(0,r.kt)("inlineCode",{parentName:"p"},".openapi-generator-ignore")," with a list of entries during the code generation process and the global/general option ",(0,r.kt)("inlineCode",{parentName:"p"},"openapiGeneatorIgnoreList")," (e.g. --openapi-generator-ignore-list in CLI) can do exactly that. For example,"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},'java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g spring -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/spring --additional-properties useTags=true --openapi-generator-ignore-list "README.md,pom.xml,docs/*.md,src/main/java/org/openapitools/model/*"\n')),(0,r.kt)("h2",{id:"customizing-the-generator"},"Customizing the generator"),(0,r.kt)("p",null,"There are different aspects of customizing the code generator beyond just creating or modifying templates. Each language has a supporting configuration file to handle different type mappings, etc:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"$ ls -1 modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/\nAbstractJavaJAXRSServerCodegen.java\nAbstractTypeScriptClientCodegen.java\n... (results omitted)\nTypeScriptAngularClientCodegen.java\nTypeScriptNodeClientCodegen.java\n")),(0,r.kt)("p",null,"Each of these files creates reasonable defaults so you can get running quickly. But if you want to configure package names, prefixes, model folders, etc. you can use a json config file to pass the values."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \\\n -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml \\\n -g java \\\n -o samples/client/petstore/java \\\n -c path/to/config.json\n")),(0,r.kt)("p",null,"and ",(0,r.kt)("inlineCode",{parentName:"p"},"config.json")," contains the following as an example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'{\n "apiPackage" : "petstore"\n}\n')),(0,r.kt)("p",null,"You can use also ",(0,r.kt)("inlineCode",{parentName:"p"},"config.yml")," with following equivalent example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},'apiPackage: "petstore"\n')),(0,r.kt)("p",null,"Another example of config file can be found in ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/sampleConfig.json"},"modules/openapi-generator/src/test/resources/sampleConfig.json")),(0,r.kt)("p",null,"Supported config options can be different per language. Running ",(0,r.kt)("inlineCode",{parentName:"p"},"config-help -g {lang}")," will show available options.\n",(0,r.kt)("strong",{parentName:"p"},"These options are applied via configuration file (e.g. config.json or config.yml) or by passing them with ",(0,r.kt)("inlineCode",{parentName:"strong"},"-p {optionName}={optionValue}")),". (If ",(0,r.kt)("inlineCode",{parentName:"p"},"-p {optionName}")," does not work, please open a ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/openapitools/openapi-generator/issues/new"},"ticket")," and we'll look into it)"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar config-help -g java\n")),(0,r.kt)("p",null,"Output"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"CONFIG OPTIONS\n modelPackage\n package for generated models\n\n apiPackage\n package for generated api classes\n...... (results omitted)\n library\n library template (sub-template) to use:\n jersey2 - HTTP client: Jersey client 2.6\n feign - HTTP client: Netflix Feign 8.1.1. JSON processing: Jackson 2.6.3\n okhttp-gson (default) - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1\n retrofit - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1 (Retrofit 1.9.0)\n retrofit2 - HTTP client: OkHttp 2.5.0. JSON processing: Gson 2.4 (Retrofit 2.0.0-beta2)\n google-api-client - HTTP client: google-api-client 1.23.0. JSON processing: Jackson 2.8.9\n rest-assured - HTTP client: rest-assured : 4.3.0. JSON processing: Gson 2.8.6. Only for Java8\n")),(0,r.kt)("p",null,"Your config file for Java can look like"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'{\n "groupId":"com.my.company",\n "artifactId":"MyClient",\n "artifactVersion":"1.2.0",\n "library":"feign"\n}\n')),(0,r.kt)("p",null,"Or if you prefer yaml format it can look like"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},'groupId: "com.my.company"\nartifactId: "MyClient"\nartifactVersion: "1.2.0"\nlibrary: "feign"\n')),(0,r.kt)("p",null,"For all the unspecified options default values will be used."),(0,r.kt)("p",null,"Another way to override default options is to extend the config class for the specific language.\nTo change, for example, the prefix for the Objective-C generated files, simply subclass the ",(0,r.kt)("inlineCode",{parentName:"p"},"ObjcClientCodegen.java"),":"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-java"},'package com.mycompany.openapitools.codegen;\n\nimport org.openapitools.codegen.languages.*;\n\npublic class MyObjcCodegen extends ObjcClientCodegen {\n static {\n PREFIX = "HELLO";\n }\n}\n')),(0,r.kt)("p",null,"and specify the ",(0,r.kt)("inlineCode",{parentName:"p"},"classname")," when running the generator:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"-g com.mycompany.openapitools.codegen.MyObjcCodegen\n")),(0,r.kt)("p",null,"Your subclass will now be loaded and overrides the ",(0,r.kt)("inlineCode",{parentName:"p"},"PREFIX")," value in the superclass."),(0,r.kt)("h2",{id:"bringing-your-own-models"},"Bringing your own models"),(0,r.kt)("p",null,"Sometimes you don't want a model generated. In this case, you can simply specify an import mapping to tell\nthe codegen what ",(0,r.kt)("em",{parentName:"p"},"not")," to create. When doing this, every location that references a specific model will\nrefer back to your classes. Note, this may not apply to all languages..."),(0,r.kt)("p",null,"To specify an import mapping, use the ",(0,r.kt)("inlineCode",{parentName:"p"},"--import-mappings")," argument and specify the model-to-import logic as such:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"--import-mappings Pet=my.models.MyPet\n")),(0,r.kt)("p",null,"Or for multiple mappings:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"--import-mappings Pet=my.models.MyPet,Order=my.models.MyOrder\n")),(0,r.kt)("p",null,"or"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"--import-mappings Pet=my.models.MyPet --import-mappings Order=my.models.MyOrder\n")),(0,r.kt)("h2",{id:"name-mapping"},"Name Mapping"),(0,r.kt)("p",null,"One can map the property name using ",(0,r.kt)("inlineCode",{parentName:"p"},"nameMappings")," option and parameter name using ",(0,r.kt)("inlineCode",{parentName:"p"},"parameterNameMappings")," option to something else. Consider the following schema:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"}," PropertyNameCollision:\n properties:\n _type:\n type: string\n type:\n type: string\n type_:\n type: string\n type: object\n")),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"_type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type_")," will result in property name collision in the Java client generator for example. We can resolve the issue using ",(0,r.kt)("inlineCode",{parentName:"p"},"nameMappings")," by mapping ",(0,r.kt)("inlineCode",{parentName:"p"},"_type")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"underscoreType"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type_")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"typeWithUnderscore"),"."),(0,r.kt)("p",null,"Here is an example to use ",(0,r.kt)("inlineCode",{parentName:"p"},"nameMappings")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"parameterNameMapping")," in CLI:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/java/petstore-with-fake-endpoints-models-for-testing-okhttp-gson.yaml -o /tmp/java2/ --name-mappings _type=underscoreType,type_=typeWithUnderscore, --parameter-name-mappings _type=paramType,type_=typeParam\n")),(0,r.kt)("p",null,"To map model names, use ",(0,r.kt)("inlineCode",{parentName:"p"},"modelNameMappings")," option, e.g."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g csharp -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/csharp/ --model-name-mappings Tag=Label\n")),(0,r.kt)("p",null,"will rename the ",(0,r.kt)("inlineCode",{parentName:"p"},"Tag")," schema to ",(0,r.kt)("inlineCode",{parentName:"p"},"Label")," instead."),(0,r.kt)("p",null,"To map enum names, use ",(0,r.kt)("inlineCode",{parentName:"p"},"enumNameMappings")," option, e.g."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java/ --enum-name-mappings sold=UNAVAILABLE\n")),(0,r.kt)("p",null,"will rename SOLD to UNAVAILABLE instead."),(0,r.kt)("p",null,"Not all generators support thess features yet. Please give it a try to confirm the behaviour and open an issue (ticket) to let us know which generators you would like to have this feature enabled and we'll prioritize accordingly. We also welcome PRs to add these features to generators. Related PRs for reference: #16209, #16234 (modelNameMappings), #16194, #16206 (nameMappings, parameterNameMappings), #17108 (enumNameMappings)."),(0,r.kt)("p",null,"NOTE: some generators use ",(0,r.kt)("inlineCode",{parentName:"p"},"baseName")," (original name obtained direclty from OpenAPI spec, e.g. ",(0,r.kt)("inlineCode",{parentName:"p"},"shipping-date"),") mustache tag in the templates so the mapping feature won't work."),(0,r.kt)("p",null,"To map ",(0,r.kt)("inlineCode",{parentName:"p"},"operationId")," (used in method naming) to something else, use ",(0,r.kt)("inlineCode",{parentName:"p"},"operationIdNameMappings")," option, e.g."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java/ --operation-id-name-mappings getPetById=returnPetById\n")),(0,r.kt)("p",null,"will name the API method as ",(0,r.kt)("inlineCode",{parentName:"p"},"returnPetById")," instead of ",(0,r.kt)("inlineCode",{parentName:"p"},"getPetById")," obtained from OpenAPI doc/spec."),(0,r.kt)("h2",{id:"schema-mapping"},"Schema Mapping"),(0,r.kt)("p",null,"One can map the schema to something else (e.g. external objects/models outside of the package) using the ",(0,r.kt)("inlineCode",{parentName:"p"},"schemaMappings")," option, e.g. in CLI"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/type-alias.yaml -o /tmp/java2/ --schema-mappings TypeAlias=foo.bar.TypeAlias\n")),(0,r.kt)("p",null,"Another example (in conjunction with --type-mappings):"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i /tmp/alias.yaml -o /tmp/alias/ --schema-mappings stream=org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody --type-mappings string+binary=stream\n")),(0,r.kt)("p",null,"while /tmp/alias.yaml is as follows:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},"openapi: 3.0.3\ninfo:\n title: Demo app\n version: 1.0.0\nservers:\n - url: /api/v1\npaths:\n /demo:\n get:\n summary: Demo\n operationId: demo\n responses:\n '200':\n description: Demo response\n content:\n text/csv:\n schema:\n type: string\n format: binary\n")),(0,r.kt)("h2",{id:"inline-schema-naming"},"Inline Schema Naming"),(0,r.kt)("p",null,"Inline schemas are created as separate schemas automatically and the auto-generated schema name may not look good to everyone. One can customize the name using the ",(0,r.kt)("inlineCode",{parentName:"p"},"title")," field or the ",(0,r.kt)("inlineCode",{parentName:"p"},"inlineSchemaNameMapping")," option. For exmaple, run the following,"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/inline_model_resolver.yaml -o /tmp/java3/ --skip-validate-spec --inline-schema-name-mappings inline_object_2=SomethingMapped,inline_object_4=nothing_new\n")),(0,r.kt)("p",null,"will show the following in the console:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"[main] INFO o.o.codegen.InlineModelResolver - Inline schema created as arbitraryObjectRequestBodyProperty_request. To have complete control of the model name, set the `title` field or use the inlineSchemaNameMapping option (--inline-schema-name-mappings in CLI).\n[main] INFO o.o.codegen.InlineModelResolver - Inline schema created as meta_200_response. To have complete control of the model name, set the `title` field or use the inlineSchemaNameMapping option (--inline-schema-name-mappings in CLI).\n")),(0,r.kt)("p",null,"For example, to name the inline schema ",(0,r.kt)("inlineCode",{parentName:"p"},"meta_200_response")," as ",(0,r.kt)("inlineCode",{parentName:"p"},"MetaObject"),", use the ",(0,r.kt)("inlineCode",{parentName:"p"},"--inline-schema-name-mappings")," option as follows:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/inline_model_resolver.yaml -o /tmp/java3/ --skip-validate-spec --inline-schema-name-mappings meta_200_response=MetaObject,arbitraryObjectRequestBodyProperty_request=ArbitraryRequest\n")),(0,r.kt)("p",null,"Another useful option is ",(0,r.kt)("inlineCode",{parentName:"p"},"inlineSchemaOptions"),", which allows you to customize how inline schemas are handled or named"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"--inline-schema-options ARRAY_ITEM_SUFFIX=_array_item,MAP_ITEM_SUFFIX=_map_item,RESOLVE_INLINE_ENUMS=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ARRAY_ITEM_SUFFIX")," sets the array item suffix"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"MAP_ITEM_SUFFIX")," set the map item suffix"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SKIP_SCHEMA_REUSE=true")," is a special value to skip reusing inline schemas during refactoring"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"REFACTOR_ALLOF_INLINE_SCHEMAS=true")," will restore the 6.x (or below) behaviour to refactor allOf inline schemas into $ref. (v7.0.0 will skip the refactoring of these allOf inline schmeas by default)"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"RESOLVE_INLINE_ENUMS=true")," will refactor inline enum definitions into $ref")),(0,r.kt)("h2",{id:"openapi-normalizer"},"OpenAPI Normalizer"),(0,r.kt)("p",null,"OpenAPI Normalizer transforms the input OpenAPI doc/spec (which may not perfectly conform to the specification) to make it workable with OpenAPI Generator. A few rules are switched on by default since 7.0.0 release:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"SIMPLIFY_ONEOF_ANYOF "),(0,r.kt)("li",{parentName:"ul"},"SIMPLIFY_BOOLEAN_ENUM")),(0,r.kt)("p",null,"(One can use ",(0,r.kt)("inlineCode",{parentName:"p"},"DISABLE_ALL=true")," to disable all the rules)"),(0,r.kt)("p",null,"Here is a list of rules supported:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"REF_AS_PARENT_IN_ALLOF"),": when set to ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", child schemas in ",(0,r.kt)("inlineCode",{parentName:"li"},"allOf")," is considered a parent if it's a ",(0,r.kt)("inlineCode",{parentName:"li"},"$ref")," (instead of inline schema).")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/allOf_extension_parent.yaml -o /tmp/java-okhttp/ --openapi-normalizer REF_AS_PARENT_IN_ALLOF=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"REMOVE_ANYOF_ONEOF_AND_KEEP_PROPERTIES_ONLY"),": when set to ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", oneOf/anyOf schema with only required properies only in a schema with properties will be removed. ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/removeAnyOfOneOfAndKeepPropertiesOnly_test.yaml"},"(example)"))),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/removeAnyOfOneOfAndKeepPropertiesOnly_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer REMOVE_ANYOF_ONEOF_AND_KEEP_PROPERTIES_ONLY=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SIMPLIFY_ANYOF_STRING_AND_ENUM_STRING"),": when set to ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", simplify anyOf schema with string and enum of string to just ",(0,r.kt)("inlineCode",{parentName:"li"},"string"))),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/simplifyAnyOfStringAndEnumString_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SIMPLIFY_ANYOF_STRING_AND_ENUM_STRING=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SIMPLIFY_BOOLEAN_ENUM"),": when set to ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", convert boolean enum to just enum.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/simplifyBooleanEnum_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SIMPLIFY_BOOLEAN_ENUM=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SIMPLIFY_ONEOF_ANYOF"),": when set to ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", simplify oneOf/anyOf by 1) removing null (sub-schema) or enum of null (sub-schema) and setting nullable to true instead, and 2) simplifying oneOf/anyOf with a single sub-schema to just the sub-schema itself.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/simplifyOneOfAnyOf_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SIMPLIFY_ONEOF_ANYOF=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"KEEP_ONLY_FIRST_TAG_IN_OPERATION"),": when set to ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", only keep the first tag in operation if there are more than one tag defined.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/enableKeepOnlyFirstTagInOperation_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer KEEP_ONLY_FIRST_TAG_IN_OPERATION=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SET_TAGS_FOR_ALL_OPERATIONS"),": when set to a string value, tags in all operations will reset to the string value provided.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/enableKeepOnlyFirstTagInOperation_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_TAGS_FOR_ALL_OPERATIONS=another_tag_name\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SET_TAGS_TO_OPERATIONID"),': when set to true, tags in all operations will be set to operationId or "default" if operationId is empty')),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_TAGS_TO_OPERATIONID=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ADD_UNSIGNED_TO_INTEGER_WITH_INVALID_MAX_VALUE"),": when set to true, auto fix integer with maximum value 4294967295 (2^32-1) or long with 18446744073709551615 (2^64-1) by adding x-unsigned to the schema")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/addUnsignedToIntegerWithInvalidMaxValue_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer ADD_UNSIGNED_TO_INTEGER_WITH_INVALID_MAX_VALUE=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"REFACTOR_ALLOF_WITH_PROPERTIES_ONLY"),": When set to true, refactor schema with allOf and properties in the same level to a schema with allOf only and, the allOf contains a new schema containing the properties in the top level.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/allOf_extension_parent.yaml -o /tmp/java-okhttp/ --openapi-normalizer REFACTOR_ALLOF_WITH_PROPERTIES_ONLY=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"REMOVE_X_INTERNAL"),": Set to true if you want to disable the default behavior of removing/hiding the x-internal in operations and model")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/enableKeepOnlyFirstTagInOperation_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer REMOVE_X_INTERNAL=true\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"FILTER"),": When set to ",(0,r.kt)("inlineCode",{parentName:"li"},"operationId:addPet|getPetById")," for example, it will add ",(0,r.kt)("inlineCode",{parentName:"li"},"x-internal:true")," to operations with operationId not equal to addPet/getPetById (which will have x-internal set to false) so that these operations marked as internal won't be generated.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},'java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer FILTER="operationId:addPet|getPetById"\n')),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SET_CONTAINER_TO_NULLABLE"),": When set to ",(0,r.kt)("inlineCode",{parentName:"li"},"array|set|map")," (or just ",(0,r.kt)("inlineCode",{parentName:"li"},"array"),") for example, it will set ",(0,r.kt)("inlineCode",{parentName:"li"},"nullable")," in array, set and map to true.")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},'java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_CONTAINER_TO_NULLABLE="array|map"\n')),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"SET_PRIMITIVE_TYPES_TO_NULLABLE"),": When set to ",(0,r.kt)("inlineCode",{parentName:"li"},"string|integer|number|boolean")," (or just ",(0,r.kt)("inlineCode",{parentName:"li"},"string"),") for example, it will set the type to ",(0,r.kt)("inlineCode",{parentName:"li"},"nullable")," (nullable: true)")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},'java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_PRIMITIVE_TYPES_TO_NULLABLE="integer|number"\n')),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"FIX_DUPLICATED_OPERATIONID"),": When set to true, an integer suffix will be added to duplicated operationId(s), e.g. getName => getName_0, getName_1, etc")),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_1/java/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer FIX_DUPLICATED_OPERATIONID=true\n")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c4f5d8e4.bdd6bf1a.js b/assets/js/c4f5d8e4.02ac33c7.js similarity index 99% rename from assets/js/c4f5d8e4.bdd6bf1a.js rename to assets/js/c4f5d8e4.02ac33c7.js index 0b60c719159..176edb1bf13 100644 --- a/assets/js/c4f5d8e4.bdd6bf1a.js +++ b/assets/js/c4f5d8e4.02ac33c7.js @@ -1,2 +1,2 @@ -/*! For license information please see c4f5d8e4.bdd6bf1a.js.LICENSE.txt */ -(self.webpackChunk=self.webpackChunk||[]).push([[4195],{2187:function(e,t,n){"use strict";n.r(t),n.d(t,{default:function(){return Z}});var a=n(7462);function r(e,t){return t||(t=e.slice(0)),e.raw=t,e}var o,l,c=n(7294),s=n(4184),i=n.n(s),m=n(4774),u=n(9960),p=n(2263),g=n(4996),d=n(9578),h=n(452),E=[{title:c.createElement(c.Fragment,null,"Easy to Use"),imageUrl:"img/icons/plug.svg",description:c.createElement(c.Fragment,null,c.createElement("p",null,"With ",c.createElement("em",null,"50+")," client generators, you can easily generate code to interact with any server which exposes an OpenAPI document."),c.createElement("p",null,"Maintainers of APIs may also automatically generate and distribute clients as part of official SDKs."),c.createElement("p",null,"Each client supports different options and features, but all templates can be replaced with your own Mustache-based templates."),"See ",c.createElement("a",{href:"./docs/customization"},"Customization")," for details.")},{title:c.createElement(c.Fragment,null,"Servers"),imageUrl:"img/icons/exchange.svg",description:c.createElement(c.Fragment,null,c.createElement("p",null,"Getting started with server development can be tough, especially if you're evaluating technologies. We can reduce the burden when you bring your own OpenAPI document."),c.createElement("p",null,"Generate server stubs for 40+ different languages and technologies, including Java, Kotlin, Go, and PHP."),c.createElement("p",null,"Some generators support ",c.createElement("em",null,"Inversion of Control"),", allowing you to iterate on design via your OpenAPI document without worrying about blowing away your entire domain layer when you regenerate code."))},{title:c.createElement(c.Fragment,null,"Schemas/Configs"),imageUrl:"img/icons/pencil.svg",description:c.createElement(c.Fragment,null,c.createElement("p",null,"Ever wanted to iteratively design a MySQL database, but writing table declarations was too tedious?"),c.createElement("p",null,"OpenAPI Generator offers some special generators such as Apache2 Configuration, MySQL and GraphQL schema generators."),c.createElement("p",null,"You can easily extend these generators and their templates to create derivative generators!"))},{title:c.createElement(c.Fragment,null,"Documentation"),imageUrl:"img/icons/newspaper-o.svg",description:c.createElement(c.Fragment,null,c.createElement("p",null,"OpenAPI documents allow you to convert the metadata about your API into some other format."),c.createElement("p",null,"We include documentation formats such as HTML and Cwiki, which allow you to distribute static documentation to your consumers."),c.createElement("p",null,"We also support generating from OpenAPI 2.0 to newer JSON/YAML OpenAPI 3.x documents."))}];function f(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),a=1;a"},c.createElement("header",{className:i()("hero hero--primary",d.Z.heroBanner)},c.createElement("div",{className:"container"},c.createElement("h1",{className:"hero__title"},t.title),c.createElement("p",{className:"hero__subtitle"},t.tagline),c.createElement("div",{className:d.Z.buttons},c.createElement(u.Z,{className:i()("button button--outline button--secondary button--lg",d.Z.getStarted),to:(0,g.Z)("#try")},"Try It Out"),c.createElement(u.Z,{className:i()("button button--outline button--secondary button--lg",d.Z.getStarted),to:(0,g.Z)("docs/installation")},"Install")),c.createElement("div",{className:d.Z.buttons},c.createElement(u.Z,{className:i()("button button--outline button--secondary button--md",d.Z.getStarted),to:(0,g.Z)("docs/generators")},"Generators"),c.createElement(u.Z,{className:i()("button button--outline button--secondary button--md",d.Z.getStarted),to:(0,g.Z)("docs/customization")},"Customization"),c.createElement(u.Z,{className:i()("button button--outline button--secondary button--md",d.Z.getStarted),to:(0,g.Z)("docs/integrations")},"Integrations")))),c.createElement("div",{className:i()(d.Z.announcement,d.Z.announcementDark)},c.createElement("div",{className:d.Z.announcementInner},c.createElement("h2",null,c.createElement("b",null,"Sponsors")),c.createElement("p",null,"If you find OpenAPI Generator useful, please consider asking your company to ",c.createElement("a",{href:"https://opencollective.com/openapi_generator"},"become a sponsor"),"."),c.createElement("p",null,"You can also individually sponsor the project by ",c.createElement("a",{href:"https://opencollective.com/openapi_generator"},"becoming a backer"),"."),c.createElement("h3",null,"Thank you to our bronze sponsors!"),c.createElement("div",{className:i()("avatar",d.Z.bronzeSponsorAvatars)},o.filter((function(e){return e.bronze})).map((function(e){return c.createElement("a",{className:i()("avatar__photo-link bronze-sponsor"),href:e.infoLink,key:e.infoLink},c.createElement("img",{src:(0,g.Z)(e.image),alt:e.caption,title:e.caption,className:i()("avatar__photo avatar__photo--lg")}))}))))),c.createElement("main",null,E&&E.length&&c.createElement("section",{className:d.Z.features},c.createElement("div",{className:"features container"},c.createElement("div",{className:"row"},E.map((function(e,t){return c.createElement(y,(0,a.Z)({key:t},e))}))))),v&&v.length&&c.createElement("section",{className:d.Z.callout},c.createElement("div",{className:"callout container"},v.map((function(e,t){return c.createElement(b,(0,a.Z)({key:t},e))}))))),s&&s.length&&c.createElement("div",{className:i()(d.Z.announcement,d.Z.announcementLight)},c.createElement("div",{className:i()(d.Z.productShowcaseSection,d.Z.announcementInner)},c.createElement(S,{users:s}))),c.createElement("div",{className:i()(d.Z.announcement,d.Z.announcementDark)},'"OpenAPI Tools" and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI)'))}},4184:function(e,t){var n;!function(){"use strict";var a={}.hasOwnProperty;function r(){for(var e=[],t=0;t1?t-1:0),a=1;a"},c.createElement("header",{className:i()("hero hero--primary",d.Z.heroBanner)},c.createElement("div",{className:"container"},c.createElement("h1",{className:"hero__title"},t.title),c.createElement("p",{className:"hero__subtitle"},t.tagline),c.createElement("div",{className:d.Z.buttons},c.createElement(u.Z,{className:i()("button button--outline button--secondary button--lg",d.Z.getStarted),to:(0,g.Z)("#try")},"Try It Out"),c.createElement(u.Z,{className:i()("button button--outline button--secondary button--lg",d.Z.getStarted),to:(0,g.Z)("docs/installation")},"Install")),c.createElement("div",{className:d.Z.buttons},c.createElement(u.Z,{className:i()("button button--outline button--secondary button--md",d.Z.getStarted),to:(0,g.Z)("docs/generators")},"Generators"),c.createElement(u.Z,{className:i()("button button--outline button--secondary button--md",d.Z.getStarted),to:(0,g.Z)("docs/customization")},"Customization"),c.createElement(u.Z,{className:i()("button button--outline button--secondary button--md",d.Z.getStarted),to:(0,g.Z)("docs/integrations")},"Integrations")))),c.createElement("div",{className:i()(d.Z.announcement,d.Z.announcementDark)},c.createElement("div",{className:d.Z.announcementInner},c.createElement("h2",null,c.createElement("b",null,"Sponsors")),c.createElement("p",null,"If you find OpenAPI Generator useful, please consider asking your company to ",c.createElement("a",{href:"https://opencollective.com/openapi_generator"},"become a sponsor"),"."),c.createElement("p",null,"You can also individually sponsor the project by ",c.createElement("a",{href:"https://opencollective.com/openapi_generator"},"becoming a backer"),"."),c.createElement("h3",null,"Thank you to our bronze sponsors!"),c.createElement("div",{className:i()("avatar",d.Z.bronzeSponsorAvatars)},o.filter((function(e){return e.bronze})).map((function(e){return c.createElement("a",{className:i()("avatar__photo-link bronze-sponsor"),href:e.infoLink,key:e.infoLink},c.createElement("img",{src:(0,g.Z)(e.image),alt:e.caption,title:e.caption,className:i()("avatar__photo avatar__photo--lg")}))}))))),c.createElement("main",null,E&&E.length&&c.createElement("section",{className:d.Z.features},c.createElement("div",{className:"features container"},c.createElement("div",{className:"row"},E.map((function(e,t){return c.createElement(y,(0,a.Z)({key:t},e))}))))),v&&v.length&&c.createElement("section",{className:d.Z.callout},c.createElement("div",{className:"callout container"},v.map((function(e,t){return c.createElement(b,(0,a.Z)({key:t},e))}))))),s&&s.length&&c.createElement("div",{className:i()(d.Z.announcement,d.Z.announcementLight)},c.createElement("div",{className:i()(d.Z.productShowcaseSection,d.Z.announcementInner)},c.createElement(S,{users:s}))),c.createElement("div",{className:i()(d.Z.announcement,d.Z.announcementDark)},'"OpenAPI Tools" and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI)'))}},4184:function(e,t){var n;!function(){"use strict";var a={}.hasOwnProperty;function r(){for(var e=[],t=0;t=d)&&Object.keys(t.O).every((function(e){return t.O[e](a[r])}))?a.splice(r--,1):(n=!1,d0&&e[u-1][2]>d;u--)e[u]=e[u-1];e[u]=[a,c,d]},t.n=function(e){var f=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(f,{a:f}),f},a=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},t.t=function(e,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};f=f||[null,a({}),a([]),a(a)];for(var n=2&c&&e;"object"==typeof n&&!~f.indexOf(n);n=a(n))Object.getOwnPropertyNames(n).forEach((function(f){b[f]=function(){return e[f]}}));return b.default=function(){return e},t.d(d,b),d},t.d=function(e,f){for(var a in f)t.o(f,a)&&!t.o(e,a)&&Object.defineProperty(e,a,{enumerable:!0,get:f[a]})},t.f={},t.e=function(e){return Promise.all(Object.keys(t.f).reduce((function(f,a){return t.f[a](e,f),f}),[]))},t.u=function(e){return"assets/js/"+({41:"c601bd32",53:"935f2afb",129:"9cccaf3a",172:"a8834710",189:"a7555215",254:"7eeb204a",263:"a8f86885",266:"cc2f38e0",317:"e9ea91ed",324:"a97f53bd",401:"47462ed9",523:"b505ee9d",533:"b2b675dd",688:"209b41dc",883:"dc895aaf",922:"defa8226",976:"93e536fd",987:"f8c929ff",1069:"859cc09f",1135:"535405f9",1178:"838bab07",1256:"912fe03d",1372:"f415191e",1384:"f6c9e83f",1412:"c0a62421",1477:"b2f554cd",1510:"94fb9a13",1555:"d8b3cd23",1576:"df7ab5c6",1598:"be2eb782",1660:"03abeb31",1698:"61aaf4b5",1704:"9cf894bb",1786:"c70d243d",1827:"2c08d080",1924:"1131f29a",1996:"72e09efa",2028:"9e229734",2126:"8e2963ef",2129:"a9f38005",2131:"997ff15c",2167:"2b362a87",2172:"b8dda33a",2269:"da796f38",2300:"2c087a87",2309:"726258db",2535:"814f3328",2600:"03b044fb",2692:"d14a9d06",2699:"8c015133",2707:"64ef44e5",2733:"baaf877f",2738:"dea345ca",2920:"4c5ebba5",3077:"33f8468c",3089:"a6aa9e1f",3159:"d7e2094c",3246:"30674823",3345:"c5f8bfe0",3375:"0fdafbcb",3385:"e0f8f6f1",3393:"3ac458cf",3435:"f594f170",3491:"2bbf879d",3534:"773b7ddf",3539:"a1dcf46f",3601:"d9b8b8b3",3608:"9e4087bc",3664:"96fb2cf3",3710:"88da3a17",3749:"4086254d",3852:"7f0a5fe3",4062:"72ac94e0",4189:"2f840b51",4195:"c4f5d8e4",4199:"a361f4e3",4245:"4b45c44c",4270:"6b573900",4335:"4f29e17a",4357:"ac8b7f2e",4418:"6664be73",4505:"25cfb3f3",4536:"9aa688bb",4544:"ed46ee25",4577:"6d0633c8",4682:"c5da328a",4711:"342fbc7e",4827:"8c0a1edc",4997:"1777f326",5034:"bd7019e0",5053:"be5da56a",5075:"9972b359",5148:"9e1c1430",5187:"c698896a",5192:"369d3d94",5195:"397fa735",5202:"32e37b42",5210:"4fd0afdf",5217:"1dba9094",5230:"7a1fae5f",5313:"21936a93",5321:"1a02600c",5324:"9cee5900",5377:"2cdde719",5390:"0196741a",5482:"7e0f18f4",5497:"2af05231",5529:"3d70cde6",5556:"acbe0809",5570:"5446bf9c",5698:"8b743bdd",5808:"7d30c4f8",5821:"06d5e819",5840:"aca6e04f",5894:"307ad648",5955:"f131602e",5963:"f70cb32f",5990:"bdaab79f",5997:"b9cf024a",6103:"ccc49370",6152:"a0a5c794",6216:"0024d09f",6261:"de9a7b5a",6350:"f3069005",6355:"8926c06f",6360:"cc8e85bd",6363:"dd058668",6379:"482f7566",6390:"a2b71ef9",6417:"06d5d70a",6501:"9b517c7f",6536:"1444fc1b",6550:"5f7cf4b7",6567:"a598bb04",6581:"c402ff29",6602:"839446cf",6669:"a85ef2bb",6751:"95412b72",6771:"0358ea4a",6823:"13187f39",6902:"533906e9",6904:"77aecd65",6913:"e3d432cb",6951:"aa404fff",6955:"4b8333e5",7e3:"b6a32428",7007:"22cafcd3",7027:"0dad02a3",7032:"0978a33a",7124:"7755c98f",7151:"8b77bac1",7154:"f1d7b915",7221:"a5c65c7b",7246:"782001b8",7249:"285cb8cd",7296:"2b0b4d70",7314:"2606bf23",7325:"40df99d3",7373:"ea9ce23f",7418:"f9fb43b6",7482:"fa668fca",7550:"781ad36b",7580:"50799408",7618:"712b85c0",7748:"e360e27f",7858:"013f42ef",7886:"50bbcf89",7918:"17896441",7920:"1a4e3797",7931:"a5fabd44",7952:"6db4087d",8010:"858d8181",8115:"9e443e3b",8217:"09ccb289",8241:"d43f6e1a",8246:"6c98f389",8332:"133e23d9",8382:"ecfe08ed",8414:"d819719c",8477:"fba73214",8520:"b3764198",8738:"7a0eaed6",8883:"065a8d55",8908:"294e02c4",8987:"fa2528e9",9007:"de7a50d6",9095:"b2b85c76",9109:"b26e5421",9148:"93f4d3a6",9202:"088716a6",9208:"1b5512b0",9211:"ac312d55",9216:"cda7cfb0",9231:"ed13c9fe",9254:"f07aaea4",9287:"4e9e65dc",9514:"1be78505",9588:"eb73edd0",9653:"10211c0a",9684:"e5ad4e18",9702:"fffd8764",9754:"9cbcc25e",9760:"0cae4475",9777:"1fc4ffdf",9805:"9d9ec3e3",9922:"d924db8b",9953:"62a8e98d",9978:"cf67c7b0"}[e]||e)+"."+{41:"b66ea156",53:"b76e3f06",129:"d8b39fdb",172:"9900d0a1",189:"42d0afb2",254:"4a79ed09",263:"54a6a714",266:"5ab2de87",317:"0d4985a9",324:"cc0c7d46",401:"6cc08415",452:"80a95d2f",523:"e3d3fa82",533:"3eda73e2",688:"68c53e1d",883:"9bd287b3",922:"826f5740",976:"f70d85d3",987:"40e33250",1069:"a97da56d",1135:"9f5fe52f",1178:"cd7926ed",1256:"eaf2a911",1372:"9c9dca26",1384:"8b81d993",1412:"850ff389",1477:"5600cbcb",1510:"e0a19278",1555:"d6b248cb",1576:"b5f09130",1598:"38999ee3",1660:"259fcbc3",1698:"aecfef13",1704:"e4996f7e",1786:"8d0ee5b4",1827:"d1a409c8",1924:"33f44504",1996:"65c8d279",2028:"ab4a7b3f",2126:"2782159d",2129:"49514dce",2131:"54356016",2167:"4f9d15f5",2172:"84a31916",2269:"b7032532",2300:"4504099c",2309:"894ecd5c",2535:"e46c8ddf",2600:"fe6b6382",2692:"e0ccfcf1",2699:"72e15193",2707:"e4106802",2733:"0aa71855",2738:"ba477081",2920:"bdd25e99",3077:"89079bec",3089:"99527bf4",3159:"5cadd1cd",3246:"2aeb0983",3345:"c33aef6c",3375:"15d00703",3385:"327b633c",3393:"c4e7254f",3435:"e673b6b1",3491:"c20b6a68",3534:"f8fd0c62",3539:"62e1e69d",3601:"a57349d2",3608:"2c52819e",3664:"1512757f",3710:"e042d178",3749:"f5244a14",3852:"46b6dd2c",4062:"828c465a",4189:"623e9269",4195:"bdd6bf1a",4199:"ba288c10",4245:"632fd32d",4270:"2100366d",4335:"83f58185",4357:"6b71ba81",4418:"b81e24ac",4505:"864d2f5d",4536:"f99805c9",4544:"7feab392",4577:"1019f9b9",4682:"db36dcfc",4711:"0eded84b",4827:"e637f0ff",4972:"5a051413",4997:"6ed60180",5034:"7eac1ae5",5053:"4286c7a7",5075:"07b7a07f",5148:"7929e00b",5187:"4e4c9231",5192:"73727798",5195:"2e32d4f1",5202:"a9f4c5fb",5210:"0fd1a00b",5217:"d6a5df56",5230:"5e55a31c",5313:"58944aed",5321:"059f9de0",5324:"616802de",5377:"4b435f44",5390:"bac8b6db",5482:"fad887fb",5497:"7f5f32d9",5529:"f4e0878e",5556:"219df2c4",5570:"b86e6ab0",5698:"d8c1afc0",5808:"625afe27",5821:"be50e532",5840:"045ea523",5894:"dca38aa1",5955:"c19f184f",5963:"466b58f9",5990:"1d3e33a0",5997:"71758c5f",6048:"f554d3bd",6103:"21b4df6b",6152:"12353aa4",6216:"95ea3524",6261:"bc036cde",6350:"91eb898f",6355:"a6f563e6",6360:"7e66281d",6363:"d551e71c",6379:"31ed873e",6390:"e810cbbb",6417:"4c9860c2",6501:"a69805e4",6536:"f07df81b",6550:"3efcc2c3",6567:"e3322a0e",6581:"58afd5f4",6602:"e9306f62",6669:"7ffd847b",6751:"9b5a1153",6771:"b0c35e3f",6780:"82d77998",6823:"26ccbd4b",6902:"e498dd98",6904:"12a02a49",6913:"f00437af",6945:"2ba1343d",6951:"cac9182d",6955:"4b08bef7",7e3:"1fa00187",7007:"39cd0aca",7027:"7862777e",7032:"bec00de4",7124:"c881d90f",7151:"f41f8cbd",7154:"c79fca49",7221:"7e63e62b",7246:"a3c897fe",7249:"ca4b8657",7296:"1068ff64",7314:"50745663",7325:"1e6988b5",7373:"580714da",7418:"a7b95969",7482:"117edd97",7550:"ac8230cb",7580:"67225175",7618:"efafd530",7748:"3c5936bc",7858:"1d084fa9",7886:"d428910a",7918:"4ee1d312",7920:"1ebbc1bb",7931:"e6dae329",7952:"a84aafcf",8010:"1fb674e5",8115:"8e73e0b3",8217:"c6a930c5",8241:"f07c6e5d",8246:"b5ee949a",8332:"7852948d",8382:"bbfa7407",8414:"fcce36e7",8477:"60b21f29",8520:"cb4e9c0e",8738:"4b929816",8754:"ef049c9d",8883:"142c2e29",8894:"bfab79c0",8908:"eccc7043",8987:"84ba1690",9007:"e8dc1069",9095:"01ad8a5d",9109:"e995f576",9148:"104cd4a3",9202:"73214198",9208:"c64acecf",9211:"1097967b",9216:"063dfbd5",9231:"7ba642c9",9254:"d712ee6d",9287:"934590d0",9514:"ebe3f96c",9588:"93ebe8bf",9653:"f996ecf3",9684:"77818410",9702:"83df1873",9754:"eac25bd2",9760:"41db2d36",9777:"da3fc37c",9805:"834b9634",9922:"9e118620",9953:"6875e213",9978:"beb4df3a"}[e]+".js"},t.miniCssF=function(e){},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=function(e,f){return Object.prototype.hasOwnProperty.call(e,f)},c={},t.l=function(e,f,a,d){if(c[e])c[e].push(f);else{var b,n;if(void 0!==a)for(var r=document.getElementsByTagName("script"),o=0;o=d)&&Object.keys(t.O).every((function(e){return t.O[e](a[r])}))?a.splice(r--,1):(n=!1,d0&&e[u-1][2]>d;u--)e[u]=e[u-1];e[u]=[a,c,d]},t.n=function(e){var f=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(f,{a:f}),f},a=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},t.t=function(e,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};f=f||[null,a({}),a([]),a(a)];for(var n=2&c&&e;"object"==typeof n&&!~f.indexOf(n);n=a(n))Object.getOwnPropertyNames(n).forEach((function(f){b[f]=function(){return e[f]}}));return b.default=function(){return e},t.d(d,b),d},t.d=function(e,f){for(var a in f)t.o(f,a)&&!t.o(e,a)&&Object.defineProperty(e,a,{enumerable:!0,get:f[a]})},t.f={},t.e=function(e){return Promise.all(Object.keys(t.f).reduce((function(f,a){return t.f[a](e,f),f}),[]))},t.u=function(e){return"assets/js/"+({41:"c601bd32",53:"935f2afb",129:"9cccaf3a",172:"a8834710",189:"a7555215",254:"7eeb204a",263:"a8f86885",266:"cc2f38e0",317:"e9ea91ed",324:"a97f53bd",401:"47462ed9",523:"b505ee9d",533:"b2b675dd",688:"209b41dc",883:"dc895aaf",922:"defa8226",976:"93e536fd",987:"f8c929ff",1069:"859cc09f",1135:"535405f9",1178:"838bab07",1256:"912fe03d",1372:"f415191e",1384:"f6c9e83f",1412:"c0a62421",1477:"b2f554cd",1510:"94fb9a13",1555:"d8b3cd23",1576:"df7ab5c6",1598:"be2eb782",1660:"03abeb31",1698:"61aaf4b5",1704:"9cf894bb",1786:"c70d243d",1827:"2c08d080",1924:"1131f29a",1996:"72e09efa",2028:"9e229734",2126:"8e2963ef",2129:"a9f38005",2131:"997ff15c",2167:"2b362a87",2172:"b8dda33a",2269:"da796f38",2300:"2c087a87",2309:"726258db",2535:"814f3328",2600:"03b044fb",2692:"d14a9d06",2699:"8c015133",2707:"64ef44e5",2733:"baaf877f",2738:"dea345ca",2920:"4c5ebba5",3077:"33f8468c",3089:"a6aa9e1f",3159:"d7e2094c",3246:"30674823",3345:"c5f8bfe0",3375:"0fdafbcb",3385:"e0f8f6f1",3393:"3ac458cf",3435:"f594f170",3491:"2bbf879d",3534:"773b7ddf",3539:"a1dcf46f",3601:"d9b8b8b3",3608:"9e4087bc",3664:"96fb2cf3",3710:"88da3a17",3749:"4086254d",3852:"7f0a5fe3",4062:"72ac94e0",4189:"2f840b51",4195:"c4f5d8e4",4199:"a361f4e3",4245:"4b45c44c",4270:"6b573900",4335:"4f29e17a",4357:"ac8b7f2e",4418:"6664be73",4505:"25cfb3f3",4536:"9aa688bb",4544:"ed46ee25",4577:"6d0633c8",4682:"c5da328a",4711:"342fbc7e",4827:"8c0a1edc",4997:"1777f326",5034:"bd7019e0",5053:"be5da56a",5075:"9972b359",5148:"9e1c1430",5187:"c698896a",5192:"369d3d94",5195:"397fa735",5202:"32e37b42",5210:"4fd0afdf",5217:"1dba9094",5230:"7a1fae5f",5313:"21936a93",5321:"1a02600c",5324:"9cee5900",5377:"2cdde719",5390:"0196741a",5482:"7e0f18f4",5497:"2af05231",5529:"3d70cde6",5556:"acbe0809",5570:"5446bf9c",5698:"8b743bdd",5808:"7d30c4f8",5821:"06d5e819",5840:"aca6e04f",5894:"307ad648",5955:"f131602e",5963:"f70cb32f",5990:"bdaab79f",5997:"b9cf024a",6103:"ccc49370",6152:"a0a5c794",6216:"0024d09f",6261:"de9a7b5a",6350:"f3069005",6355:"8926c06f",6360:"cc8e85bd",6363:"dd058668",6379:"482f7566",6390:"a2b71ef9",6417:"06d5d70a",6501:"9b517c7f",6536:"1444fc1b",6550:"5f7cf4b7",6567:"a598bb04",6581:"c402ff29",6602:"839446cf",6669:"a85ef2bb",6751:"95412b72",6771:"0358ea4a",6823:"13187f39",6902:"533906e9",6904:"77aecd65",6913:"e3d432cb",6951:"aa404fff",6955:"4b8333e5",7e3:"b6a32428",7007:"22cafcd3",7027:"0dad02a3",7032:"0978a33a",7124:"7755c98f",7151:"8b77bac1",7154:"f1d7b915",7221:"a5c65c7b",7246:"782001b8",7249:"285cb8cd",7296:"2b0b4d70",7314:"2606bf23",7325:"40df99d3",7373:"ea9ce23f",7418:"f9fb43b6",7482:"fa668fca",7550:"781ad36b",7580:"50799408",7618:"712b85c0",7748:"e360e27f",7858:"013f42ef",7886:"50bbcf89",7918:"17896441",7920:"1a4e3797",7931:"a5fabd44",7952:"6db4087d",8010:"858d8181",8115:"9e443e3b",8217:"09ccb289",8241:"d43f6e1a",8246:"6c98f389",8332:"133e23d9",8382:"ecfe08ed",8414:"d819719c",8477:"fba73214",8520:"b3764198",8738:"7a0eaed6",8883:"065a8d55",8908:"294e02c4",8987:"fa2528e9",9007:"de7a50d6",9095:"b2b85c76",9109:"b26e5421",9148:"93f4d3a6",9202:"088716a6",9208:"1b5512b0",9211:"ac312d55",9216:"cda7cfb0",9231:"ed13c9fe",9254:"f07aaea4",9287:"4e9e65dc",9514:"1be78505",9588:"eb73edd0",9653:"10211c0a",9684:"e5ad4e18",9702:"fffd8764",9754:"9cbcc25e",9760:"0cae4475",9777:"1fc4ffdf",9805:"9d9ec3e3",9922:"d924db8b",9953:"62a8e98d",9978:"cf67c7b0"}[e]||e)+"."+{41:"b66ea156",53:"b76e3f06",129:"d8b39fdb",172:"9900d0a1",189:"42d0afb2",254:"4a79ed09",263:"54a6a714",266:"5ab2de87",317:"0d4985a9",324:"cc0c7d46",401:"6cc08415",452:"80a95d2f",523:"e3d3fa82",533:"3eda73e2",688:"68c53e1d",883:"9bd287b3",922:"826f5740",976:"f70d85d3",987:"40e33250",1069:"a97da56d",1135:"9f5fe52f",1178:"cd7926ed",1256:"eaf2a911",1372:"9c9dca26",1384:"8b81d993",1412:"850ff389",1477:"5600cbcb",1510:"e0a19278",1555:"d6b248cb",1576:"b5f09130",1598:"38999ee3",1660:"259fcbc3",1698:"aecfef13",1704:"e4996f7e",1786:"8d0ee5b4",1827:"d1a409c8",1924:"33f44504",1996:"65c8d279",2028:"ab4a7b3f",2126:"2782159d",2129:"49514dce",2131:"54356016",2167:"4f9d15f5",2172:"84a31916",2269:"b7032532",2300:"4504099c",2309:"894ecd5c",2535:"e46c8ddf",2600:"fe6b6382",2692:"e0ccfcf1",2699:"72e15193",2707:"e4106802",2733:"0aa71855",2738:"ba477081",2920:"bdd25e99",3077:"89079bec",3089:"99527bf4",3159:"5cadd1cd",3246:"2aeb0983",3345:"c33aef6c",3375:"15d00703",3385:"327b633c",3393:"c4e7254f",3435:"e673b6b1",3491:"c20b6a68",3534:"f8fd0c62",3539:"62e1e69d",3601:"a57349d2",3608:"2c52819e",3664:"1512757f",3710:"e042d178",3749:"f5244a14",3852:"46b6dd2c",4062:"828c465a",4189:"623e9269",4195:"02ac33c7",4199:"ba288c10",4245:"632fd32d",4270:"2100366d",4335:"83f58185",4357:"6b71ba81",4418:"b81e24ac",4505:"864d2f5d",4536:"f99805c9",4544:"7feab392",4577:"1019f9b9",4682:"db36dcfc",4711:"0eded84b",4827:"e637f0ff",4972:"5a051413",4997:"6ed60180",5034:"7eac1ae5",5053:"4286c7a7",5075:"07b7a07f",5148:"7929e00b",5187:"4e4c9231",5192:"73727798",5195:"2e32d4f1",5202:"a9f4c5fb",5210:"0fd1a00b",5217:"d6a5df56",5230:"5e55a31c",5313:"58944aed",5321:"059f9de0",5324:"616802de",5377:"4b435f44",5390:"bac8b6db",5482:"fad887fb",5497:"7f5f32d9",5529:"f4e0878e",5556:"219df2c4",5570:"b86e6ab0",5698:"d8c1afc0",5808:"625afe27",5821:"be50e532",5840:"045ea523",5894:"dca38aa1",5955:"c19f184f",5963:"466b58f9",5990:"1d3e33a0",5997:"71758c5f",6048:"f554d3bd",6103:"21b4df6b",6152:"12353aa4",6216:"95ea3524",6261:"bc036cde",6350:"91eb898f",6355:"a6f563e6",6360:"7e66281d",6363:"d551e71c",6379:"31ed873e",6390:"e810cbbb",6417:"4c9860c2",6501:"a69805e4",6536:"f07df81b",6550:"3efcc2c3",6567:"e3322a0e",6581:"58afd5f4",6602:"e9306f62",6669:"7ffd847b",6751:"9b5a1153",6771:"b0c35e3f",6780:"82d77998",6823:"26ccbd4b",6902:"e498dd98",6904:"12a02a49",6913:"f00437af",6945:"2ba1343d",6951:"cac9182d",6955:"4b08bef7",7e3:"53e34af9",7007:"39cd0aca",7027:"7862777e",7032:"bec00de4",7124:"c881d90f",7151:"f41f8cbd",7154:"c79fca49",7221:"7e63e62b",7246:"a3c897fe",7249:"ca4b8657",7296:"1068ff64",7314:"50745663",7325:"1e6988b5",7373:"580714da",7418:"a7b95969",7482:"117edd97",7550:"ac8230cb",7580:"67225175",7618:"efafd530",7748:"3c5936bc",7858:"1d084fa9",7886:"d428910a",7918:"4ee1d312",7920:"1ebbc1bb",7931:"e6dae329",7952:"a84aafcf",8010:"1fb674e5",8115:"8e73e0b3",8217:"c6a930c5",8241:"f07c6e5d",8246:"b5ee949a",8332:"7852948d",8382:"bbfa7407",8414:"fcce36e7",8477:"60b21f29",8520:"cb4e9c0e",8738:"4b929816",8754:"ef049c9d",8883:"142c2e29",8894:"bfab79c0",8908:"eccc7043",8987:"84ba1690",9007:"e8dc1069",9095:"01ad8a5d",9109:"e995f576",9148:"104cd4a3",9202:"73214198",9208:"c64acecf",9211:"1097967b",9216:"063dfbd5",9231:"7ba642c9",9254:"d712ee6d",9287:"934590d0",9514:"ebe3f96c",9588:"93ebe8bf",9653:"f996ecf3",9684:"77818410",9702:"83df1873",9754:"eac25bd2",9760:"41db2d36",9777:"da3fc37c",9805:"834b9634",9922:"9e118620",9953:"6875e213",9978:"beb4df3a"}[e]+".js"},t.miniCssF=function(e){},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=function(e,f){return Object.prototype.hasOwnProperty.call(e,f)},c={},t.l=function(e,f,a,d){if(c[e])c[e].push(f);else{var b,n;if(void 0!==a)for(var r=document.getElementsByTagName("script"),o=0;o - +

New Website

· One min read

Every great open source project has great documentation.

That's why we're proud to announce that we've adopted a new website and design for our official documentation.

We will still continue to maintain the documentation on our GitHub repository. In fact, our website will be generated with Docusaurus, so our docs on GitHub will still be incorporated into this site!

- + \ No newline at end of file diff --git a/blog/archive/index.html b/blog/archive/index.html index 5acbe12a4e7..7373f5ee3b9 100644 --- a/blog/archive/index.html +++ b/blog/archive/index.html @@ -15,13 +15,13 @@ - +
- + \ No newline at end of file diff --git a/blog/index.html b/blog/index.html index 6f2bad293e2..f803140feb0 100644 --- a/blog/index.html +++ b/blog/index.html @@ -15,13 +15,13 @@ - +

· One min read

Every great open source project has great documentation.

That's why we're proud to announce that we've adopted a new website and design for our official documentation.

- + \ No newline at end of file diff --git a/docs/code-of-conduct/index.html b/docs/code-of-conduct/index.html index f513dc4a846..478bf4352d0 100644 --- a/docs/code-of-conduct/index.html +++ b/docs/code-of-conduct/index.html @@ -15,13 +15,13 @@ - +

Code of Conduct

Our Pledge​

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards​

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities​

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope​

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement​

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at team@openapitools.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution​

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4

- + \ No newline at end of file diff --git a/docs/configuration/index.html b/docs/configuration/index.html index 408298a9a9c..016d755bbaa 100644 --- a/docs/configuration/index.html +++ b/docs/configuration/index.html @@ -15,13 +15,13 @@ - +

Configuration Options

Our tooling supports the following types of configuration:

  • global properties
    • properties with cross-cutting concerns which control generation, but don't belong to individual generators
    • Example: debugSupportingFiles prints the contents of template data bound to supporting files
  • config options
    • configuration specific to each individual generator
    • these options are susceptible to validation within the defining generator; a config option of the same name across multiple generators may be validated differently in each
    • NOTE: The CLI accepts config options as "additional properties"
  • additional properties
    • these are the properties which will be passed to templates
    • generally used to pass user-defined properties to custom templates
    • many config options may also be passed as additional properties, however generators will read/modify/rewrite config options
    • users may pass custom additional properties and use these within templates (e.g. a custom generatedBy key with a value of Jim Schubert for inclusion in a custom CVS-like header)
  • top-level properties specific to individual tools/plugins used to bootstrap our tooling

Tool-specific Declarations​

The READMEs for the CLI, Gradle Plugin, Maven Plugin, and SBT Plugin may have top-level or tooling specific options which appear to duplicate 'config options' or 'global properties'. Each may also expose user-facing properties slightly differently from the other tools. This may occur due to:

  • Conventions used by the underlying tooling
  • Limitations in underlying frameworks which define how properties must be declared
  • Continuation of support for "legacy" invocation patterns
  • Mistakes in documentation and/or contributions (please do file a bug)

Take, for example, the CLI option of --skip-validate-spec. This flag sets the value to true with no option to set it to false (the default internally). The maven and gradle plugins allow for the top-level option skipValidateSpec to have a value of true or false. The SBT plugin, on the other hand, follows community convention and this property is openApiSkipValidateSpec.

How you provide values to options also depends on the tool. OpenAPI Generator supports global properties for selective generation -- such as apis -- to have either a blank value or a comma-separated list of selected values. We would define this in CLI as --global-property apis or --global-property apis=Equipment. In the Gradle Plugin, these properties are set directly as strings:

openApiGenerate {
    globalProperties.set([
        apis: "",
        models: "User:Pet"
    ])
}

In the Maven plugin, we're limited by XML syntax where <apis/> and <apis></apis> are treated the same as if the apis node was undefined; there's no way to provide an empty string as a default. Instead, we have to extract the global property into its own properties which maintain the two states supported elsewhere (i.e. "all apis" or "select apis"). We have generateApis which accepts a boolean and apisToGenerate which accepts a comma-separated selection list.

Discovering Options​

Refer to global properties for a list of available global properties and their usage.

Top-level tooling options are defined in CLI usage. Many of these options directly map to camel case options in other tools, but do refer to plugin documentation for full details or plugin-specific differences.

Config options for generators are available in documentation online. You may also use the CLI to query config options for a target generator using openapi-generator config-help -g <generator-name>. For example:

$ openapi-generator config-help -g mysql-schema

CONFIG OPTIONS

    defaultDatabaseName
        Default database name for all MySQL queries (Default: )

    identifierNamingConvention
        Naming convention of MySQL identifiers(table names and column names). This is not related to database name which is defined by defaultDatabaseName option (Default: original)
            original - Do not transform original names
            snake_case - Use snake_case names

    jsonDataTypeEnabled
        Use special JSON MySQL data type for complex model properties. Requires MySQL version 5.7.8. Generates TEXT data type when disabled (Default: true)

    namedParametersEnabled
        Generates model prepared SQLs with named parameters, eg. :petName. Question mark placeholder used when option disabled. (Default: false)

This output provides the name of the configuration option. A set of acceptable values for any constrained values will print as an indented list (e.g. identifierNamingConvention above).

Suppose you want to apply snake case naming to mysql schema outputs. Your configuration might resemble the following examples.

CLI

openapi-generator -g mysql-schema -o out -i spec.yaml --additional-properties=identifierNamingConvention=snake_case,useSingleRequestParameter=true,withInterfaces=true

It may seem like a typo but there are two = signs in the above example.

Maven Plugin

<execution>
    <id>mysql-schema</id>
    <phase>generate-sources</phase>
    <goals>
        <goal>generate</goal>
    </goals>
    <configuration>
        <inputSpec>spec.yaml</inputSpec>
        <generatorName>mysql-schema</generatorName>
        <configOptions>
            <identifierNamingConvention>snake_case</identifierNamingConvention>
        </configOptions>
        <output>${project.build.directory}/generated-sources/mysql</output>
    </configuration>
</execution>

Gradle Plugin

openApiGenerate {
    generatorName.set("mysql-schema")
    inputSpec.set("$rootDir/spec.yaml")
    outputDir.set("$buildDir/mysql")
    configOptions.set([
            identifierNamingConvention: "snake_case"
    ])
}
- + \ No newline at end of file diff --git a/docs/contribute-building/index.html b/docs/contribute-building/index.html index c7c6752c342..509ad2721e8 100644 --- a/docs/contribute-building/index.html +++ b/docs/contribute-building/index.html @@ -15,14 +15,14 @@ - +

Building the code

Using Maven​

To build from source, you need the following installed and available in your $PATH:

After cloning the project, you can build it from source with this command:

mvn clean install

If you don't have maven installed, you may directly use the included maven wrapper, and build with the command:

./mvnw clean install

Using Docker​

You can use run-in-docker.sh to do all development. This script maps your local repository to /gen in the docker container. It also maps ~/.m2/repository to the appropriate container location.

To execute mvn package:

git clone https://github.com/openapitools/openapi-generator
cd openapi-generator
./run-in-docker.sh mvn package

Build artifacts are now accessible in your working directory.

Once built, run-in-docker.sh will act as an executable for openapi-generator-cli. To generate code, you'll need to output to a directory under /gen (e.g. /gen/out). For example:

./run-in-docker.sh help # Executes 'help' command for openapi-generator-cli
./run-in-docker.sh list # Executes 'list' command for openapi-generator-cli
./run-in-docker.sh /gen/bin/generate-samples.sh /gen/bin/configs/go-petstore.yaml  # Builds the Go client
./run-in-docker.sh generate -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml \
    -g go -o /gen/out/go-petstore -p packageName=petstore # generates go client, outputs locally to ./out/go-petstore

Docker in Vagrant​

Prerequisite: install Vagrant and VirtualBox.

git clone https://github.com/openapitools/openapi-generator.git
cd openapi-generator
vagrant up
vagrant ssh
cd /vagrant
./run-in-docker.sh mvn package

Troubleshooting​

If an error like this occurs, just execute the mvn clean install -U command:

org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test (default-test) on project openapi-generator: A type incompatibility occurred while executing org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test: java.lang.ExceptionInInitializerError cannot be cast to java.io.IOException

./run-in-docker.sh mvn clean install -U

Failed to execute goal org.fortasoft:gradle-maven-plugin:1.0.8:invoke (default) on project openapi-generator-gradle-plugin-mvn-wrapper: org.gradle.tooling.BuildException: Could not execute build using Gradle distribution 'https://services.gradle.org/distributions/gradle-4.7-bin.zip'

Right now: no solution for this one :|

- + \ No newline at end of file diff --git a/docs/contributing/index.html b/docs/contributing/index.html index 8ae72cb4e50..2c22ba367b7 100644 --- a/docs/contributing/index.html +++ b/docs/contributing/index.html @@ -15,13 +15,13 @@ - +

Guidelines For Contributing

Before submitting an issue​

  • If you're not using the latest master to generate API clients or server stubs, please give it another try by pulling the latest master as the issue may have already been addressed. Ref: Getting Started
  • Search the open issue and closed issue to ensure no one else has reported something similar before.
  • File an issue ticket by providing all the required information. Failure to provide enough detail may result in slow response from the community.
  • Test with the latest master by building the JAR locally to see if the issue has already been addressed.
  • You can also make a suggestion or ask a question by opening an "issue".

Before submitting a PR​

  • Search the open issue to ensure no one else has reported something similar and no one is actively working on similar proposed change.
  • If no one has suggested something similar, open an "issue" with your suggestion to gather feedback from the community.
  • If you're adding a new option to a generator, please consider using the -t option with customized templates instead or start a discussion first by opening an issue as we want to avoid adding too many options to the generator.
  • It's recommended to create a new git branch for the change so that the merge commit message looks nicer in the commit history.

How to contribute​

git​

If you're new to git, you may find the following FAQs useful:

https://github.com/openapitools/openapi-generator/wiki/FAQ#git

Branches​

Please file the pull request against the correct branch, e.g. master for non-breaking changes. See the Git Branches page for more information.

Code generators​

All the code generators can be found in modules/openapi-generator/src/main/java/org/openapitools/codegen/languages

If you want to add a new generator, follow the new-generator guide.

Templates​

All the templates (mustache) can be found in modules/openapi-generator/src/main/resources.

For a list of variables available in the template, please refer to this page

Style guide​

Code change should conform to the programming style guide of the respective languages:

For other languages, feel free to suggest.

You may find the current code base not 100% conform to the coding style and we welcome contributions to fix those.

For Vendor Extensions, please follow the naming convention below:

  • For general vendor extension, use lower case and hyphen. e.g. x-is-unique, x-content-type
  • For language-specified vendor extension, put it in the form of x-{lang}-{extension-name}. e.g. x-objc-operation-id, x-java-feign-retry-limit
  • For a list of existing vendor extensions in use, please refer to https://github.com/openapitools/openapi-generator/wiki/Vendor-Extensions. If you've added new vendor extensions as part of your PR, please update the wiki page.

Building​

The openapi-generator-cli can be built using the following command. This will generate the openapi-generator-cli.jar in the modules/openapi-generator-cli/target directory without running the tests and generating the Javadocs.

./mvnw clean install -DskipTests -Dmaven.javadoc.skip=true

Or on Windows:

mvnw.cmd clean install -DskipTests -Dmaven.javadoc.skip=true

The binary can run via java -jar. For example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar help

Testing​

To add test cases (optional) covering the change in the code generator, please refer to modules/openapi-generator/src/test/java/org/openapitools/codegen

To test the templates, please perform the following:

  • Update the Petstore sample by running the shell scripts under the bin folder. For example, run ./bin/generate-samples.sh ./bin/configs/python* to update the Python-related samples under samples. For Windows, please install GIT bash. (If you find that there are new files generated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI spec from time to time. If you've questions or concerns, please open a ticket to start a discussion)
  • During development, it can be helpful to quickly regenerate the samples without recompiling all of openapi-generator, e.g. when you have only updated the mustache templates. This can be done by passing the -t parameter: -t modules/openapi-generator/src/main/resources/python.
  • Run the tests in the sample folder using maven mvn integration-test -f /path/to/pom.xml, e.g. mvn integration-test -f samples/client/petstore/python/pom.xml. (some languages may not contain unit testing for Petstore and we're looking for contribution from the community to implement those tests). Please notice: you must run a local instance of the Petstore server in order to perform the tests, as running them against petstore.swagger.io is not supported anymore. Please refer to item 3 of Integration Tests - How to add integration tests for new Petstore samples to learn how to quickly configure and run it.
  • Finally, git commit the updated samples files: git commit -a (git add -A if added files with new test cases)
  • For new test cases, please add to the Fake Petstore spec

To start the CI tests, you can:

  • Run mvn verify -Psamples, assuming you have all the required tools installed to run tests for different languages.
  • Leverage http://travis-ci.org to run the CI tests by adding your own openapi-generator repository.
  • Run some of the CI tests in your local workspace.

See OpenAPI Tools wiki for more information about the integration tests.

Tips​

  • Smaller changes are easier to review
  • [Optional] For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix
  • Add test case(s) to cover the change
  • Document the fix in the code to make the code more readable
  • Make sure test cases passed after the change (one way is to leverage https://travis-ci.org/ to run the CI tests)
  • File a PR with meaningful title, description and commit messages
  • Make sure the option "Allow edits from maintainers" in the PR is selected so that the maintainers can update your PRs with minor fixes, if needed.
  • Recommended git settings
    • git config core.autocrlf input to tell Git convert CRLF to LF on commit but not the other way around
  • To close an issue (e.g. issue 1542) automatically after a PR is merged, use keywords "fix", "close", "resolve" in the PR description, e.g. fix #1542. (Ref: closing issues using keywords)
- + \ No newline at end of file diff --git a/docs/core-team/index.html b/docs/core-team/index.html index 79941a3dd64..c6421e605d6 100644 --- a/docs/core-team/index.html +++ b/docs/core-team/index.html @@ -15,13 +15,13 @@ - +
- + \ No newline at end of file diff --git a/docs/customization/index.html b/docs/customization/index.html index 1f1962999fe..ceb0770b2a5 100644 --- a/docs/customization/index.html +++ b/docs/customization/index.html @@ -15,7 +15,7 @@ - + @@ -26,8 +26,8 @@ These options default to true and don't limit the generation of the feature These options are applied via configuration file (e.g. config.json or config.yml) or by passing them with -p {optionName}={optionValue}. (If -p {optionName} does not work, please open a ticket and we'll look into it)

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar config-help -g java

Output

CONFIG OPTIONS
    modelPackage
        package for generated models

    apiPackage
        package for generated api classes
...... (results omitted)
    library
        library template (sub-template) to use:
        jersey2 - HTTP client: Jersey client 2.6
        feign - HTTP client: Netflix Feign 8.1.1.  JSON processing: Jackson 2.6.3
        okhttp-gson (default) - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1
        retrofit - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1 (Retrofit 1.9.0)
        retrofit2 - HTTP client: OkHttp 2.5.0. JSON processing: Gson 2.4 (Retrofit 2.0.0-beta2)
        google-api-client - HTTP client: google-api-client 1.23.0. JSON processing: Jackson 2.8.9
        rest-assured - HTTP client: rest-assured : 4.3.0. JSON processing: Gson 2.8.6. Only for Java8

Your config file for Java can look like

{
  "groupId":"com.my.company",
  "artifactId":"MyClient",
  "artifactVersion":"1.2.0",
  "library":"feign"
}

Or if you prefer yaml format it can look like

groupId: "com.my.company"
artifactId: "MyClient"
artifactVersion: "1.2.0"
library: "feign"

For all the unspecified options default values will be used.

Another way to override default options is to extend the config class for the specific language. To change, for example, the prefix for the Objective-C generated files, simply subclass the ObjcClientCodegen.java:

package com.mycompany.openapitools.codegen;

import org.openapitools.codegen.languages.*;

public class MyObjcCodegen extends ObjcClientCodegen {
    static {
        PREFIX = "HELLO";
    }
}

and specify the classname when running the generator:

-g com.mycompany.openapitools.codegen.MyObjcCodegen

Your subclass will now be loaded and overrides the PREFIX value in the superclass.

Bringing your own models​

Sometimes you don't want a model generated. In this case, you can simply specify an import mapping to tell the codegen what not to create. When doing this, every location that references a specific model will -refer back to your classes. Note, this may not apply to all languages...

To specify an import mapping, use the --import-mappings argument and specify the model-to-import logic as such:

--import-mappings Pet=my.models.MyPet

Or for multiple mappings:

--import-mappings Pet=my.models.MyPet,Order=my.models.MyOrder

or

--import-mappings Pet=my.models.MyPet --import-mappings Order=my.models.MyOrder

Name Mapping​

One can map the property name using nameMappings option and parameter name using parameterNameMappings option to something else. Consider the following schema:

    PropertyNameCollision:
      properties:
        _type:
          type: string
        type:
          type: string
        type_:
          type: string
      type: object

_type, type, type_ will result in property name collision in the Java client generator for example. We can resolve the issue using nameMappings by mapping _type to underscoreType, type_ to typeWithUnderscore.

Here is an example to use nameMappings and parameterNameMapping in CLI:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/java/petstore-with-fake-endpoints-models-for-testing-okhttp-gson.yaml  -o /tmp/java2/ --name-mappings _type=underscoreType,type_=typeWithUnderscore, --parameter-name-mappings _type=paramType,type_=typeParam

To map model names, use modelNameMappings option, e.g.

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g csharp -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml  -o /tmp/csharp/ --model-name-mappings Tag=Label

will rename the Tag schema to Label instead.

To map enum names, use enumNameMappings option, e.g.

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml  -o /tmp/java/ --enum-name-mappings sold=UNAVAILABLE

will rename SOLD to UNAVAILABLE instead.

Not all generators support thess features yet. Please give it a try to confirm the behaviour and open an issue (ticket) to let us know which generators you would like to have this feature enabled and we'll prioritize accordingly. We also welcome PRs to add these features to generators. Related PRs for reference: #16209, #16234 (modelNameMappings), #16194, #16206 (nameMappings, parameterNameMappings), #17108 (enumNameMappings).

NOTE: some generators use baseName (original name obtained direclty from OpenAPI spec, e.g. shipping-date) mustache tag in the templates so the mapping feature won't work.

To map operationId (used in method naming) to something else, use operationIdNameMappings option, e.g.

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml  -o /tmp/java/ --operation-id-name-mappings getPetById=returnPetById

will name the API method as returnPetById instead of getPetById obtained from OpenAPI doc/spec.

Schema Mapping​

One can map the schema to something else (e.g. external objects/models outside of the package) using the schemaMappings option, e.g. in CLI

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/type-alias.yaml -o /tmp/java2/ --schema-mappings TypeAlias=foo.bar.TypeAlias

Another example (in conjunction with --type-mappings):

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i /tmp/alias.yaml -o /tmp/alias/ --schema-mappings stream=org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody --type-mappings string+binary=stream

while /tmp/alias.yaml is as follows:

openapi: 3.0.3
info:
  title: Demo app
  version: 1.0.0
servers:
  - url: /api/v1
paths:
  /demo:
    get:
      summary: Demo
      operationId: demo
      responses:
        '200':
          description: Demo response
          content:
            text/csv:
              schema:
                type: string
                format: binary

Inline Schema Naming​

Inline schemas are created as separate schemas automatically and the auto-generated schema name may not look good to everyone. One can customize the name using the title field or the inlineSchemaNameMapping option. For exmaple, run the following,

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i  modules/openapi-generator/src/test/resources/3_0/inline_model_resolver.yaml -o /tmp/java3/ --skip-validate-spec --inline-schema-name-mappings inline_object_2=SomethingMapped,inline_object_4=nothing_new

will show the following in the console:

[main] INFO  o.o.codegen.InlineModelResolver - Inline schema created as arbitraryObjectRequestBodyProperty_request. To have complete control of the model name, set the `title` field or use the inlineSchemaNameMapping option (--inline-schema-name-mappings in CLI).
[main] INFO  o.o.codegen.InlineModelResolver - Inline schema created as meta_200_response. To have complete control of the model name, set the `title` field or use the inlineSchemaNameMapping option (--inline-schema-name-mappings in CLI).

For example, to name the inline schema meta_200_response as MetaObject, use the --inline-schema-name-mappings option as follows:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i  modules/openapi-generator/src/test/resources/3_0/inline_model_resolver.yaml -o /tmp/java3/ --skip-validate-spec --inline-schema-name-mappings meta_200_response=MetaObject,arbitraryObjectRequestBodyProperty_request=ArbitraryRequest

Another useful option is inlineSchemaOptions, which allows you to customize how inline schemas are handled or named

--inline-schema-options ARRAY_ITEM_SUFFIX=_array_item,MAP_ITEM_SUFFIX=_map_item,RESOLVE_INLINE_ENUMS=true
  • ARRAY_ITEM_SUFFIX sets the array item suffix
  • MAP_ITEM_SUFFIX set the map item suffix
  • SKIP_SCHEMA_REUSE=true is a special value to skip reusing inline schemas during refactoring
  • REFACTOR_ALLOF_INLINE_SCHEMAS=true will restore the 6.x (or below) behaviour to refactor allOf inline schemas into $ref. (v7.0.0 will skip the refactoring of these allOf inline schmeas by default)
  • RESOLVE_INLINE_ENUMS=true will refactor inline enum definitions into $ref

OpenAPI Normalizer​

OpenAPI Normalizer transforms the input OpenAPI doc/spec (which may not perfectly conform to the specification) to make it workable with OpenAPI Generator. A few rules are switched on by default since 7.0.0 release:

  • SIMPLIFY_ONEOF_ANYOF
  • SIMPLIFY_BOOLEAN_ENUM

(One can use DISABLE_ALL=true to disable all the rules)

Here is a list of rules supported:

  • REF_AS_PARENT_IN_ALLOF: when set to true, child schemas in allOf is considered a parent if it's a $ref (instead of inline schema).

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/allOf_extension_parent.yaml -o /tmp/java-okhttp/ --openapi-normalizer REF_AS_PARENT_IN_ALLOF=true
  • REMOVE_ANYOF_ONEOF_AND_KEEP_PROPERTIES_ONLY: when set to true, oneOf/anyOf schema with only required properies only in a schema with properties will be removed. (example)

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/removeAnyOfOneOfAndKeepPropertiesOnly_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer REMOVE_ANYOF_ONEOF_AND_KEEP_PROPERTIES_ONLY=true
  • SIMPLIFY_ANYOF_STRING_AND_ENUM_STRING: when set to true, simplify anyOf schema with string and enum of string to just string

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/simplifyAnyOfStringAndEnumString_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SIMPLIFY_ANYOF_STRING_AND_ENUM_STRING=true
  • SIMPLIFY_BOOLEAN_ENUM: when set to true, convert boolean enum to just enum.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/simplifyBooleanEnum_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SIMPLIFY_BOOLEAN_ENUM=true
  • SIMPLIFY_ONEOF_ANYOF: when set to true, simplify oneOf/anyOf by 1) removing null (sub-schema) or enum of null (sub-schema) and setting nullable to true instead, and 2) simplifying oneOf/anyOf with a single sub-schema to just the sub-schema itself.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/simplifyOneOfAnyOf_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SIMPLIFY_ONEOF_ANYOF=true
  • KEEP_ONLY_FIRST_TAG_IN_OPERATION: when set to true, only keep the first tag in operation if there are more than one tag defined.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/enableKeepOnlyFirstTagInOperation_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer KEEP_ONLY_FIRST_TAG_IN_OPERATION=true
  • SET_TAGS_FOR_ALL_OPERATIONS: when set to a string value, tags in all operations will reset to the string value provided.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/enableKeepOnlyFirstTagInOperation_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_TAGS_FOR_ALL_OPERATIONS=another_tag_name
  • SET_TAGS_TO_OPERATIONID: when set to true, tags in all operations will be set to operationId or "default" if operationId is empty

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_TAGS_TO_OPERATIONID=true
  • ADD_UNSIGNED_TO_INTEGER_WITH_INVALID_MAX_VALUE: when set to true, auto fix integer with maximum value 4294967295 (2^32-1) or long with 18446744073709551615 (2^64-1) by adding x-unsigned to the schema

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/addUnsignedToIntegerWithInvalidMaxValue_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer ADD_UNSIGNED_TO_INTEGER_WITH_INVALID_MAX_VALUE=true
  • REFACTOR_ALLOF_WITH_PROPERTIES_ONLY: When set to true, refactor schema with allOf and properties in the same level to a schema with allOf only and, the allOf contains a new schema containing the properties in the top level.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/allOf_extension_parent.yaml -o /tmp/java-okhttp/ --openapi-normalizer REFACTOR_ALLOF_WITH_PROPERTIES_ONLY=true
  • REMOVE_X_INTERNAL: Set to true if you want to disable the default behavior of removing/hiding the x-internal in operations and model

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/enableKeepOnlyFirstTagInOperation_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer REMOVE_X_INTERNAL=true
  • FILTER: When set to operationId:addPet|getPetById for example, it will add x-internal:true to operations with operationId not equal to addPet/getPetById (which will have x-internal set to false) so that these operations marked as internal won't be generated.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer FILTER="operationId:addPet|getPetById"
  • SET_CONTAINER_TO_NULLABLE: When set to array|set|map (or just array) for example, it will set nullable in array, set and map to true.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_CONTAINER_TO_NULLABLE="array|map"
  • SET_PRIMITIVE_TYPES_TO_NULLABLE: When set to string|integer|number|boolean (or just string) for example, it will set the type to nullable (nullable: true)

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_PRIMITIVE_TYPES_TO_NULLABLE="integer|number"
- +refer back to your classes. Note, this may not apply to all languages...

To specify an import mapping, use the --import-mappings argument and specify the model-to-import logic as such:

--import-mappings Pet=my.models.MyPet

Or for multiple mappings:

--import-mappings Pet=my.models.MyPet,Order=my.models.MyOrder

or

--import-mappings Pet=my.models.MyPet --import-mappings Order=my.models.MyOrder

Name Mapping​

One can map the property name using nameMappings option and parameter name using parameterNameMappings option to something else. Consider the following schema:

    PropertyNameCollision:
      properties:
        _type:
          type: string
        type:
          type: string
        type_:
          type: string
      type: object

_type, type, type_ will result in property name collision in the Java client generator for example. We can resolve the issue using nameMappings by mapping _type to underscoreType, type_ to typeWithUnderscore.

Here is an example to use nameMappings and parameterNameMapping in CLI:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/java/petstore-with-fake-endpoints-models-for-testing-okhttp-gson.yaml  -o /tmp/java2/ --name-mappings _type=underscoreType,type_=typeWithUnderscore, --parameter-name-mappings _type=paramType,type_=typeParam

To map model names, use modelNameMappings option, e.g.

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g csharp -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml  -o /tmp/csharp/ --model-name-mappings Tag=Label

will rename the Tag schema to Label instead.

To map enum names, use enumNameMappings option, e.g.

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml  -o /tmp/java/ --enum-name-mappings sold=UNAVAILABLE

will rename SOLD to UNAVAILABLE instead.

Not all generators support thess features yet. Please give it a try to confirm the behaviour and open an issue (ticket) to let us know which generators you would like to have this feature enabled and we'll prioritize accordingly. We also welcome PRs to add these features to generators. Related PRs for reference: #16209, #16234 (modelNameMappings), #16194, #16206 (nameMappings, parameterNameMappings), #17108 (enumNameMappings).

NOTE: some generators use baseName (original name obtained direclty from OpenAPI spec, e.g. shipping-date) mustache tag in the templates so the mapping feature won't work.

To map operationId (used in method naming) to something else, use operationIdNameMappings option, e.g.

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml  -o /tmp/java/ --operation-id-name-mappings getPetById=returnPetById

will name the API method as returnPetById instead of getPetById obtained from OpenAPI doc/spec.

Schema Mapping​

One can map the schema to something else (e.g. external objects/models outside of the package) using the schemaMappings option, e.g. in CLI

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/type-alias.yaml -o /tmp/java2/ --schema-mappings TypeAlias=foo.bar.TypeAlias

Another example (in conjunction with --type-mappings):

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i /tmp/alias.yaml -o /tmp/alias/ --schema-mappings stream=org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody --type-mappings string+binary=stream

while /tmp/alias.yaml is as follows:

openapi: 3.0.3
info:
  title: Demo app
  version: 1.0.0
servers:
  - url: /api/v1
paths:
  /demo:
    get:
      summary: Demo
      operationId: demo
      responses:
        '200':
          description: Demo response
          content:
            text/csv:
              schema:
                type: string
                format: binary

Inline Schema Naming​

Inline schemas are created as separate schemas automatically and the auto-generated schema name may not look good to everyone. One can customize the name using the title field or the inlineSchemaNameMapping option. For exmaple, run the following,

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i  modules/openapi-generator/src/test/resources/3_0/inline_model_resolver.yaml -o /tmp/java3/ --skip-validate-spec --inline-schema-name-mappings inline_object_2=SomethingMapped,inline_object_4=nothing_new

will show the following in the console:

[main] INFO  o.o.codegen.InlineModelResolver - Inline schema created as arbitraryObjectRequestBodyProperty_request. To have complete control of the model name, set the `title` field or use the inlineSchemaNameMapping option (--inline-schema-name-mappings in CLI).
[main] INFO  o.o.codegen.InlineModelResolver - Inline schema created as meta_200_response. To have complete control of the model name, set the `title` field or use the inlineSchemaNameMapping option (--inline-schema-name-mappings in CLI).

For example, to name the inline schema meta_200_response as MetaObject, use the --inline-schema-name-mappings option as follows:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i  modules/openapi-generator/src/test/resources/3_0/inline_model_resolver.yaml -o /tmp/java3/ --skip-validate-spec --inline-schema-name-mappings meta_200_response=MetaObject,arbitraryObjectRequestBodyProperty_request=ArbitraryRequest

Another useful option is inlineSchemaOptions, which allows you to customize how inline schemas are handled or named

--inline-schema-options ARRAY_ITEM_SUFFIX=_array_item,MAP_ITEM_SUFFIX=_map_item,RESOLVE_INLINE_ENUMS=true
  • ARRAY_ITEM_SUFFIX sets the array item suffix
  • MAP_ITEM_SUFFIX set the map item suffix
  • SKIP_SCHEMA_REUSE=true is a special value to skip reusing inline schemas during refactoring
  • REFACTOR_ALLOF_INLINE_SCHEMAS=true will restore the 6.x (or below) behaviour to refactor allOf inline schemas into $ref. (v7.0.0 will skip the refactoring of these allOf inline schmeas by default)
  • RESOLVE_INLINE_ENUMS=true will refactor inline enum definitions into $ref

OpenAPI Normalizer​

OpenAPI Normalizer transforms the input OpenAPI doc/spec (which may not perfectly conform to the specification) to make it workable with OpenAPI Generator. A few rules are switched on by default since 7.0.0 release:

  • SIMPLIFY_ONEOF_ANYOF
  • SIMPLIFY_BOOLEAN_ENUM

(One can use DISABLE_ALL=true to disable all the rules)

Here is a list of rules supported:

  • REF_AS_PARENT_IN_ALLOF: when set to true, child schemas in allOf is considered a parent if it's a $ref (instead of inline schema).

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/allOf_extension_parent.yaml -o /tmp/java-okhttp/ --openapi-normalizer REF_AS_PARENT_IN_ALLOF=true
  • REMOVE_ANYOF_ONEOF_AND_KEEP_PROPERTIES_ONLY: when set to true, oneOf/anyOf schema with only required properies only in a schema with properties will be removed. (example)

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/removeAnyOfOneOfAndKeepPropertiesOnly_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer REMOVE_ANYOF_ONEOF_AND_KEEP_PROPERTIES_ONLY=true
  • SIMPLIFY_ANYOF_STRING_AND_ENUM_STRING: when set to true, simplify anyOf schema with string and enum of string to just string

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/simplifyAnyOfStringAndEnumString_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SIMPLIFY_ANYOF_STRING_AND_ENUM_STRING=true
  • SIMPLIFY_BOOLEAN_ENUM: when set to true, convert boolean enum to just enum.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/simplifyBooleanEnum_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SIMPLIFY_BOOLEAN_ENUM=true
  • SIMPLIFY_ONEOF_ANYOF: when set to true, simplify oneOf/anyOf by 1) removing null (sub-schema) or enum of null (sub-schema) and setting nullable to true instead, and 2) simplifying oneOf/anyOf with a single sub-schema to just the sub-schema itself.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/simplifyOneOfAnyOf_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SIMPLIFY_ONEOF_ANYOF=true
  • KEEP_ONLY_FIRST_TAG_IN_OPERATION: when set to true, only keep the first tag in operation if there are more than one tag defined.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/enableKeepOnlyFirstTagInOperation_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer KEEP_ONLY_FIRST_TAG_IN_OPERATION=true
  • SET_TAGS_FOR_ALL_OPERATIONS: when set to a string value, tags in all operations will reset to the string value provided.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/enableKeepOnlyFirstTagInOperation_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_TAGS_FOR_ALL_OPERATIONS=another_tag_name
  • SET_TAGS_TO_OPERATIONID: when set to true, tags in all operations will be set to operationId or "default" if operationId is empty

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_TAGS_TO_OPERATIONID=true
  • ADD_UNSIGNED_TO_INTEGER_WITH_INVALID_MAX_VALUE: when set to true, auto fix integer with maximum value 4294967295 (2^32-1) or long with 18446744073709551615 (2^64-1) by adding x-unsigned to the schema

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/addUnsignedToIntegerWithInvalidMaxValue_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer ADD_UNSIGNED_TO_INTEGER_WITH_INVALID_MAX_VALUE=true
  • REFACTOR_ALLOF_WITH_PROPERTIES_ONLY: When set to true, refactor schema with allOf and properties in the same level to a schema with allOf only and, the allOf contains a new schema containing the properties in the top level.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/allOf_extension_parent.yaml -o /tmp/java-okhttp/ --openapi-normalizer REFACTOR_ALLOF_WITH_PROPERTIES_ONLY=true
  • REMOVE_X_INTERNAL: Set to true if you want to disable the default behavior of removing/hiding the x-internal in operations and model

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/enableKeepOnlyFirstTagInOperation_test.yaml -o /tmp/java-okhttp/ --openapi-normalizer REMOVE_X_INTERNAL=true
  • FILTER: When set to operationId:addPet|getPetById for example, it will add x-internal:true to operations with operationId not equal to addPet/getPetById (which will have x-internal set to false) so that these operations marked as internal won't be generated.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer FILTER="operationId:addPet|getPetById"
  • SET_CONTAINER_TO_NULLABLE: When set to array|set|map (or just array) for example, it will set nullable in array, set and map to true.

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_CONTAINER_TO_NULLABLE="array|map"
  • SET_PRIMITIVE_TYPES_TO_NULLABLE: When set to string|integer|number|boolean (or just string) for example, it will set the type to nullable (nullable: true)

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_PRIMITIVE_TYPES_TO_NULLABLE="integer|number"
  • FIX_DUPLICATED_OPERATIONID: When set to true, an integer suffix will be added to duplicated operationId(s), e.g. getName => getName_0, getName_1, etc

Example:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_1/java/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer FIX_DUPLICATED_OPERATIONID=true
+ \ No newline at end of file diff --git a/docs/debugging/index.html b/docs/debugging/index.html index ed715e9f9ef..df1e1877548 100644 --- a/docs/debugging/index.html +++ b/docs/debugging/index.html @@ -15,13 +15,13 @@ - +

Debugging

Generation​

As a user there may be times when generated outputs don't match your expectations it's unclear why. The CLI supports a --dry-run option which may be used to inspect the anticipated file operations without making changes to the file system.

Suppose you generate using the --minimal-update option, and you notice on subsequent generations of a client that no files have changed. This is by design.

For example, if you generate the aspnetcore generator passing --minimal-update --dry-run to the sample generation script in the code repository:

export JAVA_OPTS="-Dlog.level=off"
./bin/generate-samples.sh ./bin/configs/lua.yaml -- --minimal-update --dry-run

You'll see the output similar to the following:

$ ./bin/generate-samples.sh ./bin/configs/lua.yaml -- --minimal-update --dry-run
# START SCRIPT: ./bin/generate-samples.sh
This script generates all configs under bin/configs by default.
You may generate a targeted script or set of scripts using glob patterns.

For example:
    ./bin/generate-samples.sh bin/configs/java-*

You may generate a single config with additional options if you use -- to
separate the single config file from the generator arguments.

For example:
    ./bin/generate-samples.sh bin/configs/java-vertx.yaml -- --global-property debugModels=true


[main] INFO  o.o.codegen.DefaultGenerator - Generating with dryRun=true
[main] INFO  o.o.codegen.DefaultGenerator - OpenAPI Generator: lua (client)
[main] INFO  o.o.codegen.DefaultGenerator - Generator 'lua' is considered beta.
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] INFO  o.o.codegen.DefaultGenerator - Model inline_object (marked as unused due to form parameters) is generated due to the system property skipFormModel=false (default)
[main] INFO  o.o.codegen.DefaultGenerator - Model inline_object_1 (marked as unused due to form parameters) is generated due to the system property skipFormModel=false (default)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/json)
[main] WARN  o.o.codegen.DefaultCodegen - Multiple MediaTypes found, using only the first one
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/json)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] WARN  o.o.codegen.utils.ModelUtils - Multiple schemas found in the OAS 'content' section, returning only the first one (application/xml)
[main] ERROR o.o.codegen.DefaultGenerator - 

Dry Run Results:

k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/.openapi-generator-ignore
n /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/.openapi-generator/VERSION
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/api_response_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/category_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/inline_object_1_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/inline_object_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/order_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/pet_api_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/pet_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/store_api_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/tag_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/user_api_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/user_spec.lua


States:

  - w Write
  - n Write if New/Updated
  - i Ignored
  - s Skipped Overwrite
  - k Skipped by user option(s)
  - e Error evaluating file write state


[main] ERROR o.o.codegen.DefaultGenerator - 

Dry Run Results:

k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/.openapi-generator-ignore
n /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/.openapi-generator/VERSION
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/api_response_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/category_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/inline_object_1_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/inline_object_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/order_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/pet_api_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/pet_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/store_api_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/tag_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/user_api_spec.lua
k /Users/williamcheng/Code/openapi-generator/samples/client/petstore/lua/spec/user_spec.lua


States:

  - w Write
  - n Write if New/Updated
  - i Ignored
  - s Skipped Overwrite
  - k Skipped by user option(s)
  - e Error evaluating file write state

The output lists the files which would be written in a normal run of the tool. Notice that we skip .openapi-generator-ignore because the file exists and we don't want to blow away the user's generation rules. Most of these files will overwrite output files only if the contents slated for write are different from those on the filesystem; this is denoted by an n preceding the filename. Some of the above lines begin with a w, meaning these files will always result in a write operation.

If you find an operation that you feel should result in a different state, please open an issue or submit a pull request to change the behavior (we welcome all contributions).

Templates​

Sometimes, you may have issues with variables in your templates. As discussed in the templating docs, we offer a variety of system properties for inspecting the models bound to templates.

--global-property debugOpenAPI
Prints out the JSON model of the OpenAPI Document, as seen by OpenAPI Generator
--global-property debugModels
Prints out the JSON model passed to model templates
--global-property debugOperations
Prints out the JSON model passed to operation (api) templates
--global-property debugSupportingFiles
Prints out the JSON model passed to supporting files

One or more of these properties can be passed alongside other command line options:

openapi-generator generate -g go \
    -o out \
    -i petstore-minimal.yaml \
    --global-property debugModels,debugOperations

Or you can add these to your JAVA_OPTS environment variable (this applies to every invocation of the tool):

export JAVA_OPTS="${JAVA_OPTS} --global-property debugModels,debugOperations"

NOTE: Globally available system options like these will apply to all invocations of the generator (CLI and plugins)

Runtime​

When you're working with a custom generator, a new generator, or otherwise trying to understand the behavior of the toolset, you may need to attach a remote debugger in order to step through the code.

The steps are shown here for a specific version of the generator, but apply the same if you're working off master or a feature branch.

  • Determine the version of openapi-generator you're using. For the CLI, this is: 

    openapi-generator version

  • Navigate to the openapi-generator source directory (see building docs for obtaining source code and brief introduction).

  • Checkout the branch/tag for the target version. Branches are not prefixed, but tags are prefixed with a v. For instance if you're using version 3.3.0, you will execute:

    git checkout v3.3.0

  • Open the project in your IDE.

  • Setup your IDE for remote debugging. You'll want to define a port used for connecting the remote debugger. For this example, we'll use 5005. See external tutorials for IntelliJ and Eclipse

  • Export the debug configuration, specifying suspend=y so you have time to attach a remote debugger. These are passed as Java system properties, either on command line or as part of the JAVA_OPTS environment variable. This will look like:

    export JAVA_OPTS="${JAVA_OPTS} -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005"

  • Execute the generator with your desired options. You should see the application output only

    Listening for transport dt_socket at address: 5005

  • Set breakpoints in code, and then attach your remote debugger from your IDE (see above). The generator will automatically unblock once the remote debugger is attached. You can now step through the code.

    For VSCode you can use the following launch configuration (launch.json):

    {
        "version": "0.2.0",
        "configurations": [
            {
                "type": "java",
                "name": "Debug (Attach)",
                "request": "attach",
                "hostName": "localhost",
                "port": 5005
            }
        ]
    }

    to attach the the suspended process above.

Logs​

You can try to enable debugging log with -Dlog.level=debug option to the JAVA_OPTS environment variable to see more information:

export JAVA_OPTS="${JAVA_OPTS} -Dlog.level=debug"

Set the option then DEBUG logs are printed out:

openapi-generator generate -g go ...

...
...
[main] DEBUG o.o.codegen.DefaultCodegen - debugging fromProperty for files : class Schema {
    type: null
    format: null
    $ref: #/components/schemas/File
...
...
- + \ No newline at end of file diff --git a/docs/faq-contributing/index.html b/docs/faq-contributing/index.html index 9d0ce98d494..ef4bc1293c3 100644 --- a/docs/faq-contributing/index.html +++ b/docs/faq-contributing/index.html @@ -15,7 +15,7 @@ - + @@ -27,7 +27,7 @@ 5) git commit -a (you may need to use git add filename to add new files) 6) git push origin fix_issue9999 7) Visit https://github.com/openapitools/openapi-generator in your browser and click on the button to file a new PR based on fix_issue9999

- + \ No newline at end of file diff --git a/docs/faq-extending/index.html b/docs/faq-extending/index.html index f28f65b9968..aeb7172878d 100644 --- a/docs/faq-extending/index.html +++ b/docs/faq-extending/index.html @@ -15,13 +15,13 @@ - +

FAQ: Extending

How do I use my own Java models?​

See Bringing your own Models.

How do I disable certificate verification?​

Please add -Dio.swagger.v3.parser.util.RemoteUrl.trustAll=true when generating the code.

How do I skip files during code generation?​

OpenAPI Generator has a built-in ignore file processor.

For example, to skip git_push.sh, one can create a file named .openapi-generator-ignore in the root of the output directory with the contents:

# Prevent generator from creating these files:
git_push.sh

The ignore file works just like .gitignore, and it is auto-generated by default.

If you need this functionality on initial generation, you can provide the option --ignore-file-override (CLI) or ignoreFileOverride (Maven and Gradle plugins) with a value targeting any existing file. The contents of that file will be evaluated relative to the output directory.

How can I customize the auto-generated code?​

Variants:

  • "How can I add a header/footer to generated code?"
  • "How can I add my own logging to generated code?"
  • "How can I add my license to the top of files?"

OpenAPI Generator supports user-defined templates without need to recompile the artifact. We also support custom generators (templates and logic) if those generators are accessible on the classpath.

See templating: Modifying Templates and customization docs for more details.

- + \ No newline at end of file diff --git a/docs/faq-generators/index.html b/docs/faq-generators/index.html index 091971cd04b..6e163ed755b 100644 --- a/docs/faq-generators/index.html +++ b/docs/faq-generators/index.html @@ -15,7 +15,7 @@ - + @@ -30,7 +30,7 @@ There is a new swift6 generator, that is currently in beta, try it BearerTokenHandler.swift

How do I implement bearer token authentication with Alamofire on the Swift 6 API client?​

First implement the Alamofire RequestInterceptor protocol.

class BearerTokenHandler: RequestInterceptor, @unchecked Sendable {
    private var bearerToken: String? = nil
    
    func adapt(_ urlRequest: URLRequest, for session: Session, completion: @escaping (Result<URLRequest, Error>) -> Void) {
        if let bearerToken = bearerToken {
            var urlRequest = urlRequest
            urlRequest.setValue("Bearer \(bearerToken)", forHTTPHeaderField: "Authorization")
            
            completion(.success(urlRequest))
            return
        }
        
        completion(.success(urlRequest))
    }
    
    func retry(_ request: Request, for session: Session, dueTo error: Error, completion: @escaping (RetryResult) -> Void) {
        if let response = request.task?.response as? HTTPURLResponse, response.statusCode == 401 {
            startRefreshingToken { isTokenRefreshed in
                completion(.retry)
            }
        } else {
            completion(.doNotRetryWithError(error))
        }
    }
    
    private func startRefreshingToken(completionHandler: @escaping (Bool) -> Void) {
        // Get a bearer token
        let dummyBearerToken = "..."
        
        bearerToken = dummyBearerToken
        OpenAPIClient.shared.customHeaders["Authorization"] = "Bearer \(dummyBearerToken)"
        
        completionHandler(true)
    }
}

Then you assign the BearerTokenHandler to the property OpenAPIClient.shared.interceptor.

OpenAPIClient.shared.interceptor = BearerTokenHandler()

Here is a working sample that put's together all of this. AppDelegate.swift BearerTokenHandler.swift

How do I migrate from the Swift 5 generator to the swift 6 generator?​

  • Change the generator to the new swift6 generator, e.g. openapi-generator generate -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g swift6 -o /tmp/test/
  • Check the swift6 URLSession and Alamofire samples.
  • The infrastructure files have been moved to a new directory called Infrastructure. Please delete the old ones.
  • The AnyCodable dependency has been removed and replaced with a new enum called JSONValue, allowing you to use this generator without external dependencies.
  • The Combine response is now deferred by default, meaning the request will only start when you begin listening to it. To restore the previous behavior, set the combineDeferred flag to false.
  • A new configuration, apiStaticMethod, allows you to use instance methods instead of class methods for API calls. For more information, check the sample project apiNonStaticMethod.
  • The new default response is based on async/await. To revert to the previous behavior, set the responseAs flag to ObjcBlock.
  • The default project structure now follows the SPM (Swift Package Manager) structure. To revert to the old structure, set the useSPMFileStructure flag to false.
  • The former {{projectName}}API is now called OpenAPIClient.
  • You can now set a request interceptor and retrier by configuring OpenAPIClient.shared.interceptor, making authenticated requests easier to manage.

TypeScript​

The JSON response fails to deserialize due to change in variable naming (snake_case to camelCase). Is there any way to keep the original naming?​

Yes, please use the following option when generating TypeScript clients:

    modelPropertyNaming
        Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
- + \ No newline at end of file diff --git a/docs/faq/index.html b/docs/faq/index.html index c956a220960..24658c358f9 100644 --- a/docs/faq/index.html +++ b/docs/faq/index.html @@ -15,13 +15,13 @@ - +

FAQ: General

Do you have a chat room?​

Join the Slack chat room

What is the governance structure of the OpenAPI Generator project?​

OpenAPI generator (openapi-generator) is managed by the members of the core team.

What is the difference between Swagger Codegen and OpenAPI Generator?​

Swagger Codegen is driven by SmartBear while OpenAPI Generator is driven by the community. More than 40 top contributors and template creators of Swagger Codegen have joined OpenAPI Generator as the founding team members. For more details, see the Fork Q&A.

Swagger is a trademark owned by SmartBear and the use of the term "Swagger" in this project is for demo (reference) purposes only.

- + \ No newline at end of file diff --git a/docs/file-post-processing/index.html b/docs/file-post-processing/index.html index 76a1697a58a..240d19fb4af 100644 --- a/docs/file-post-processing/index.html +++ b/docs/file-post-processing/index.html @@ -15,13 +15,13 @@ - +

File post-processing

Each tool (CLI and plugins) supports enabling file post-processing at a high-level. Enabling this option allows for generators which support post-processing to call some external process for each generated file, passing the file path to that tool. The external tool must be defined in an environment variable supported by the generator.

Note that:

  • this option is --enable-post-process-file in the CLI and enablePostProcessFile in plugins
  • we require both specifying the environment variable and enabling the option at the tooling level; this feature is opt-in for security
  • file processing occurs one at a time
  • the external tool may be a custom script which invokes multiple tools

Also refer to the relevant documentation for CLI, Maven Plugin, Gradle Plugin, or SBT Plugin.

Supported Environment Variables​

The following environment variables are supported by their respective generators:

  • AVRO_POST_PROCESS_FILE
  • CPP_POST_PROCESS_FILE
  • CSHARP_POST_PROCESS_FILE
  • C_POST_PROCESS_FILE
  • DART_POST_PROCESS_FILE
  • FSHARP_POST_PROCESS_FILE
  • GO_POST_PROCESS_FILE
  • HASKELL_POST_PROCESS_FILE
  • JAVA_POST_PROCESS_FILE
  • JS_POST_PROCESS_FILE
  • KOTLIN_POST_PROCESS_FILE
  • OCAML_POST_PROCESS_FILE
  • PERL_POST_PROCESS_FILE
  • PHP_POST_PROCESS_FILE
  • POWERSHELL_POST_PROCESS_FILE
  • PYTHON_POST_PROCESS_FILE
  • RUBY_POST_PROCESS_FILE
  • RUST_POST_PROCESS_FILE
  • SCALA_POST_PROCESS_FILE
  • SWIFT_POST_PROCESS_FILE
  • TS_POST_PROCESS_FILE

Example​

Let's see how to pass Ruby generated files to Rubocop, a static code analysis/linter/formatter tool.

# First, export the required environment variable
export RUBY_POST_PROCESS_FILE="/usr/local/bin/rubocop -a"

export OPENAPI_DOC="https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml"

# Invoke the generator with --enable-post-process-file
openapi-generator generate --enable-post-process-file -i $OPENAPI_DOC -g ruby -o .out-ruby/

You will now see messages logged about which files have been processed:

[main] INFO  o.o.codegen.TemplateManager - writing file /Users/jim/projects/openapi-generator/.out-ruby/.rspec
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/jim/projects/openapi-generator/.out-ruby/spec/spec_helper.rb
[main] INFO  o.o.c.languages.AbstractRubyCodegen - Successfully executed: /usr/local/bin/rubocopy -a /Users/jim/projects/openapi-generator/.out-ruby/spec/spec_helper.rb
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/jim/projects/openapi-generator/.out-ruby/spec/configuration_spec.rb
[main] INFO  o.o.c.languages.AbstractRubyCodegen - Successfully executed: /usr/local/bin/rubocopy -a /Users/jim/projects/openapi-generator/.out-ruby/spec/configuration_spec.rb
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/jim/projects/openapi-generator/.out-ruby/spec/api_client_spec.rb
[main] INFO  o.o.c.languages.AbstractRubyCodegen - Successfully executed: /usr/local/bin/rubocopy -a /Users/jim/projects/openapi-generator/.out-ruby/spec/api_client_spec.rb
[main] INFO  o.o.codegen.TemplateManager - Skipped /Users/jim/projects/openapi-generator/.out-ruby/.openapi-generator-ignore (Skipped by supportingFiles options supplied by user.)
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/jim/projects/openapi-generator/.out-ruby/.openapi-generator/VERSION
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/jim/projects/openapi-generator/.out-ruby/.openapi-generator/FILES
- + \ No newline at end of file diff --git a/docs/fork-qna/index.html b/docs/fork-qna/index.html index 8022de29368..61899818d68 100644 --- a/docs/fork-qna/index.html +++ b/docs/fork-qna/index.html @@ -15,13 +15,13 @@ - +

Swagger Codegen Fork: Q&A

This document aims to answer some questions about the fork for historical reference, where these questions don't fit into other documents related to the project itself.

Why was it decided to fork Swagger Codegen?​

There are several reasons:

  1. The founding members felt that Swagger Codegen 3.0.0 was diverging too much from the philosophy of Swagger Codegen 2.x.
  2. The founding members were concerned that the maintenance overhead of two separate branches (2.x, 3.x) would result in issues similar to those felt in the Python community.
  3. The founding members wanted a more rapid release cycle (weekly patch release, monthly minor release) so users do not need to wait for several months to get a stable release.
  4. Having a community-driven version allows for innovation, reliability, and a roadmap owned by the community.

Are there any changes to the project license?​

No, OpenAPI Generator is still using the Apache license (version 2).

I am currently using Swagger Codegen 2.x. How can I upgrade the generator to OpenAPI Generator?​

OpenAPI Generator is based on Swagger Codegen 2.4.0-SNAPSHOT version so the migration should be relatively straightforward. Refer to the migration guide for more information.

Who maintains this Q&A page?​

This Q&A page is maintained by the core team members. It is not maintained by any single person, nor do these Q&As represent the views of any individual or person.

- + \ No newline at end of file diff --git a/docs/generators/ada-server/index.html b/docs/generators/ada-server/index.html index 45fcaed53cd..032263b49a8 100644 --- a/docs/generators/ada-server/index.html +++ b/docs/generators/ada-server/index.html @@ -15,13 +15,13 @@ - +

Documentation for the ada-server Generator

METADATA​

PropertyValueNotes
generator nameada-serverpass this to the generate command after -g
generator stabilitySTABLE
generator typeSERVER
generator languageAda
generator default templating enginemustache
helpTxtGenerates an Ada server implementation (beta).

CONFIG OPTIONS​

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

OptionDescriptionValuesDefault
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
false
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
true
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
true
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
false
No changes to the enum's are made, this is the default option.
true
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
false
httpSupportThe name of the HTTP support library. Possible values include 'curl' or 'aws'.null
legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
true
The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
false
The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
true
openApiNameThe name of the Ada package which provides support for OpenAPI for the generated client and server code. The default is 'Swagger'.null
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
projectNameGNAT project namedefaultProject
sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

IMPORT MAPPING​

Type/AliasImports

INSTANTIATION TYPES​

Type/AliasInstantiated By

LANGUAGE PRIMITIVES​

  • DateTime
  • binary
  • boolean
  • date
  • double
  • float
  • integer
  • long
  • number
  • object
  • string

RESERVED WORDS​

  • abort
  • abs
  • abstract
  • accept
  • access
  • aliased
  • all
  • and
  • array
  • at
  • begin
  • body
  • case
  • constant
  • declare
  • delay
  • digits
  • do
  • else
  • elsif
  • end
  • entry
  • exception
  • exit
  • for
  • function
  • generic
  • goto
  • if
  • in
  • interface
  • is
  • limited
  • loop
  • mod
  • new
  • not
  • null
  • of
  • or
  • others
  • out
  • overriding
  • package
  • pragma
  • private
  • procedure
  • protected
  • raise
  • range
  • record
  • rem
  • renames
  • requeue
  • return
  • reverse
  • select
  • separate
  • some
  • subtype
  • synchronized
  • tagged
  • task
  • terminate
  • then
  • type
  • until
  • use
  • when
  • while
  • with
  • xor

FEATURE SET​

Client Modification Feature​

NameSupportedDefined By
BasePath✓ToolingExtension
Authorizations✗ToolingExtension
UserAgent✗ToolingExtension
MockServer✗ToolingExtension

Data Type Feature​

NameSupportedDefined By
Custom✗OAS2,OAS3
Int32✓OAS2,OAS3
Int64✓OAS2,OAS3
Float✓OAS2,OAS3
Double✓OAS2,OAS3
Decimal✓ToolingExtension
String✓OAS2,OAS3
Byte✓OAS2,OAS3
Binary✓OAS2,OAS3
Boolean✓OAS2,OAS3
Date✓OAS2,OAS3
DateTime✓OAS2,OAS3
Password✓OAS2,OAS3
File✓OAS2
Uuid✗
Array✓OAS2,OAS3
Null✗OAS3
AnyType✗OAS2,OAS3
Object✓OAS2,OAS3
Maps✓ToolingExtension
CollectionFormat✓OAS2
CollectionFormatMulti✓OAS2
Enum✓OAS2,OAS3
ArrayOfEnum✓ToolingExtension
ArrayOfModel✓ToolingExtension
ArrayOfCollectionOfPrimitives✓ToolingExtension
ArrayOfCollectionOfModel✓ToolingExtension
ArrayOfCollectionOfEnum✓ToolingExtension
MapOfEnum✓ToolingExtension
MapOfModel✓ToolingExtension
MapOfCollectionOfPrimitives✓ToolingExtension
MapOfCollectionOfModel✓ToolingExtension
MapOfCollectionOfEnum✓ToolingExtension

Documentation Feature​

NameSupportedDefined By
Readme✓ToolingExtension
Model✓ToolingExtension
Api✓ToolingExtension

Global Feature​

NameSupportedDefined By
Host✓OAS2,OAS3
BasePath✓OAS2,OAS3
Info✓OAS2,OAS3
Schemes✗OAS2,OAS3
PartialSchemes✓OAS2,OAS3
Consumes✓OAS2
Produces✓OAS2
ExternalDocumentation✓OAS2,OAS3
Examples✓OAS2,OAS3
XMLStructureDefinitions✗OAS2,OAS3
MultiServer✗OAS3
ParameterizedServer✗OAS3
ParameterStyling✗OAS3
Callbacks✗OAS3
LinkObjects✗OAS3

Parameter Feature​

NameSupportedDefined By
Path✓OAS2,OAS3
Query✓OAS2,OAS3
Header✗OAS2,OAS3
Body✓OAS2
FormUnencoded✓OAS2
FormMultipart✓OAS2
Cookie✗OAS3

Schema Support Feature​

NameSupportedDefined By
Simple✓OAS2,OAS3
Composite✓OAS2,OAS3
Polymorphism✗OAS2,OAS3
Union✗OAS3
allOf✗OAS2,OAS3
anyOf✗OAS3
oneOf✗OAS3
not✗OAS3

Security Feature​

NameSupportedDefined By
BasicAuth✗OAS2,OAS3
ApiKey✗OAS2,OAS3
OpenIDConnect✗OAS3
BearerToken✓OAS3
OAuth2_Implicit✓OAS2,OAS3
OAuth2_Password✓OAS2,OAS3
OAuth2_ClientCredentials✓OAS2,OAS3
OAuth2_AuthorizationCode✓OAS2,OAS3
SignatureAuth✗OAS3
AWSV4Signature✗ToolingExtension

Wire Format Feature​

NameSupportedDefined By
JSON✓OAS2,OAS3
XML✓OAS2,OAS3
PROTOBUF✗ToolingExtension
Custom✗OAS2,OAS3
- + \ No newline at end of file diff --git a/docs/generators/ada/index.html b/docs/generators/ada/index.html index 9e125a48bb8..af67e947896 100644 --- a/docs/generators/ada/index.html +++ b/docs/generators/ada/index.html @@ -15,13 +15,13 @@ - +

Documentation for the ada Generator

METADATA​

PropertyValueNotes
generator nameadapass this to the generate command after -g
generator stabilitySTABLE
generator typeCLIENT
generator languageAda
generator default templating enginemustache
helpTxtGenerates an Ada client implementation (beta).

CONFIG OPTIONS​

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

OptionDescriptionValuesDefault
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
false
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
true
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
true
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
false
No changes to the enum's are made, this is the default option.
true
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
false
httpSupportThe name of the HTTP support library. Possible values include 'curl' or 'aws'.null
legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
true
The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
false
The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
true
openApiNameThe name of the Ada package which provides support for OpenAPI for the generated client and server code. The default is 'Swagger'.null
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
projectNameGNAT project namedefaultProject
sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

IMPORT MAPPING​

Type/AliasImports

INSTANTIATION TYPES​

Type/AliasInstantiated By

LANGUAGE PRIMITIVES​

  • DateTime
  • binary
  • boolean
  • date
  • double
  • float
  • integer
  • long
  • number
  • object
  • string

RESERVED WORDS​

  • abort
  • abs
  • abstract
  • accept
  • access
  • aliased
  • all
  • and
  • array
  • at
  • begin
  • body
  • case
  • constant
  • declare
  • delay
  • digits
  • do
  • else
  • elsif
  • end
  • entry
  • exception
  • exit
  • for
  • function
  • generic
  • goto
  • if
  • in
  • interface
  • is
  • limited
  • loop
  • mod
  • new
  • not
  • null
  • of
  • or
  • others
  • out
  • overriding
  • package
  • pragma
  • private
  • procedure
  • protected
  • raise
  • range
  • record
  • rem
  • renames
  • requeue
  • return
  • reverse
  • select
  • separate
  • some
  • subtype
  • synchronized
  • tagged
  • task
  • terminate
  • then
  • type
  • until
  • use
  • when
  • while
  • with
  • xor

FEATURE SET​

Client Modification Feature​

NameSupportedDefined By
BasePath✓ToolingExtension
Authorizations✗ToolingExtension
UserAgent✗ToolingExtension
MockServer✗ToolingExtension

Data Type Feature​

NameSupportedDefined By
Custom✗OAS2,OAS3
Int32✓OAS2,OAS3
Int64✓OAS2,OAS3
Float✓OAS2,OAS3
Double✓OAS2,OAS3
Decimal✓ToolingExtension
String✓OAS2,OAS3
Byte✓OAS2,OAS3
Binary✓OAS2,OAS3
Boolean✓OAS2,OAS3
Date✓OAS2,OAS3
DateTime✓OAS2,OAS3
Password✓OAS2,OAS3
File✓OAS2
Uuid✗
Array✓OAS2,OAS3
Null✗OAS3
AnyType✗OAS2,OAS3
Object✓OAS2,OAS3
Maps✓ToolingExtension
CollectionFormat✓OAS2
CollectionFormatMulti✓OAS2
Enum✓OAS2,OAS3
ArrayOfEnum✓ToolingExtension
ArrayOfModel✓ToolingExtension
ArrayOfCollectionOfPrimitives✓ToolingExtension
ArrayOfCollectionOfModel✓ToolingExtension
ArrayOfCollectionOfEnum✓ToolingExtension
MapOfEnum✓ToolingExtension
MapOfModel✓ToolingExtension
MapOfCollectionOfPrimitives✓ToolingExtension
MapOfCollectionOfModel✓ToolingExtension
MapOfCollectionOfEnum✓ToolingExtension

Documentation Feature​

NameSupportedDefined By
Readme✗ToolingExtension
Model✓ToolingExtension
Api✓ToolingExtension

Global Feature​

NameSupportedDefined By
Host✓OAS2,OAS3
BasePath✓OAS2,OAS3
Info✓OAS2,OAS3
Schemes✗OAS2,OAS3
PartialSchemes✓OAS2,OAS3
Consumes✓OAS2
Produces✓OAS2
ExternalDocumentation✓OAS2,OAS3
Examples✓OAS2,OAS3
XMLStructureDefinitions✗OAS2,OAS3
MultiServer✗OAS3
ParameterizedServer✗OAS3
ParameterStyling✗OAS3
Callbacks✗OAS3
LinkObjects✗OAS3

Parameter Feature​

NameSupportedDefined By
Path✓OAS2,OAS3
Query✓OAS2,OAS3
Header✗OAS2,OAS3
Body✓OAS2
FormUnencoded✓OAS2
FormMultipart✓OAS2
Cookie✗OAS3

Schema Support Feature​

NameSupportedDefined By
Simple✓OAS2,OAS3
Composite✓OAS2,OAS3
Polymorphism✗OAS2,OAS3
Union✗OAS3
allOf✗OAS2,OAS3
anyOf✗OAS3
oneOf✗OAS3
not✗OAS3

Security Feature​

NameSupportedDefined By
BasicAuth✗OAS2,OAS3
ApiKey✗OAS2,OAS3
OpenIDConnect✗OAS3
BearerToken✓OAS3
OAuth2_Implicit✓OAS2,OAS3
OAuth2_Password✓OAS2,OAS3
OAuth2_ClientCredentials✓OAS2,OAS3
OAuth2_AuthorizationCode✓OAS2,OAS3
SignatureAuth✗OAS3
AWSV4Signature✗ToolingExtension

Wire Format Feature​

NameSupportedDefined By
JSON✓OAS2,OAS3
XML✓OAS2,OAS3
PROTOBUF✗ToolingExtension
Custom✗OAS2,OAS3
- + \ No newline at end of file diff --git a/docs/generators/android/index.html b/docs/generators/android/index.html index 9006e41653b..849f97cedeb 100644 --- a/docs/generators/android/index.html +++ b/docs/generators/android/index.html @@ -15,13 +15,13 @@ - +

Documentation for the android Generator

METADATA​

PropertyValueNotes
generator nameandroidpass this to the generate command after -g
generator stabilitySTABLE
generator typeCLIENT
generator languageJava
generator default templating enginemustache
helpTxtGenerates an Android client library.

CONFIG OPTIONS​

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

OptionDescriptionValuesDefault
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
androidBuildToolsVersionbuildToolsVersion version for use in the generated build.gradlenull
androidGradleVersiongradleVersion version for use in the generated build.gradlenull
androidSdkVersioncompileSdkVersion version for use in the generated build.gradlenull
apiPackagepackage for generated api classesnull
artifactIdartifactId for use in the generated build.gradle and pom.xmlnull
artifactVersionartifact version for use in the generated build.gradle and pom.xmlnull
disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
false
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
true
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
true
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
false
No changes to the enum's are made, this is the default option.
true
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
false
groupIdgroupId for use in the generated build.gradle and pom.xmlnull
invokerPackageroot package for generated codenull
legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
true
The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
false
The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
true
librarylibrary template (sub-template) to use
volley
HTTP client: Volley 1.0.19 (default)
httpclient
HTTP client: Apache HttpClient 4.3.6. JSON processing: Gson 2.3.1. IMPORTANT: Android client using HttpClient is not actively maintained and will be deprecated in the next major release.
null
modelPackagepackage for generated modelsnull
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
sourceFoldersource folder for generated codenull
useAndroidMavenGradlePluginA flag to toggle android-maven gradle plugin.true

IMPORT MAPPING​

Type/AliasImports
Arrayjava.util.List
ArrayListjava.util.ArrayList
BigDecimaljava.math.BigDecimal
Datejava.util.Date
Filejava.io.File
HashMapjava.util.HashMap
Listjava.util.*
Mapjava.util.Map
Setjava.util.*
URIjava.net.URI
UUIDjava.util.UUID

INSTANTIATION TYPES​

Type/AliasInstantiated By
arrayArrayList
mapHashMap

LANGUAGE PRIMITIVES​

  • Boolean
  • Double
  • Float
  • Integer
  • Long
  • Object
  • String
  • boolean
  • byte[]

RESERVED WORDS​

  • abstract
  • apiinvoker
  • assert
  • authnames
  • basepath
  • boolean
  • break
  • byte
  • case
  • catch
  • char
  • class
  • const
  • continue
  • default
  • do
  • double
  • else
  • enum
  • extends
  • final
  • finally
  • float
  • for
  • goto
  • if
  • implements
  • import
  • instanceof
  • int
  • interface
  • localvarbuilder
  • localvarcontenttype
  • localvarcontenttypes
  • localvarformparams
  • localvarheaderparams
  • localvarpath
  • localvarpostbody
  • localvarqueryparams
  • localvarresponse
  • long
  • native
  • new
  • null
  • object
  • package
  • private
  • protected
  • public
  • return
  • short
  • static
  • strictfp
  • super
  • switch
  • synchronized
  • this
  • throw
  • throws
  • transient
  • try
  • void
  • volatile
  • while

FEATURE SET​

Client Modification Feature​

NameSupportedDefined By
BasePath✓ToolingExtension
Authorizations✗ToolingExtension
UserAgent✗ToolingExtension
MockServer✗ToolingExtension

Data Type Feature​

NameSupportedDefined By
Custom✗OAS2,OAS3
Int32✓OAS2,OAS3
Int64✓OAS2,OAS3
Float✓OAS2,OAS3
Double✓OAS2,OAS3
Decimal✓ToolingExtension
String✓OAS2,OAS3
Byte✓OAS2,OAS3
Binary✓OAS2,OAS3
Boolean✓OAS2,OAS3
Date✓OAS2,OAS3
DateTime✓OAS2,OAS3
Password✓OAS2,OAS3
File✓OAS2
Uuid✗
Array✓OAS2,OAS3
Null✗OAS3
AnyType✗OAS2,OAS3
Object✓OAS2,OAS3
Maps✓ToolingExtension
CollectionFormat✓OAS2
CollectionFormatMulti✓OAS2
Enum✓OAS2,OAS3
ArrayOfEnum✓ToolingExtension
ArrayOfModel✓ToolingExtension
ArrayOfCollectionOfPrimitives✓ToolingExtension
ArrayOfCollectionOfModel✓ToolingExtension
ArrayOfCollectionOfEnum✓ToolingExtension
MapOfEnum✓ToolingExtension
MapOfModel✓ToolingExtension
MapOfCollectionOfPrimitives✓ToolingExtension
MapOfCollectionOfModel✓ToolingExtension
MapOfCollectionOfEnum✓ToolingExtension

Documentation Feature​

NameSupportedDefined By
Readme✓ToolingExtension
Model✓ToolingExtension
Api✓ToolingExtension

Global Feature​

NameSupportedDefined By
Host✓OAS2,OAS3
BasePath✓OAS2,OAS3
Info✓OAS2,OAS3
Schemes✗OAS2,OAS3
PartialSchemes✓OAS2,OAS3
Consumes✓OAS2
Produces✓OAS2
ExternalDocumentation✓OAS2,OAS3
Examples✓OAS2,OAS3
XMLStructureDefinitions✗OAS2,OAS3
MultiServer✗OAS3
ParameterizedServer✗OAS3
ParameterStyling✗OAS3
Callbacks✗OAS3
LinkObjects✗OAS3

Parameter Feature​

NameSupportedDefined By
Path✓OAS2,OAS3
Query✓OAS2,OAS3
Header✓OAS2,OAS3
Body✓OAS2
FormUnencoded✓OAS2
FormMultipart✓OAS2
Cookie✗OAS3

Schema Support Feature​

NameSupportedDefined By
Simple✓OAS2,OAS3
Composite✓OAS2,OAS3
Polymorphism✓OAS2,OAS3
Union✗OAS3
allOf✗OAS2,OAS3
anyOf✗OAS3
oneOf✗OAS3
not✗OAS3

Security Feature​

NameSupportedDefined By
BasicAuth✓OAS2,OAS3
ApiKey✓OAS2,OAS3
OpenIDConnect✗OAS3
BearerToken✗OAS3
OAuth2_Implicit✗OAS2,OAS3
OAuth2_Password✗OAS2,OAS3
OAuth2_ClientCredentials✗OAS2,OAS3
OAuth2_AuthorizationCode✗OAS2,OAS3
SignatureAuth✗OAS3
AWSV4Signature✗ToolingExtension

Wire Format Feature​

NameSupportedDefined By
JSON✓OAS2,OAS3
XML✓OAS2,OAS3
PROTOBUF✗ToolingExtension
Custom✗OAS2,OAS3
- + \ No newline at end of file diff --git a/docs/generators/apache2/index.html b/docs/generators/apache2/index.html index 05c74d3906a..b680cd87d36 100644 --- a/docs/generators/apache2/index.html +++ b/docs/generators/apache2/index.html @@ -15,13 +15,13 @@ - +

Documentation for the apache2 Generator

METADATA​

PropertyValueNotes
generator nameapache2pass this to the generate command after -g
generator stabilitySTABLE
generator typeCONFIG
generator languageJava
generator default templating enginemustache
helpTxtGenerates an Apache2 Config file with the permissions

CONFIG OPTIONS​

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

OptionDescriptionValuesDefault
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
false
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
true
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
true
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
false
No changes to the enum's are made, this is the default option.
true
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
false
legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
true
The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
false
The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
true
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
userInfoPathPath to the user and group filesnull

IMPORT MAPPING​

Type/AliasImports

INSTANTIATION TYPES​

Type/AliasInstantiated By

LANGUAGE PRIMITIVES​

    RESERVED WORDS​

      FEATURE SET​

      Client Modification Feature​

      NameSupportedDefined By
      BasePath✗ToolingExtension
      Authorizations✗ToolingExtension
      UserAgent✗ToolingExtension
      MockServer✗ToolingExtension

      Data Type Feature​

      NameSupportedDefined By
      Custom✗OAS2,OAS3
      Int32✗OAS2,OAS3
      Int64✗OAS2,OAS3
      Float✗OAS2,OAS3
      Double✗OAS2,OAS3
      Decimal✗ToolingExtension
      String✗OAS2,OAS3
      Byte✗OAS2,OAS3
      Binary✗OAS2,OAS3
      Boolean✗OAS2,OAS3
      Date✗OAS2,OAS3
      DateTime✗OAS2,OAS3
      Password✗OAS2,OAS3
      File✗OAS2
      Uuid✗
      Array✗OAS2,OAS3
      Null✗OAS3
      AnyType✗OAS2,OAS3
      Object✗OAS2,OAS3
      Maps✗ToolingExtension
      CollectionFormat✗OAS2
      CollectionFormatMulti✗OAS2
      Enum✗OAS2,OAS3
      ArrayOfEnum✗ToolingExtension
      ArrayOfModel✗ToolingExtension
      ArrayOfCollectionOfPrimitives✗ToolingExtension
      ArrayOfCollectionOfModel✗ToolingExtension
      ArrayOfCollectionOfEnum✗ToolingExtension
      MapOfEnum✗ToolingExtension
      MapOfModel✗ToolingExtension
      MapOfCollectionOfPrimitives✗ToolingExtension
      MapOfCollectionOfModel✗ToolingExtension
      MapOfCollectionOfEnum✗ToolingExtension

      Documentation Feature​

      NameSupportedDefined By
      Readme✗ToolingExtension
      Model✗ToolingExtension
      Api✗ToolingExtension

      Global Feature​

      NameSupportedDefined By
      Host✗OAS2,OAS3
      BasePath✗OAS2,OAS3
      Info✗OAS2,OAS3
      Schemes✗OAS2,OAS3
      PartialSchemes✗OAS2,OAS3
      Consumes✗OAS2
      Produces✗OAS2
      ExternalDocumentation✗OAS2,OAS3
      Examples✗OAS2,OAS3
      XMLStructureDefinitions✗OAS2,OAS3
      MultiServer✗OAS3
      ParameterizedServer✗OAS3
      ParameterStyling✗OAS3
      Callbacks✗OAS3
      LinkObjects✗OAS3

      Parameter Feature​

      NameSupportedDefined By
      Path✓OAS2,OAS3
      Query✗OAS2,OAS3
      Header✗OAS2,OAS3
      Body✗OAS2
      FormUnencoded✗OAS2
      FormMultipart✗OAS2
      Cookie✗OAS3

      Schema Support Feature​

      NameSupportedDefined By
      Simple✗OAS2,OAS3
      Composite✗OAS2,OAS3
      Polymorphism✗OAS2,OAS3
      Union✗OAS3
      allOf✗OAS2,OAS3
      anyOf✗OAS3
      oneOf✗OAS3
      not✗OAS3

      Security Feature​

      NameSupportedDefined By
      BasicAuth✓OAS2,OAS3
      ApiKey✗OAS2,OAS3
      OpenIDConnect✗OAS3
      BearerToken✗OAS3
      OAuth2_Implicit✗OAS2,OAS3
      OAuth2_Password✗OAS2,OAS3
      OAuth2_ClientCredentials✗OAS2,OAS3
      OAuth2_AuthorizationCode✗OAS2,OAS3
      SignatureAuth✗OAS3
      AWSV4Signature✗ToolingExtension

      Wire Format Feature​

      NameSupportedDefined By
      JSON✗OAS2,OAS3
      XML✗OAS2,OAS3
      PROTOBUF✗ToolingExtension
      Custom✗OAS2,OAS3
      - + \ No newline at end of file diff --git a/docs/generators/apex/index.html b/docs/generators/apex/index.html index ff6ef1ba303..3a15366ac9e 100644 --- a/docs/generators/apex/index.html +++ b/docs/generators/apex/index.html @@ -15,13 +15,13 @@ - +

      Documentation for the apex Generator

      METADATA​

      PropertyValueNotes
      generator nameapexpass this to the generate command after -g
      generator stabilitySTABLE
      generator typeCLIENT
      generator languageApex
      generator default templating enginemustache
      helpTxtGenerates an Apex API client library.

      CONFIG OPTIONS​

      These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

      OptionDescriptionValuesDefault
      allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
      apiVersionThe Metadata API version number to use for components in this package.null
      buildMethodThe build method for this package.null
      classPrefixPrefix for generated classes. Set this to avoid overwriting existing classes in your org.null
      disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
      false
      The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
      true
      Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
      		true
      ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
      enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
      false
      No changes to the enum's are made, this is the default option.
      true
      With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
      		false
      legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
      true
      The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
      false
      The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
      		true
      namedCredentialThe named credential name for the HTTP calloutsnull
      prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
      sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
      sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

      IMPORT MAPPING​

      Type/AliasImports

      INSTANTIATION TYPES​

      Type/AliasInstantiated By
      arrayList
      mapMap

      LANGUAGE PRIMITIVES​

      • Blob
      • Boolean
      • Date
      • Datetime
      • Decimal
      • Double
      • ID
      • Integer
      • Long
      • Object
      • String
      • Time

      RESERVED WORDS​

      • abstract
      • activate
      • and
      • any
      • array
      • as
      • asc
      • autonomous
      • begin
      • bigdecimal
      • blob
      • boolean
      • break
      • bulk
      • by
      • byte
      • case
      • cast
      • catch
      • char
      • class
      • collect
      • commit
      • const
      • continue
      • currency
      • date
      • datetime
      • decimal
      • default
      • delete
      • desc
      • do
      • double
      • else
      • end
      • enum
      • exception
      • exit
      • export
      • extends
      • false
      • final
      • finally
      • float
      • for
      • from
      • global
      • goto
      • group
      • having
      • hint
      • if
      • implements
      • import
      • in
      • inner
      • insert
      • instanceof
      • int
      • integer
      • interface
      • into
      • join
      • like
      • limit
      • list
      • long
      • loop
      • map
      • merge
      • new
      • not
      • null
      • nulls
      • number
      • object
      • of
      • on
      • or
      • outer
      • override
      • package
      • parallel
      • pragma
      • private
      • protected
      • public
      • retrieve
      • return
      • rollback
      • select
      • set
      • short
      • sobject
      • sort
      • static
      • string
      • super
      • switch
      • synchronized
      • system
      • testmethod
      • then
      • this
      • throw
      • time
      • transaction
      • trigger
      • true
      • try
      • undelete
      • update
      • upsert
      • using
      • virtual
      • void
      • webservice
      • when
      • where
      • while

      FEATURE SET​

      Client Modification Feature​

      NameSupportedDefined By
      BasePath✗ToolingExtension
      Authorizations✗ToolingExtension
      UserAgent✗ToolingExtension
      MockServer✗ToolingExtension

      Data Type Feature​

      NameSupportedDefined By
      Custom✗OAS2,OAS3
      Int32✓OAS2,OAS3
      Int64✓OAS2,OAS3
      Float✓OAS2,OAS3
      Double✓OAS2,OAS3
      Decimal✓ToolingExtension
      String✓OAS2,OAS3
      Byte✓OAS2,OAS3
      Binary✓OAS2,OAS3
      Boolean✓OAS2,OAS3
      Date✓OAS2,OAS3
      DateTime✓OAS2,OAS3
      Password✓OAS2,OAS3
      File✓OAS2
      Uuid✗
      Array✓OAS2,OAS3
      Null✗OAS3
      AnyType✗OAS2,OAS3
      Object✓OAS2,OAS3
      Maps✓ToolingExtension
      CollectionFormat✓OAS2
      CollectionFormatMulti✓OAS2
      Enum✓OAS2,OAS3
      ArrayOfEnum✓ToolingExtension
      ArrayOfModel✓ToolingExtension
      ArrayOfCollectionOfPrimitives✓ToolingExtension
      ArrayOfCollectionOfModel✓ToolingExtension
      ArrayOfCollectionOfEnum✓ToolingExtension
      MapOfEnum✓ToolingExtension
      MapOfModel✓ToolingExtension
      MapOfCollectionOfPrimitives✓ToolingExtension
      MapOfCollectionOfModel✓ToolingExtension
      MapOfCollectionOfEnum✓ToolingExtension

      Documentation Feature​

      NameSupportedDefined By
      Readme✗ToolingExtension
      Model✓ToolingExtension
      Api✓ToolingExtension

      Global Feature​

      NameSupportedDefined By
      Host✓OAS2,OAS3
      BasePath✓OAS2,OAS3
      Info✓OAS2,OAS3
      Schemes✗OAS2,OAS3
      PartialSchemes✓OAS2,OAS3
      Consumes✓OAS2
      Produces✓OAS2
      ExternalDocumentation✓OAS2,OAS3
      Examples✓OAS2,OAS3
      XMLStructureDefinitions✗OAS2,OAS3
      MultiServer✗OAS3
      ParameterizedServer✗OAS3
      ParameterStyling✗OAS3
      Callbacks✓OAS3
      LinkObjects✗OAS3

      Parameter Feature​

      NameSupportedDefined By
      Path✓OAS2,OAS3
      Query✓OAS2,OAS3
      Header✓OAS2,OAS3
      Body✓OAS2
      FormUnencoded✓OAS2
      FormMultipart✓OAS2
      Cookie✓OAS3

      Schema Support Feature​

      NameSupportedDefined By
      Simple✓OAS2,OAS3
      Composite✓OAS2,OAS3
      Polymorphism✓OAS2,OAS3
      Union✗OAS3
      allOf✗OAS2,OAS3
      anyOf✗OAS3
      oneOf✗OAS3
      not✗OAS3

      Security Feature​

      NameSupportedDefined By
      BasicAuth✓OAS2,OAS3
      ApiKey✓OAS2,OAS3
      OpenIDConnect✗OAS3
      BearerToken✓OAS3
      OAuth2_Implicit✓OAS2,OAS3
      OAuth2_Password✓OAS2,OAS3
      OAuth2_ClientCredentials✓OAS2,OAS3
      OAuth2_AuthorizationCode✓OAS2,OAS3
      SignatureAuth✗OAS3
      AWSV4Signature✗ToolingExtension

      Wire Format Feature​

      NameSupportedDefined By
      JSON✓OAS2,OAS3
      XML✓OAS2,OAS3
      PROTOBUF✗ToolingExtension
      Custom✗OAS2,OAS3
      - + \ No newline at end of file diff --git a/docs/generators/asciidoc/index.html b/docs/generators/asciidoc/index.html index 670d0eb45c1..64989596e6d 100644 --- a/docs/generators/asciidoc/index.html +++ b/docs/generators/asciidoc/index.html @@ -15,13 +15,13 @@ - +

      Documentation for the asciidoc Generator

      METADATA​

      PropertyValueNotes
      generator nameasciidocpass this to the generate command after -g
      generator stabilitySTABLE
      generator typeDOCUMENTATION
      generator languageJava
      generator default templating enginemustache
      helpTxtGenerates asciidoc markup based documentation.

      CONFIG OPTIONS​

      These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

      OptionDescriptionValuesDefault
      allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
      appDescriptiondescription of the applicationnull
      appNameshort name of the applicationnull
      artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
      artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.null
      disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
      false
      The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
      true
      Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
      		true
      ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
      enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
      false
      No changes to the enum's are made, this is the default option.
      true
      With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
      		false
      groupIdgroupId in generated pom.xmlnull
      headerAttributesgeneration of asciidoc header meta data attributes (set to false to suppress, default: true)true
      infoEmailan email address to contact for inquiries about the applicationnull
      infoUrla URL where users can get more information about the applicationnull
      invokerPackageroot package for generated codenull
      legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
      true
      The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
      false
      The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
      		true
      licenseInfoa short description of the licensenull
      licenseUrla URL pointing to the full licensenull
      prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
      skipExamplesskip examples sections (default: false)false
      snippetDirpath with includable markup snippets (e.g. test output generated by restdoc, default: .).
      sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
      sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
      specDirpath with includable markup spec files (e.g. handwritten additional docs, default: ..)..
      useIntroductionuse introduction section, rather than an initial abstract (default: false)false
      useMethodAndPathUse HTTP method and path as operation heading, instead of operation id (default: false)false
      useTableTitlesUse titles for tables, rather than wrapping tables instead their own section (default: false)false

      IMPORT MAPPING​

      Type/AliasImports

      INSTANTIATION TYPES​

      Type/AliasInstantiated By

      LANGUAGE PRIMITIVES​

        RESERVED WORDS​

          FEATURE SET​

          Client Modification Feature​

          NameSupportedDefined By
          BasePath✗ToolingExtension
          Authorizations✗ToolingExtension
          UserAgent✗ToolingExtension
          MockServer✗ToolingExtension

          Data Type Feature​

          NameSupportedDefined By
          Custom✗OAS2,OAS3
          Int32✓OAS2,OAS3
          Int64✓OAS2,OAS3
          Float✓OAS2,OAS3
          Double✓OAS2,OAS3
          Decimal✓ToolingExtension
          String✓OAS2,OAS3
          Byte✓OAS2,OAS3
          Binary✓OAS2,OAS3
          Boolean✓OAS2,OAS3
          Date✓OAS2,OAS3
          DateTime✓OAS2,OAS3
          Password✓OAS2,OAS3
          File✓OAS2
          Uuid✗
          Array✓OAS2,OAS3
          Null✗OAS3
          AnyType✗OAS2,OAS3
          Object✓OAS2,OAS3
          Maps✓ToolingExtension
          CollectionFormat✓OAS2
          CollectionFormatMulti✓OAS2
          Enum✓OAS2,OAS3
          ArrayOfEnum✓ToolingExtension
          ArrayOfModel✓ToolingExtension
          ArrayOfCollectionOfPrimitives✓ToolingExtension
          ArrayOfCollectionOfModel✓ToolingExtension
          ArrayOfCollectionOfEnum✓ToolingExtension
          MapOfEnum✓ToolingExtension
          MapOfModel✓ToolingExtension
          MapOfCollectionOfPrimitives✓ToolingExtension
          MapOfCollectionOfModel✓ToolingExtension
          MapOfCollectionOfEnum✓ToolingExtension

          Documentation Feature​

          NameSupportedDefined By
          Readme✗ToolingExtension
          Model✗ToolingExtension
          Api✗ToolingExtension

          Global Feature​

          NameSupportedDefined By
          Host✗OAS2,OAS3
          BasePath✗OAS2,OAS3
          Info✗OAS2,OAS3
          Schemes✗OAS2,OAS3
          PartialSchemes✗OAS2,OAS3
          Consumes✗OAS2
          Produces✗OAS2
          ExternalDocumentation✗OAS2,OAS3
          Examples✗OAS2,OAS3
          XMLStructureDefinitions✗OAS2,OAS3
          MultiServer✗OAS3
          ParameterizedServer✗OAS3
          ParameterStyling✗OAS3
          Callbacks✗OAS3
          LinkObjects✗OAS3

          Parameter Feature​

          NameSupportedDefined By
          Path✓OAS2,OAS3
          Query✓OAS2,OAS3
          Header✓OAS2,OAS3
          Body✓OAS2
          FormUnencoded✓OAS2
          FormMultipart✓OAS2
          Cookie✓OAS3

          Schema Support Feature​

          NameSupportedDefined By
          Simple✗OAS2,OAS3
          Composite✗OAS2,OAS3
          Polymorphism✗OAS2,OAS3
          Union✗OAS3
          allOf✗OAS2,OAS3
          anyOf✗OAS3
          oneOf✗OAS3
          not✗OAS3

          Security Feature​

          NameSupportedDefined By
          BasicAuth✗OAS2,OAS3
          ApiKey✗OAS2,OAS3
          OpenIDConnect✗OAS3
          BearerToken✗OAS3
          OAuth2_Implicit✗OAS2,OAS3
          OAuth2_Password✗OAS2,OAS3
          OAuth2_ClientCredentials✗OAS2,OAS3
          OAuth2_AuthorizationCode✗OAS2,OAS3
          SignatureAuth✗OAS3
          AWSV4Signature✗ToolingExtension

          Wire Format Feature​

          NameSupportedDefined By
          JSON✓OAS2,OAS3
          XML✓OAS2,OAS3
          PROTOBUF✗ToolingExtension
          Custom✗OAS2,OAS3
          - + \ No newline at end of file diff --git a/docs/generators/aspnet-fastendpoints/index.html b/docs/generators/aspnet-fastendpoints/index.html index ae3560dabee..67b6edc4f80 100644 --- a/docs/generators/aspnet-fastendpoints/index.html +++ b/docs/generators/aspnet-fastendpoints/index.html @@ -15,13 +15,13 @@ - +

          Documentation for the aspnet-fastendpoints Generator

          METADATA​

          PropertyValueNotes
          generator nameaspnet-fastendpointspass this to the generate command after -g
          generator stabilitySTABLE
          generator typeSERVER
          generator languageC#
          generator default templating enginemustache
          helpTxtGenerates a server for FastEndpoints (https://fast-endpoints.com/).

          CONFIG OPTIONS​

          These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

          OptionDescriptionValuesDefault
          allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
          apiVersionThe version of the API. Used only if useApiVersioning is true1
          disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
          false
          The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
          true
          Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
          		true
          ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
          enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
          false
          No changes to the enum's are made, this is the default option.
          true
          With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
          		false
          legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
          true
          The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
          false
          The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
          		true
          prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
          projectConfigurationGuidThe project configuration GUID to be used in the solution file (auto generated if not provided)null
          routePrefixThe route prefix for the API. Used only if useApiVersioning is trueapi
          solutionGuidThe solution GUID to be used in the solution file (auto generated if not provided)null
          sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
          sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
          useApiVersioningEnable API versioning (https://fast-endpoints.com/docs/api-versioning).false
          useAuthenticationEnable authentication (https://fast-endpoints.com/docs/security).false
          useProblemDetailsEnable RFC compatible error responses (https://fast-endpoints.com/docs/configuration-settings#rfc7807-rfc9457-compatible-problem-details).false
          useRecordsUse record instead of class for the requests and response.false
          useResponseCachingEnable response caching (https://fast-endpoints.com/docs/response-caching).false
          useValidatorsEnable request validators (https://fast-endpoints.com/docs/validation).false
          versioningPrefixThe versioning prefix for the API. Used only if useApiVersioning is truev

          IMPORT MAPPING​

          Type/AliasImports

          INSTANTIATION TYPES​

          Type/AliasInstantiated By
          arrayList
          listList
          mapDictionary

          LANGUAGE PRIMITIVES​

          • Boolean
          • Collection
          • DateOnly
          • DateOnly?
          • DateTime
          • DateTime?
          • DateTimeOffset
          • DateTimeOffset?
          • Decimal
          • Dictionary
          • Double
          • Float
          • Guid
          • Guid?
          • ICollection
          • Int32
          • Int64
          • List
          • Object
          • String
          • System.IO.Stream
          • bool
          • bool?
          • byte[]
          • decimal
          • decimal?
          • double
          • double?
          • float
          • float?
          • int
          • int?
          • long
          • long?
          • string
          • uint
          • uint?
          • ulong
          • ulong?

          RESERVED WORDS​

          • Client
          • Configuration
          • Environment
          • OperatingSystem
          • TimeZone
          • Version
          • abstract
          • as
          • base
          • bool
          • break
          • byte
          • case
          • catch
          • char
          • checked
          • class
          • client
          • const
          • continue
          • decimal
          • default
          • delegate
          • do
          • double
          • else
          • enum
          • event
          • explicit
          • extern
          • false
          • finally
          • fixed
          • float
          • for
          • foreach
          • goto
          • if
          • implicit
          • in
          • int
          • interface
          • internal
          • is
          • localVarFileParams
          • localVarFormParams
          • localVarHeaderParams
          • localVarHttpContentType
          • localVarHttpContentTypes
          • localVarHttpHeaderAccept
          • localVarHttpHeaderAccepts
          • localVarPath
          • localVarPathParams
          • localVarPostBody
          • localVarQueryParams
          • localVarResponse
          • localVarStatusCode
          • lock
          • long
          • namespace
          • new
          • null
          • object
          • operator
          • out
          • override
          • parameter
          • params
          • private
          • protected
          • public
          • readonly
          • ref
          • return
          • sbyte
          • sealed
          • short
          • sizeof
          • stackalloc
          • static
          • string
          • struct
          • switch
          • system
          • this
          • throw
          • true
          • try
          • typeof
          • uint
          • ulong
          • unchecked
          • unsafe
          • ushort
          • using
          • virtual
          • void
          • volatile
          • while

          FEATURE SET​

          Client Modification Feature​

          NameSupportedDefined By
          BasePath✗ToolingExtension
          Authorizations✗ToolingExtension
          UserAgent✗ToolingExtension
          MockServer✗ToolingExtension

          Data Type Feature​

          NameSupportedDefined By
          Custom✗OAS2,OAS3
          Int32✓OAS2,OAS3
          Int64✓OAS2,OAS3
          Float✓OAS2,OAS3
          Double✓OAS2,OAS3
          Decimal✓ToolingExtension
          String✓OAS2,OAS3
          Byte✓OAS2,OAS3
          Binary✓OAS2,OAS3
          Boolean✓OAS2,OAS3
          Date✓OAS2,OAS3
          DateTime✓OAS2,OAS3
          Password✓OAS2,OAS3
          File✓OAS2
          Uuid✗
          Array✓OAS2,OAS3
          Null✗OAS3
          AnyType✗OAS2,OAS3
          Object✓OAS2,OAS3
          Maps✓ToolingExtension
          CollectionFormat✓OAS2
          CollectionFormatMulti✓OAS2
          Enum✓OAS2,OAS3
          ArrayOfEnum✓ToolingExtension
          ArrayOfModel✓ToolingExtension
          ArrayOfCollectionOfPrimitives✓ToolingExtension
          ArrayOfCollectionOfModel✓ToolingExtension
          ArrayOfCollectionOfEnum✓ToolingExtension
          MapOfEnum✓ToolingExtension
          MapOfModel✓ToolingExtension
          MapOfCollectionOfPrimitives✓ToolingExtension
          MapOfCollectionOfModel✓ToolingExtension
          MapOfCollectionOfEnum✓ToolingExtension

          Documentation Feature​

          NameSupportedDefined By
          Readme✗ToolingExtension
          Model✓ToolingExtension
          Api✓ToolingExtension

          Global Feature​

          NameSupportedDefined By
          Host✓OAS2,OAS3
          BasePath✓OAS2,OAS3
          Info✓OAS2,OAS3
          Schemes✗OAS2,OAS3
          PartialSchemes✓OAS2,OAS3
          Consumes✓OAS2
          Produces✓OAS2
          ExternalDocumentation✓OAS2,OAS3
          Examples✓OAS2,OAS3
          XMLStructureDefinitions✗OAS2,OAS3
          MultiServer✗OAS3
          ParameterizedServer✗OAS3
          ParameterStyling✗OAS3
          Callbacks✓OAS3
          LinkObjects✗OAS3

          Parameter Feature​

          NameSupportedDefined By
          Path✓OAS2,OAS3
          Query✓OAS2,OAS3
          Header✓OAS2,OAS3
          Body✓OAS2
          FormUnencoded✓OAS2
          FormMultipart✓OAS2
          Cookie✓OAS3

          Schema Support Feature​

          NameSupportedDefined By
          Simple✓OAS2,OAS3
          Composite✓OAS2,OAS3
          Polymorphism✓OAS2,OAS3
          Union✗OAS3
          allOf✗OAS2,OAS3
          anyOf✗OAS3
          oneOf✗OAS3
          not✗OAS3

          Security Feature​

          NameSupportedDefined By
          BasicAuth✓OAS2,OAS3
          ApiKey✓OAS2,OAS3
          OpenIDConnect✗OAS3
          BearerToken✓OAS3
          OAuth2_Implicit✓OAS2,OAS3
          OAuth2_Password✓OAS2,OAS3
          OAuth2_ClientCredentials✓OAS2,OAS3
          OAuth2_AuthorizationCode✓OAS2,OAS3
          SignatureAuth✗OAS3
          AWSV4Signature✗ToolingExtension

          Wire Format Feature​

          NameSupportedDefined By
          JSON✓OAS2,OAS3
          XML✓OAS2,OAS3
          PROTOBUF✗ToolingExtension
          Custom✗OAS2,OAS3
          - + \ No newline at end of file diff --git a/docs/generators/aspnetcore/index.html b/docs/generators/aspnetcore/index.html index 9163c277362..fd78a63a09d 100644 --- a/docs/generators/aspnetcore/index.html +++ b/docs/generators/aspnetcore/index.html @@ -15,13 +15,13 @@ - +

          Documentation for the aspnetcore Generator

          METADATA​

          PropertyValueNotes
          generator nameaspnetcorepass this to the generate command after -g
          generator stabilitySTABLE
          generator typeSERVER
          generator languageC#
          generator default templating enginemustache
          helpTxtGenerates an ASP.NET Core Web API server.

          CONFIG OPTIONS​

          These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

          OptionDescriptionValuesDefault
          aspnetCoreVersionASP.NET Core version: 6.0, 5.0, 3.1, 3.0, 2.2, 2.1, 2.0 (deprecated)
          2.0
          ASP.NET Core 2.0
          2.1
          ASP.NET Core 2.1
          2.2
          ASP.NET Core 2.2
          3.0
          ASP.NET Core 3.0
          3.1
          ASP.NET Core 3.1
          5.0
          ASP.NET Core 5.0
          6.0
          ASP.NET Core 6.0
          7.0
          ASP.NET Core 7.0
          8.0
          ASP.NET Core 8.0
          		8.0
          buildTargetTarget to build an application or library
          program
          Generate code for a standalone server
          library
          Generate code for a server abstract class library
          		program
          classModifierClass Modifier for controller classes: Empty string or abstract.
          compatibilityVersionASP.Net Core CompatibilityVersionVersion_2_2
          enumNameSuffixSuffix that will be appended to all enum names.Enum
          enumValueSuffixSuffix that will be appended to all enum values.Enum
          generateBodyGenerates method body.true
          isLibraryIs the build a libraryfalse
          licenseNameThe name of the licenseNoLicense
          licenseUrlThe URL of the licensehttp://localhost
          modelClassModifierModel Class Modifier can be nothing or partialpartial
          newtonsoftVersionVersion for Microsoft.AspNetCore.Mvc.NewtonsoftJson for ASP.NET Core 3.0+3.0.0
          nullableReferenceTypesUse nullable annotations in the project. Only supported on C# 8 / ASP.NET Core 3.1 or newer.false
          operationIsAsyncSet methods to async or sync (default).false
          operationModifierOperation Modifier can be virtual or abstract
          virtual
          Keep method virtual
          abstract
          Make method abstract
          		virtual
          operationResultTaskSet methods result to Task<>.false
          packageAuthorsSpecifies Authors property in the .NET Core project file.OpenAPI
          packageCopyrightSpecifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.No Copyright
          packageDescriptionSpecifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.A library generated from a OpenAPI doc
          packageGuidThe GUID that will be associated with the C# projectnull
          packageNameC# package name (convention: Title.Case).Org.OpenAPITools
          packageTitleSpecifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.OpenAPI Library
          packageVersionC# package version.1.0.0
          pocoModelsBuild POCO Modelsfalse
          returnICollectionReturn ICollection<T> instead of the concrete type.false
          sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
          sourceFoldersource folder for generated codesrc
          swashbuckleVersionSwashbuckle version: 3.0.0 (deprecated), 4.0.0 (deprecated), 5.0.0 (deprecated), 6.4.0
          3.0.0
          Swashbuckle 3.0.0
          4.0.0
          Swashbuckle 4.0.0
          5.0.0
          Swashbuckle 5.0.0
          6.4.0
          Swashbuckle 6.4.0
          		6.4.0
          useCollectionDeserialize array types to Collection<T> instead of List<T>.false
          useDateTimeForDateUse DateTime to model date properties even if DateOnly supported. (.net 6.0+ only)false
          useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
          useDefaultRoutingUse default routing for the ASP.NET Core version.true
          useFrameworkReferenceUse frameworkReference for ASP.NET Core 3.0+ and PackageReference ASP.NET Core 2.2 or earlier.false
          useNewtonsoftUses the Newtonsoft JSON library.true
          useSeparateModelProjectCreate a separate project for modelsfalse
          useSwashbuckleUses the Swashbuckle.AspNetCore NuGet package for documentation.true

          IMPORT MAPPING​

          Type/AliasImports

          INSTANTIATION TYPES​

          Type/AliasInstantiated By
          arrayList
          listList
          mapDictionary

          LANGUAGE PRIMITIVES​

          • Boolean
          • Collection
          • DateOnly
          • DateOnly?
          • DateTime
          • DateTime?
          • DateTimeOffset
          • DateTimeOffset?
          • Decimal
          • Dictionary
          • Double
          • Float
          • Guid
          • Guid?
          • ICollection
          • Int32
          • Int64
          • List
          • Object
          • String
          • System.IO.Stream
          • bool
          • bool?
          • byte[]
          • decimal
          • decimal?
          • double
          • double?
          • float
          • float?
          • int
          • int?
          • long
          • long?
          • string
          • uint
          • uint?
          • ulong
          • ulong?

          RESERVED WORDS​

          • Client
          • Configuration
          • Environment
          • OperatingSystem
          • TimeZone
          • Version
          • abstract
          • as
          • async
          • await
          • base
          • bool
          • break
          • byte
          • case
          • catch
          • char
          • checked
          • class
          • client
          • const
          • continue
          • decimal
          • default
          • delegate
          • do
          • double
          • dynamic
          • else
          • enum
          • event
          • explicit
          • extern
          • false
          • finally
          • fixed
          • float
          • for
          • foreach
          • goto
          • if
          • implicit
          • in
          • int
          • interface
          • internal
          • is
          • localVarFileParams
          • localVarFormParams
          • localVarHeaderParams
          • localVarHttpContentType
          • localVarHttpContentTypes
          • localVarHttpHeaderAccept
          • localVarHttpHeaderAccepts
          • localVarPath
          • localVarPathParams
          • localVarPostBody
          • localVarQueryParams
          • localVarResponse
          • localVarStatusCode
          • lock
          • long
          • namespace
          • new
          • null
          • object
          • operator
          • out
          • override
          • parameter
          • params
          • private
          • protected
          • public
          • readonly
          • ref
          • return
          • sbyte
          • sealed
          • short
          • sizeof
          • stackalloc
          • static
          • string
          • struct
          • switch
          • system
          • this
          • throw
          • true
          • try
          • typeof
          • uint
          • ulong
          • unchecked
          • unsafe
          • ushort
          • using
          • var
          • virtual
          • void
          • volatile
          • while
          • yield

          FEATURE SET​

          Client Modification Feature​

          NameSupportedDefined By
          BasePath✗ToolingExtension
          Authorizations✗ToolingExtension
          UserAgent✗ToolingExtension
          MockServer✗ToolingExtension

          Data Type Feature​

          NameSupportedDefined By
          Custom✗OAS2,OAS3
          Int32✓OAS2,OAS3
          Int64✓OAS2,OAS3
          Float✓OAS2,OAS3
          Double✓OAS2,OAS3
          Decimal✓ToolingExtension
          String✓OAS2,OAS3
          Byte✓OAS2,OAS3
          Binary✓OAS2,OAS3
          Boolean✓OAS2,OAS3
          Date✓OAS2,OAS3
          DateTime✓OAS2,OAS3
          Password✓OAS2,OAS3
          File✓OAS2
          Uuid✗
          Array✓OAS2,OAS3
          Null✗OAS3
          AnyType✗OAS2,OAS3
          Object✓OAS2,OAS3
          Maps✓ToolingExtension
          CollectionFormat✓OAS2
          CollectionFormatMulti✓OAS2
          Enum✓OAS2,OAS3
          ArrayOfEnum✓ToolingExtension
          ArrayOfModel✓ToolingExtension
          ArrayOfCollectionOfPrimitives✓ToolingExtension
          ArrayOfCollectionOfModel✓ToolingExtension
          ArrayOfCollectionOfEnum✓ToolingExtension
          MapOfEnum✓ToolingExtension
          MapOfModel✓ToolingExtension
          MapOfCollectionOfPrimitives✓ToolingExtension
          MapOfCollectionOfModel✓ToolingExtension
          MapOfCollectionOfEnum✓ToolingExtension

          Documentation Feature​

          NameSupportedDefined By
          Readme✓ToolingExtension
          Model✓ToolingExtension
          Api✓ToolingExtension

          Global Feature​

          NameSupportedDefined By
          Host✓OAS2,OAS3
          BasePath✓OAS2,OAS3
          Info✓OAS2,OAS3
          Schemes✗OAS2,OAS3
          PartialSchemes✓OAS2,OAS3
          Consumes✓OAS2
          Produces✓OAS2
          ExternalDocumentation✓OAS2,OAS3
          Examples✓OAS2,OAS3
          XMLStructureDefinitions✗OAS2,OAS3
          MultiServer✗OAS3
          ParameterizedServer✗OAS3
          ParameterStyling✗OAS3
          Callbacks✗OAS3
          LinkObjects✗OAS3

          Parameter Feature​

          NameSupportedDefined By
          Path✓OAS2,OAS3
          Query✓OAS2,OAS3
          Header✓OAS2,OAS3
          Body✓OAS2
          FormUnencoded✓OAS2
          FormMultipart✓OAS2
          Cookie✓OAS3

          Schema Support Feature​

          NameSupportedDefined By
          Simple✓OAS2,OAS3
          Composite✓OAS2,OAS3
          Polymorphism✓OAS2,OAS3
          Union✗OAS3
          allOf✗OAS2,OAS3
          anyOf✗OAS3
          oneOf✗OAS3
          not✗OAS3

          Security Feature​

          NameSupportedDefined By
          BasicAuth✓OAS2,OAS3
          ApiKey✓OAS2,OAS3
          OpenIDConnect✗OAS3
          BearerToken✓OAS3
          OAuth2_Implicit✗OAS2,OAS3
          OAuth2_Password✗OAS2,OAS3
          OAuth2_ClientCredentials✗OAS2,OAS3
          OAuth2_AuthorizationCode✗OAS2,OAS3
          SignatureAuth✗OAS3
          AWSV4Signature✗ToolingExtension

          Wire Format Feature​

          NameSupportedDefined By
          JSON✓OAS2,OAS3
          XML✓OAS2,OAS3
          PROTOBUF✗ToolingExtension
          Custom✗OAS2,OAS3
          - + \ No newline at end of file diff --git a/docs/generators/avro-schema/index.html b/docs/generators/avro-schema/index.html index 8fa8162665e..36de8441187 100644 --- a/docs/generators/avro-schema/index.html +++ b/docs/generators/avro-schema/index.html @@ -15,13 +15,13 @@ - +

          Documentation for the avro-schema Generator

          METADATA​

          PropertyValueNotes
          generator nameavro-schemapass this to the generate command after -g
          generator stabilityBETA
          generator typeSCHEMA
          generator languageJava
          generator default templating enginemustache
          helpTxtGenerates a Avro model (beta).

          CONFIG OPTIONS​

          These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

          OptionDescriptionValuesDefault
          allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
          disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
          false
          The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
          true
          Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
          		true
          ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
          enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
          false
          No changes to the enum's are made, this is the default option.
          true
          With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
          		false
          legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
          true
          The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
          false
          The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
          		true
          logicalTypeTimeQuantifierThe quantifier for time-related logical types (timestamp and local-timestamp).
          nanos
          nanoseconds
          micros
          microseconds
          millis
          milliseconds
          		millis
          packageNamepackage for generated classes (where supported)null
          prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
          sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
          sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
          useLogicalTypesUse logical types for fields, when matching OpenAPI types. Currently supported: date-time, date.false

          IMPORT MAPPING​

          Type/AliasImports

          INSTANTIATION TYPES​

          Type/AliasInstantiated By
          arrayArray
          listArray
          mapObject

          LANGUAGE PRIMITIVES​

          • BigDecimal
          • DateTime
          • UUID
          • boolean
          • bytes
          • date
          • double
          • float
          • int
          • integer
          • long
          • null
          • number
          • string

          RESERVED WORDS​

            FEATURE SET​

            Client Modification Feature​

            NameSupportedDefined By
            BasePath✗ToolingExtension
            Authorizations✗ToolingExtension
            UserAgent✗ToolingExtension
            MockServer✗ToolingExtension

            Data Type Feature​

            NameSupportedDefined By
            Custom✗OAS2,OAS3
            Int32✓OAS2,OAS3
            Int64✓OAS2,OAS3
            Float✓OAS2,OAS3
            Double✓OAS2,OAS3
            Decimal✓ToolingExtension
            String✓OAS2,OAS3
            Byte✓OAS2,OAS3
            Binary✓OAS2,OAS3
            Boolean✓OAS2,OAS3
            Date✓OAS2,OAS3
            DateTime✓OAS2,OAS3
            Password✓OAS2,OAS3
            File✓OAS2
            Uuid✗
            Array✓OAS2,OAS3
            Null✗OAS3
            AnyType✗OAS2,OAS3
            Object✓OAS2,OAS3
            Maps✓ToolingExtension
            CollectionFormat✓OAS2
            CollectionFormatMulti✓OAS2
            Enum✓OAS2,OAS3
            ArrayOfEnum✓ToolingExtension
            ArrayOfModel✓ToolingExtension
            ArrayOfCollectionOfPrimitives✓ToolingExtension
            ArrayOfCollectionOfModel✓ToolingExtension
            ArrayOfCollectionOfEnum✓ToolingExtension
            MapOfEnum✓ToolingExtension
            MapOfModel✓ToolingExtension
            MapOfCollectionOfPrimitives✓ToolingExtension
            MapOfCollectionOfModel✓ToolingExtension
            MapOfCollectionOfEnum✓ToolingExtension

            Documentation Feature​

            NameSupportedDefined By
            Readme✗ToolingExtension
            Model✗ToolingExtension
            Api✗ToolingExtension

            Global Feature​

            NameSupportedDefined By
            Host✗OAS2,OAS3
            BasePath✗OAS2,OAS3
            Info✗OAS2,OAS3
            Schemes✗OAS2,OAS3
            PartialSchemes✗OAS2,OAS3
            Consumes✗OAS2
            Produces✗OAS2
            ExternalDocumentation✗OAS2,OAS3
            Examples✗OAS2,OAS3
            XMLStructureDefinitions✗OAS2,OAS3
            MultiServer✗OAS3
            ParameterizedServer✗OAS3
            ParameterStyling✗OAS3
            Callbacks✗OAS3
            LinkObjects✗OAS3

            Parameter Feature​

            NameSupportedDefined By
            Path✗OAS2,OAS3
            Query✗OAS2,OAS3
            Header✗OAS2,OAS3
            Body✗OAS2
            FormUnencoded✗OAS2
            FormMultipart✗OAS2
            Cookie✗OAS3

            Schema Support Feature​

            NameSupportedDefined By
            Simple✓OAS2,OAS3
            Composite✓OAS2,OAS3
            Polymorphism✗OAS2,OAS3
            Union✗OAS3
            allOf✗OAS2,OAS3
            anyOf✗OAS3
            oneOf✗OAS3
            not✗OAS3

            Security Feature​

            NameSupportedDefined By
            BasicAuth✗OAS2,OAS3
            ApiKey✗OAS2,OAS3
            OpenIDConnect✗OAS3
            BearerToken✗OAS3
            OAuth2_Implicit✗OAS2,OAS3
            OAuth2_Password✗OAS2,OAS3
            OAuth2_ClientCredentials✗OAS2,OAS3
            OAuth2_AuthorizationCode✗OAS2,OAS3
            SignatureAuth✗OAS3
            AWSV4Signature✗ToolingExtension

            Wire Format Feature​

            NameSupportedDefined By
            JSON✗OAS2,OAS3
            XML✗OAS2,OAS3
            PROTOBUF✗ToolingExtension
            Custom✗OAS2,OAS3
            - + \ No newline at end of file diff --git a/docs/generators/bash/index.html b/docs/generators/bash/index.html index f38681de2e4..6d99fbcfe42 100644 --- a/docs/generators/bash/index.html +++ b/docs/generators/bash/index.html @@ -15,13 +15,13 @@ - +

            Documentation for the bash Generator

            METADATA​

            PropertyValueNotes
            generator namebashpass this to the generate command after -g
            generator stabilitySTABLE
            generator typeCLIENT
            generator languageBash
            generator default templating enginemustache
            helpTxtGenerates a Bash client script based on cURL.

            CONFIG OPTIONS​

            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

            OptionDescriptionValuesDefault
            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
            apiKeyAuthEnvironmentVariableName of environment variable where API key can be defined (e.g. PETSTORE_APIKEY='kjhasdGASDa5asdASD')false
            basicAuthEnvironmentVariableName of environment variable where username and password can be defined (e.g. PETSTORE_CREDS='username:password')null
            curlOptionsDefault cURL optionsnull
            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
            false
            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
            true
            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
            		true
            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
            false
            No changes to the enum's are made, this is the default option.
            true
            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
            		false
            generateBashCompletionWhether to generate the Bash completion scriptfalse
            generateZshCompletionWhether to generate the Zsh completion scriptfalse
            hostEnvironmentVariableName of environment variable where host can be defined (e.g. PETSTORE_HOST='http://api.openapitools.org:8080')null
            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
            true
            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
            false
            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
            		true
            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
            processMarkdownConvert all Markdown Markup into terminal formattingfalse
            scriptNameThe name of the script that will be generated (e.g. petstore-cli)null
            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

            IMPORT MAPPING​

            Type/AliasImports

            INSTANTIATION TYPES​

            Type/AliasInstantiated By

            LANGUAGE PRIMITIVES​

            • array
            • binary
            • boolean
            • float
            • integer
            • map
            • string

            RESERVED WORDS​

            • case
            • do
            • done
            • elif
            • else
            • esac
            • fi
            • for
            • function
            • if
            • in
            • select
            • then
            • time
            • until
            • while

            FEATURE SET​

            Client Modification Feature​

            NameSupportedDefined By
            BasePath✗ToolingExtension
            Authorizations✗ToolingExtension
            UserAgent✗ToolingExtension
            MockServer✗ToolingExtension

            Data Type Feature​

            NameSupportedDefined By
            Custom✗OAS2,OAS3
            Int32✓OAS2,OAS3
            Int64✓OAS2,OAS3
            Float✓OAS2,OAS3
            Double✓OAS2,OAS3
            Decimal✓ToolingExtension
            String✓OAS2,OAS3
            Byte✓OAS2,OAS3
            Binary✓OAS2,OAS3
            Boolean✓OAS2,OAS3
            Date✓OAS2,OAS3
            DateTime✓OAS2,OAS3
            Password✓OAS2,OAS3
            File✓OAS2
            Uuid✗
            Array✓OAS2,OAS3
            Null✗OAS3
            AnyType✗OAS2,OAS3
            Object✓OAS2,OAS3
            Maps✓ToolingExtension
            CollectionFormat✓OAS2
            CollectionFormatMulti✓OAS2
            Enum✓OAS2,OAS3
            ArrayOfEnum✓ToolingExtension
            ArrayOfModel✓ToolingExtension
            ArrayOfCollectionOfPrimitives✓ToolingExtension
            ArrayOfCollectionOfModel✓ToolingExtension
            ArrayOfCollectionOfEnum✓ToolingExtension
            MapOfEnum✓ToolingExtension
            MapOfModel✓ToolingExtension
            MapOfCollectionOfPrimitives✓ToolingExtension
            MapOfCollectionOfModel✓ToolingExtension
            MapOfCollectionOfEnum✓ToolingExtension

            Documentation Feature​

            NameSupportedDefined By
            Readme✓ToolingExtension
            Model✗ToolingExtension
            Api✗ToolingExtension

            Global Feature​

            NameSupportedDefined By
            Host✓OAS2,OAS3
            BasePath✓OAS2,OAS3
            Info✓OAS2,OAS3
            Schemes✗OAS2,OAS3
            PartialSchemes✓OAS2,OAS3
            Consumes✓OAS2
            Produces✓OAS2
            ExternalDocumentation✓OAS2,OAS3
            Examples✓OAS2,OAS3
            XMLStructureDefinitions✗OAS2,OAS3
            MultiServer✗OAS3
            ParameterizedServer✗OAS3
            ParameterStyling✗OAS3
            Callbacks✓OAS3
            LinkObjects✗OAS3

            Parameter Feature​

            NameSupportedDefined By
            Path✓OAS2,OAS3
            Query✓OAS2,OAS3
            Header✓OAS2,OAS3
            Body✓OAS2
            FormUnencoded✓OAS2
            FormMultipart✓OAS2
            Cookie✓OAS3

            Schema Support Feature​

            NameSupportedDefined By
            Simple✓OAS2,OAS3
            Composite✓OAS2,OAS3
            Polymorphism✗OAS2,OAS3
            Union✗OAS3
            allOf✗OAS2,OAS3
            anyOf✗OAS3
            oneOf✗OAS3
            not✗OAS3

            Security Feature​

            NameSupportedDefined By
            BasicAuth✓OAS2,OAS3
            ApiKey✓OAS2,OAS3
            OpenIDConnect✗OAS3
            BearerToken✓OAS3
            OAuth2_Implicit✓OAS2,OAS3
            OAuth2_Password✗OAS2,OAS3
            OAuth2_ClientCredentials✗OAS2,OAS3
            OAuth2_AuthorizationCode✗OAS2,OAS3
            SignatureAuth✗OAS3
            AWSV4Signature✗ToolingExtension

            Wire Format Feature​

            NameSupportedDefined By
            JSON✓OAS2,OAS3
            XML✓OAS2,OAS3
            PROTOBUF✗ToolingExtension
            Custom✓OAS2,OAS3
            - + \ No newline at end of file diff --git a/docs/generators/c/index.html b/docs/generators/c/index.html index a2622d015d6..51340f2cc04 100644 --- a/docs/generators/c/index.html +++ b/docs/generators/c/index.html @@ -15,13 +15,13 @@ - +

            Documentation for the c Generator

            METADATA​

            PropertyValueNotes
            generator namecpass this to the generate command after -g
            generator stabilitySTABLE
            generator typeCLIENT
            generator languageC
            generator default templating enginemustache
            helpTxtGenerates a C (libcurl) client library (beta).

            CONFIG OPTIONS​

            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

            OptionDescriptionValuesDefault
            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
            false
            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
            true
            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
            		true
            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
            false
            No changes to the enum's are made, this is the default option.
            true
            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
            		false
            hideGenerationTimestampHides the generation timestamp when files are generated.true
            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
            true
            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
            false
            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
            		true
            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
            useJsonUnformattedUse cJSON_PrintUnformatted instead of cJSON_Print when creating the JSON string.false

            IMPORT MAPPING​

            Type/AliasImports

            INSTANTIATION TYPES​

            Type/AliasInstantiated By

            LANGUAGE PRIMITIVES​

            • Object
            • binary_t*
            • char
            • double
            • float
            • int
            • list
            • list_t*
            • long
            • short

            RESERVED WORDS​

            • _alignas
            • _alignof
            • _atomic
            • _bool
            • _complex
            • _generic
            • _imaginary
            • _noreturn
            • _static_assert
            • _thread_local
            • alignas
            • alignof
            • and
            • and_eq
            • asm
            • atomic_cancel
            • atomic_commit
            • atomic_noexcept
            • auto
            • bitand
            • bitor
            • bool
            • break
            • case
            • catch
            • char
            • char16_t
            • char32_t
            • char8_t
            • class
            • co_await
            • co_return
            • co_yield
            • compl
            • concept
            • const
            • const_cast
            • consteval
            • constexpr
            • constinit
            • continue
            • decltype
            • default
            • delete
            • do
            • double
            • dynamic_cast
            • else
            • enum
            • explicit
            • export
            • extern
            • false
            • final
            • float
            • for
            • friend
            • goto
            • if
            • inline
            • int
            • linux
            • long
            • mutable
            • namespace
            • new
            • noexcept
            • not
            • not_eq
            • nullptr
            • operator
            • or
            • or_eq
            • override
            • private
            • protected
            • public
            • reflexpr
            • register
            • reinterpret_cast
            • remove
            • requires
            • restrict
            • return
            • short
            • signed
            • sizeof
            • static
            • static_assert
            • static_cast
            • stderr
            • stdin
            • stdout
            • struct
            • switch
            • synchronized
            • template
            • this
            • thread_local
            • throw
            • transaction_safe
            • transaction_safe_dynamic
            • true
            • try
            • typedef
            • typeid
            • typename
            • union
            • unsigned
            • using
            • virtual
            • void
            • volatile
            • wchar_t
            • while
            • xor
            • xor_eq

            FEATURE SET​

            Client Modification Feature​

            NameSupportedDefined By
            BasePath✗ToolingExtension
            Authorizations✗ToolingExtension
            UserAgent✗ToolingExtension
            MockServer✗ToolingExtension

            Data Type Feature​

            NameSupportedDefined By
            Custom✗OAS2,OAS3
            Int32✓OAS2,OAS3
            Int64✓OAS2,OAS3
            Float✓OAS2,OAS3
            Double✓OAS2,OAS3
            Decimal✓ToolingExtension
            String✓OAS2,OAS3
            Byte✓OAS2,OAS3
            Binary✓OAS2,OAS3
            Boolean✓OAS2,OAS3
            Date✓OAS2,OAS3
            DateTime✓OAS2,OAS3
            Password✓OAS2,OAS3
            File✓OAS2
            Uuid✗
            Array✓OAS2,OAS3
            Null✗OAS3
            AnyType✗OAS2,OAS3
            Object✓OAS2,OAS3
            Maps✓ToolingExtension
            CollectionFormat✓OAS2
            CollectionFormatMulti✓OAS2
            Enum✓OAS2,OAS3
            ArrayOfEnum✓ToolingExtension
            ArrayOfModel✓ToolingExtension
            ArrayOfCollectionOfPrimitives✓ToolingExtension
            ArrayOfCollectionOfModel✓ToolingExtension
            ArrayOfCollectionOfEnum✓ToolingExtension
            MapOfEnum✓ToolingExtension
            MapOfModel✓ToolingExtension
            MapOfCollectionOfPrimitives✓ToolingExtension
            MapOfCollectionOfModel✓ToolingExtension
            MapOfCollectionOfEnum✓ToolingExtension

            Documentation Feature​

            NameSupportedDefined By
            Readme✓ToolingExtension
            Model✓ToolingExtension
            Api✓ToolingExtension

            Global Feature​

            NameSupportedDefined By
            Host✓OAS2,OAS3
            BasePath✓OAS2,OAS3
            Info✓OAS2,OAS3
            Schemes✗OAS2,OAS3
            PartialSchemes✓OAS2,OAS3
            Consumes✓OAS2
            Produces✓OAS2
            ExternalDocumentation✓OAS2,OAS3
            Examples✓OAS2,OAS3
            XMLStructureDefinitions✗OAS2,OAS3
            MultiServer✗OAS3
            ParameterizedServer✗OAS3
            ParameterStyling✗OAS3
            Callbacks✓OAS3
            LinkObjects✗OAS3

            Parameter Feature​

            NameSupportedDefined By
            Path✓OAS2,OAS3
            Query✓OAS2,OAS3
            Header✓OAS2,OAS3
            Body✓OAS2
            FormUnencoded✓OAS2
            FormMultipart✓OAS2
            Cookie✗OAS3

            Schema Support Feature​

            NameSupportedDefined By
            Simple✓OAS2,OAS3
            Composite✓OAS2,OAS3
            Polymorphism✗OAS2,OAS3
            Union✗OAS3
            allOf✗OAS2,OAS3
            anyOf✗OAS3
            oneOf✗OAS3
            not✗OAS3

            Security Feature​

            NameSupportedDefined By
            BasicAuth✓OAS2,OAS3
            ApiKey✓OAS2,OAS3
            OpenIDConnect✗OAS3
            BearerToken✗OAS3
            OAuth2_Implicit✓OAS2,OAS3
            OAuth2_Password✗OAS2,OAS3
            OAuth2_ClientCredentials✗OAS2,OAS3
            OAuth2_AuthorizationCode✗OAS2,OAS3
            SignatureAuth✗OAS3
            AWSV4Signature✗ToolingExtension

            Wire Format Feature​

            NameSupportedDefined By
            JSON✓OAS2,OAS3
            XML✓OAS2,OAS3
            PROTOBUF✗ToolingExtension
            Custom✗OAS2,OAS3
            - + \ No newline at end of file diff --git a/docs/generators/clojure/index.html b/docs/generators/clojure/index.html index 41c4b42d79c..c6c9a44b145 100644 --- a/docs/generators/clojure/index.html +++ b/docs/generators/clojure/index.html @@ -15,13 +15,13 @@ - +

            Documentation for the clojure Generator

            METADATA​

            PropertyValueNotes
            generator nameclojurepass this to the generate command after -g
            generator stabilitySTABLE
            generator typeCLIENT
            generator languageClojure
            generator default templating enginemustache
            helpTxtGenerates a Clojure client library.

            CONFIG OPTIONS​

            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

            OptionDescriptionValuesDefault
            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
            baseNamespacethe base/top namespace (Default: generated from projectName)null
            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
            false
            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
            true
            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
            		true
            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
            false
            No changes to the enum's are made, this is the default option.
            true
            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
            		false
            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
            true
            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
            false
            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
            		true
            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
            projectDescriptiondescription of the project (Default: using info.description or "Client library of <projectName>")null
            projectLicenseNamename of the license the project uses (Default: using info.license.name or not included in project.clj)null
            projectLicenseUrlURL of the license the project uses (Default: using info.license.url or not included in project.clj)null
            projectNamename of the project (Default: generated from info.title or "openapi-clj-client")null
            projectUrlURL of the project (Default: using info.contact.url or not included in project.clj)null
            projectVersionversion of the project (Default: using info.version or "1.0.0")null
            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

            IMPORT MAPPING​

            Type/AliasImports

            INSTANTIATION TYPES​

            Type/AliasInstantiated By

            LANGUAGE PRIMITIVES​

              RESERVED WORDS​

                FEATURE SET​

                Client Modification Feature​

                NameSupportedDefined By
                BasePath✗ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✗ToolingExtension
                MockServer✗ToolingExtension

                Data Type Feature​

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Uuid✗
                Array✓OAS2,OAS3
                Null✗OAS3
                AnyType✗OAS2,OAS3
                Object✓OAS2,OAS3
                Maps✓ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✓OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✓ToolingExtension
                MapOfModel✓ToolingExtension
                MapOfCollectionOfPrimitives✓ToolingExtension
                MapOfCollectionOfModel✓ToolingExtension
                MapOfCollectionOfEnum✓ToolingExtension

                Documentation Feature​

                NameSupportedDefined By
                Readme✗ToolingExtension
                Model✓ToolingExtension
                Api✓ToolingExtension

                Global Feature​

                NameSupportedDefined By
                Host✓OAS2,OAS3
                BasePath✓OAS2,OAS3
                Info✓OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✓OAS2,OAS3
                Consumes✓OAS2
                Produces✓OAS2
                ExternalDocumentation✓OAS2,OAS3
                Examples✓OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✗OAS3
                ParameterizedServer✗OAS3
                ParameterStyling✗OAS3
                Callbacks✓OAS3
                LinkObjects✗OAS3

                Parameter Feature​

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✓OAS2,OAS3
                Header✓OAS2,OAS3
                Body✓OAS2
                FormUnencoded✓OAS2
                FormMultipart✓OAS2
                Cookie✗OAS3

                Schema Support Feature​

                NameSupportedDefined By
                Simple✓OAS2,OAS3
                Composite✓OAS2,OAS3
                Polymorphism✗OAS2,OAS3
                Union✗OAS3
                allOf✗OAS2,OAS3
                anyOf✗OAS3
                oneOf✗OAS3
                not✗OAS3

                Security Feature​

                NameSupportedDefined By
                BasicAuth✓OAS2,OAS3
                ApiKey✓OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✗OAS3
                OAuth2_Implicit✓OAS2,OAS3
                OAuth2_Password✗OAS2,OAS3
                OAuth2_ClientCredentials✗OAS2,OAS3
                OAuth2_AuthorizationCode✗OAS2,OAS3
                SignatureAuth✗OAS3
                AWSV4Signature✗ToolingExtension

                Wire Format Feature​

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✓OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✗OAS2,OAS3
                - + \ No newline at end of file diff --git a/docs/generators/cpp-pistache-server/index.html b/docs/generators/cpp-pistache-server/index.html index 9587450551d..40c98085da8 100644 --- a/docs/generators/cpp-pistache-server/index.html +++ b/docs/generators/cpp-pistache-server/index.html @@ -15,13 +15,13 @@ - +

                Documentation for the cpp-pistache-server Generator

                METADATA​

                PropertyValueNotes
                generator namecpp-pistache-serverpass this to the generate command after -g
                generator stabilitySTABLE
                generator typeSERVER
                generator languageC++
                generator default templating enginemustache
                helpTxtGenerates a C++ API server (based on Pistache)

                CONFIG OPTIONS​

                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                OptionDescriptionValuesDefault
                addExternalLibsAdd the Possibility to fetch and compile external Libraries needed by this Framework.true
                helpersPackageSpecify the package name to be used for the helpers (e.g. org.openapitools.server.helpers).org.openapitools.server.helpers
                reservedWordPrefixPrefix to prepend to reserved words in order to avoid conflictsr_
                useStructModelUse struct-based model template instead of get/set-based model templatefalse
                variableNameFirstCharacterUppercaseMake first character of variable name uppercase (eg. value -> Value)true

                IMPORT MAPPING​

                Type/AliasImports
                nlohmann::json#include <nlohmann/json.hpp>
                std::map#include <map>
                std::set#include <set>
                std::string#include <string>
                std::vector#include <vector>

                INSTANTIATION TYPES​

                Type/AliasInstantiated By

                LANGUAGE PRIMITIVES​

                • bool
                • char
                • double
                • float
                • int
                • int32_t
                • int64_t
                • long

                RESERVED WORDS​

                • NULL
                • alignas
                • alignof
                • and
                • and_eq
                • asm
                • auto
                • bitand
                • bitor
                • bool
                • break
                • case
                • catch
                • char
                • char16_t
                • char32_t
                • class
                • compl
                • concept
                • const
                • const_cast
                • constexpr
                • continue
                • decltype
                • default
                • delete
                • do
                • double
                • dynamic_cast
                • else
                • enum
                • explicit
                • export
                • extern
                • false
                • float
                • for
                • friend
                • goto
                • if
                • inline
                • int
                • linux
                • long
                • mutable
                • namespace
                • new
                • noexcept
                • not
                • not_eq
                • nullptr
                • operator
                • or
                • or_eq
                • private
                • protected
                • public
                • register
                • reinterpret_cast
                • requires
                • return
                • short
                • signed
                • sizeof
                • static
                • static_assert
                • static_cast
                • struct
                • switch
                • template
                • this
                • thread_local
                • throw
                • true
                • try
                • typedef
                • typeid
                • typename
                • union
                • unsigned
                • using
                • virtual
                • void
                • volatile
                • wchar_t
                • while
                • xor
                • xor_eq

                FEATURE SET​

                Client Modification Feature​

                NameSupportedDefined By
                BasePath✗ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✗ToolingExtension
                MockServer✗ToolingExtension

                Data Type Feature​

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Uuid✗
                Array✓OAS2,OAS3
                Null✗OAS3
                AnyType✗OAS2,OAS3
                Object✓OAS2,OAS3
                Maps✓ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✓OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✓ToolingExtension
                MapOfModel✓ToolingExtension
                MapOfCollectionOfPrimitives✓ToolingExtension
                MapOfCollectionOfModel✓ToolingExtension
                MapOfCollectionOfEnum✓ToolingExtension

                Documentation Feature​

                NameSupportedDefined By
                Readme✓ToolingExtension
                Model✓ToolingExtension
                Api✓ToolingExtension

                Global Feature​

                NameSupportedDefined By
                Host✓OAS2,OAS3
                BasePath✓OAS2,OAS3
                Info✓OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✓OAS2,OAS3
                Consumes✓OAS2
                Produces✓OAS2
                ExternalDocumentation✓OAS2,OAS3
                Examples✓OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✗OAS3
                ParameterizedServer✗OAS3
                ParameterStyling✗OAS3
                Callbacks✗OAS3
                LinkObjects✗OAS3

                Parameter Feature​

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✓OAS2,OAS3
                Header✓OAS2,OAS3
                Body✓OAS2
                FormUnencoded✓OAS2
                FormMultipart✓OAS2
                Cookie✗OAS3

                Schema Support Feature​

                NameSupportedDefined By
                Simple✓OAS2,OAS3
                Composite✓OAS2,OAS3
                Polymorphism✗OAS2,OAS3
                Union✗OAS3
                allOf✗OAS2,OAS3
                anyOf✗OAS3
                oneOf✗OAS3
                not✗OAS3

                Security Feature​

                NameSupportedDefined By
                BasicAuth✗OAS2,OAS3
                ApiKey✗OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✗OAS3
                OAuth2_Implicit✗OAS2,OAS3
                OAuth2_Password✗OAS2,OAS3
                OAuth2_ClientCredentials✗OAS2,OAS3
                OAuth2_AuthorizationCode✗OAS2,OAS3
                SignatureAuth✗OAS3
                AWSV4Signature✗ToolingExtension

                Wire Format Feature​

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✓OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✗OAS2,OAS3
                - + \ No newline at end of file diff --git a/docs/generators/cpp-qt-client/index.html b/docs/generators/cpp-qt-client/index.html index bd403486c9a..c488b1452d0 100644 --- a/docs/generators/cpp-qt-client/index.html +++ b/docs/generators/cpp-qt-client/index.html @@ -15,13 +15,13 @@ - +

                Documentation for the cpp-qt-client Generator

                METADATA​

                PropertyValueNotes
                generator namecpp-qt-clientpass this to the generate command after -g
                generator stabilitySTABLE
                generator typeCLIENT
                generator languageC++
                generator default templating enginemustache
                helpTxtGenerates a Qt C++ client library.

                CONFIG OPTIONS​

                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                OptionDescriptionValuesDefault
                addDownloadProgressAdd support for Qt download progressfalse
                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                contentCompressionEnable Compressed Content Encoding for requests and responsesfalse
                cppNamespaceC++ namespace (convention: name::space::for::api).OpenAPI
                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                false
                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                true
                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                		true
                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                false
                No changes to the enum's are made, this is the default option.
                true
                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                		false
                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                true
                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                false
                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                		true
                makeOperationsVirtualMake all operations methods virtual. This makes it easy to mock the generated API class for testing purposes.true
                modelNamePrefixPrefix that will be prepended to all model names.OAI
                optionalProjectFileGenerate client.pri.true
                packageNameC++ package (library) name.QtOpenAPIClient
                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                reservedWordPrefixPrefix to prepend to reserved words in order to avoid conflictsr_
                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                variableNameFirstCharacterUppercaseMake first character of variable name uppercase (eg. value -> Value)true

                IMPORT MAPPING​

                Type/AliasImports
                OAIHttpFileElement#include "OAIHttpFileElement.h"
                QJsonValue#include <QJsonValue>

                INSTANTIATION TYPES​

                Type/AliasInstantiated By

                LANGUAGE PRIMITIVES​

                • QByteArray
                • QDate
                • QDateTime
                • QString
                • bool
                • double
                • float
                • qint32
                • qint64

                RESERVED WORDS​

                • NULL
                • alignas
                • alignof
                • and
                • and_eq
                • asm
                • auto
                • bitand
                • bitor
                • bool
                • break
                • case
                • catch
                • char
                • char16_t
                • char32_t
                • class
                • compl
                • concept
                • const
                • const_cast
                • constexpr
                • continue
                • decltype
                • default
                • delete
                • do
                • double
                • dynamic_cast
                • else
                • enum
                • explicit
                • export
                • extern
                • false
                • float
                • for
                • friend
                • goto
                • if
                • inline
                • int
                • linux
                • long
                • mutable
                • namespace
                • new
                • noexcept
                • not
                • not_eq
                • nullptr
                • operator
                • or
                • or_eq
                • private
                • protected
                • public
                • register
                • reinterpret_cast
                • requires
                • return
                • set
                • short
                • signals
                • signed
                • sizeof
                • slots
                • static
                • static_assert
                • static_cast
                • struct
                • switch
                • template
                • this
                • thread_local
                • throw
                • true
                • try
                • typedef
                • typeid
                • typename
                • union
                • unsigned
                • using
                • valid
                • virtual
                • void
                • volatile
                • wchar_t
                • while
                • xor
                • xor_eq

                FEATURE SET​

                Client Modification Feature​

                NameSupportedDefined By
                BasePath✗ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✗ToolingExtension
                MockServer✗ToolingExtension

                Data Type Feature​

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Uuid✗
                Array✓OAS2,OAS3
                Null✗OAS3
                AnyType✗OAS2,OAS3
                Object✓OAS2,OAS3
                Maps✓ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✓OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✓ToolingExtension
                MapOfModel✓ToolingExtension
                MapOfCollectionOfPrimitives✓ToolingExtension
                MapOfCollectionOfModel✓ToolingExtension
                MapOfCollectionOfEnum✓ToolingExtension

                Documentation Feature​

                NameSupportedDefined By
                Readme✓ToolingExtension
                Model✓ToolingExtension
                Api✓ToolingExtension

                Global Feature​

                NameSupportedDefined By
                Host✓OAS2,OAS3
                BasePath✓OAS2,OAS3
                Info✓OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✓OAS2,OAS3
                Consumes✓OAS2
                Produces✓OAS2
                ExternalDocumentation✓OAS2,OAS3
                Examples✓OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✓OAS3
                ParameterizedServer✓OAS3
                ParameterStyling✓OAS3
                Callbacks✗OAS3
                LinkObjects✗OAS3

                Parameter Feature​

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✓OAS2,OAS3
                Header✓OAS2,OAS3
                Body✓OAS2
                FormUnencoded✓OAS2
                FormMultipart✓OAS2
                Cookie✓OAS3

                Schema Support Feature​

                NameSupportedDefined By
                Simple✓OAS2,OAS3
                Composite✓OAS2,OAS3
                Polymorphism✓OAS2,OAS3
                Union✗OAS3
                allOf✗OAS2,OAS3
                anyOf✗OAS3
                oneOf✗OAS3
                not✗OAS3

                Security Feature​

                NameSupportedDefined By
                BasicAuth✓OAS2,OAS3
                ApiKey✓OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✓OAS3
                OAuth2_Implicit✓OAS2,OAS3
                OAuth2_Password✓OAS2,OAS3
                OAuth2_ClientCredentials✓OAS2,OAS3
                OAuth2_AuthorizationCode✓OAS2,OAS3
                SignatureAuth✗OAS3
                AWSV4Signature✗ToolingExtension

                Wire Format Feature​

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✓OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✗OAS2,OAS3
                - + \ No newline at end of file diff --git a/docs/generators/cpp-qt-qhttpengine-server/index.html b/docs/generators/cpp-qt-qhttpengine-server/index.html index 8030d229bdf..6a63cef0215 100644 --- a/docs/generators/cpp-qt-qhttpengine-server/index.html +++ b/docs/generators/cpp-qt-qhttpengine-server/index.html @@ -15,13 +15,13 @@ - +

                Documentation for the cpp-qt-qhttpengine-server Generator

                METADATA​

                PropertyValueNotes
                generator namecpp-qt-qhttpengine-serverpass this to the generate command after -g
                generator stabilitySTABLE
                generator typeSERVER
                generator languageC++
                generator default templating enginemustache
                helpTxtGenerates a Qt C++ Server using the QHTTPEngine HTTP Library.

                CONFIG OPTIONS​

                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                OptionDescriptionValuesDefault
                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                contentCompressionEnable Compressed Content Encoding for requests and responsesfalse
                cppNamespaceC++ namespace (convention: name::space::for::api).OpenAPI
                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                false
                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                true
                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                		true
                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                false
                No changes to the enum's are made, this is the default option.
                true
                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                		false
                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                true
                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                false
                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                		true
                modelNamePrefixPrefix that will be prepended to all model names.OAI
                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                reservedWordPrefixPrefix to prepend to reserved words in order to avoid conflictsr_
                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                variableNameFirstCharacterUppercaseMake first character of variable name uppercase (eg. value -> Value)true

                IMPORT MAPPING​

                Type/AliasImports
                OAIHttpFileElement#include "OAIHttpFileElement.h"

                INSTANTIATION TYPES​

                Type/AliasInstantiated By

                LANGUAGE PRIMITIVES​

                • QByteArray
                • QDate
                • QDateTime
                • QString
                • bool
                • double
                • float
                • qint32
                • qint64

                RESERVED WORDS​

                • NULL
                • alignas
                • alignof
                • and
                • and_eq
                • asm
                • auto
                • bitand
                • bitor
                • bool
                • break
                • case
                • catch
                • char
                • char16_t
                • char32_t
                • class
                • compl
                • concept
                • const
                • const_cast
                • constexpr
                • continue
                • decltype
                • default
                • delete
                • do
                • double
                • dynamic_cast
                • else
                • enum
                • explicit
                • export
                • extern
                • false
                • float
                • for
                • friend
                • goto
                • if
                • inline
                • int
                • linux
                • long
                • mutable
                • namespace
                • new
                • noexcept
                • not
                • not_eq
                • nullptr
                • operator
                • or
                • or_eq
                • private
                • protected
                • public
                • register
                • reinterpret_cast
                • requires
                • return
                • short
                • signals
                • signed
                • sizeof
                • slots
                • static
                • static_assert
                • static_cast
                • struct
                • switch
                • template
                • this
                • thread_local
                • throw
                • true
                • try
                • typedef
                • typeid
                • typename
                • union
                • unsigned
                • using
                • virtual
                • void
                • volatile
                • wchar_t
                • while
                • xor
                • xor_eq

                FEATURE SET​

                Client Modification Feature​

                NameSupportedDefined By
                BasePath✗ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✗ToolingExtension
                MockServer✗ToolingExtension

                Data Type Feature​

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Uuid✗
                Array✓OAS2,OAS3
                Null✗OAS3
                AnyType✗OAS2,OAS3
                Object✓OAS2,OAS3
                Maps✓ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✓OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✓ToolingExtension
                MapOfModel✓ToolingExtension
                MapOfCollectionOfPrimitives✓ToolingExtension
                MapOfCollectionOfModel✓ToolingExtension
                MapOfCollectionOfEnum✓ToolingExtension

                Documentation Feature​

                NameSupportedDefined By
                Readme✓ToolingExtension
                Model✓ToolingExtension
                Api✓ToolingExtension

                Global Feature​

                NameSupportedDefined By
                Host✓OAS2,OAS3
                BasePath✓OAS2,OAS3
                Info✓OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✓OAS2,OAS3
                Consumes✓OAS2
                Produces✓OAS2
                ExternalDocumentation✓OAS2,OAS3
                Examples✓OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✗OAS3
                ParameterizedServer✗OAS3
                ParameterStyling✗OAS3
                Callbacks✗OAS3
                LinkObjects✗OAS3

                Parameter Feature​

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✓OAS2,OAS3
                Header✓OAS2,OAS3
                Body✓OAS2
                FormUnencoded✓OAS2
                FormMultipart✓OAS2
                Cookie✓OAS3

                Schema Support Feature​

                NameSupportedDefined By
                Simple✓OAS2,OAS3
                Composite✓OAS2,OAS3
                Polymorphism✓OAS2,OAS3
                Union✗OAS3
                allOf✗OAS2,OAS3
                anyOf✗OAS3
                oneOf✗OAS3
                not✗OAS3

                Security Feature​

                NameSupportedDefined By
                BasicAuth✗OAS2,OAS3
                ApiKey✗OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✗OAS3
                OAuth2_Implicit✗OAS2,OAS3
                OAuth2_Password✗OAS2,OAS3
                OAuth2_ClientCredentials✗OAS2,OAS3
                OAuth2_AuthorizationCode✗OAS2,OAS3
                SignatureAuth✗OAS3
                AWSV4Signature✗ToolingExtension

                Wire Format Feature​

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✓OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✗OAS2,OAS3
                - + \ No newline at end of file diff --git a/docs/generators/cpp-restbed-server-deprecated/index.html b/docs/generators/cpp-restbed-server-deprecated/index.html index bd75d841c6c..1ddf9b896f9 100644 --- a/docs/generators/cpp-restbed-server-deprecated/index.html +++ b/docs/generators/cpp-restbed-server-deprecated/index.html @@ -15,13 +15,13 @@ - +

                Documentation for the cpp-restbed-server-deprecated Generator

                METADATA​

                PropertyValueNotes
                generator namecpp-restbed-server-deprecatedpass this to the generate command after -g
                generator stabilitySTABLE
                generator typeSERVER
                generator languageC++
                generator default templating enginemustache
                helpTxtGenerates a C++ API Server with Restbed (https://github.com/Corvusoft/restbed).

                CONFIG OPTIONS​

                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                OptionDescriptionValuesDefault
                apiPackageC++ namespace for apis (convention: name.space.api).org.openapitools.server.api
                declspecC++ preprocessor to place before the class name for handling dllexport/dllimport.
                defaultIncludeThe default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h"
                modelPackageC++ namespace for models (convention: name.space.model).org.openapitools.server.model
                packageVersionC++ package version.1.0.0
                reservedWordPrefixPrefix to prepend to reserved words in order to avoid conflictsr_

                IMPORT MAPPING​

                Type/AliasImports
                Object#include "Object.h"
                restbed::Bytes#include <corvusoft/restbed/byte.hpp>
                std::map#include <map>
                std::string#include <string>
                std::vector#include <vector>

                INSTANTIATION TYPES​

                Type/AliasInstantiated By

                LANGUAGE PRIMITIVES​

                • bool
                • char
                • double
                • float
                • int
                • int32_t
                • int64_t
                • long

                RESERVED WORDS​

                • NULL
                • alignas
                • alignof
                • and
                • and_eq
                • asm
                • auto
                • bitand
                • bitor
                • bool
                • break
                • case
                • catch
                • char
                • char16_t
                • char32_t
                • class
                • compl
                • concept
                • const
                • const_cast
                • constexpr
                • continue
                • decltype
                • default
                • delete
                • do
                • double
                • dynamic_cast
                • else
                • enum
                • explicit
                • export
                • extern
                • false
                • float
                • for
                • friend
                • goto
                • if
                • inline
                • int
                • linux
                • long
                • mutable
                • namespace
                • new
                • noexcept
                • not
                • not_eq
                • nullptr
                • operator
                • or
                • or_eq
                • private
                • protected
                • public
                • register
                • reinterpret_cast
                • requires
                • return
                • short
                • signed
                • sizeof
                • static
                • static_assert
                • static_cast
                • struct
                • switch
                • template
                • this
                • thread_local
                • throw
                • true
                • try
                • typedef
                • typeid
                • typename
                • union
                • unsigned
                • using
                • virtual
                • void
                • volatile
                • wchar_t
                • while
                • xor
                • xor_eq

                FEATURE SET​

                Client Modification Feature​

                NameSupportedDefined By
                BasePath✗ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✗ToolingExtension
                MockServer✗ToolingExtension

                Data Type Feature​

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Uuid✗
                Array✓OAS2,OAS3
                Null✗OAS3
                AnyType✗OAS2,OAS3
                Object✓OAS2,OAS3
                Maps✓ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✓OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✓ToolingExtension
                MapOfModel✓ToolingExtension
                MapOfCollectionOfPrimitives✓ToolingExtension
                MapOfCollectionOfModel✓ToolingExtension
                MapOfCollectionOfEnum✓ToolingExtension

                Documentation Feature​

                NameSupportedDefined By
                Readme✓ToolingExtension
                Model✓ToolingExtension
                Api✓ToolingExtension

                Global Feature​

                NameSupportedDefined By
                Host✓OAS2,OAS3
                BasePath✓OAS2,OAS3
                Info✓OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✓OAS2,OAS3
                Consumes✓OAS2
                Produces✓OAS2
                ExternalDocumentation✓OAS2,OAS3
                Examples✓OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✗OAS3
                ParameterizedServer✗OAS3
                ParameterStyling✗OAS3
                Callbacks✗OAS3
                LinkObjects✗OAS3

                Parameter Feature​

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✓OAS2,OAS3
                Header✓OAS2,OAS3
                Body✓OAS2
                FormUnencoded✓OAS2
                FormMultipart✓OAS2
                Cookie✗OAS3

                Schema Support Feature​

                NameSupportedDefined By
                Simple✓OAS2,OAS3
                Composite✓OAS2,OAS3
                Polymorphism✗OAS2,OAS3
                Union✗OAS3
                allOf✗OAS2,OAS3
                anyOf✗OAS3
                oneOf✗OAS3
                not✗OAS3

                Security Feature​

                NameSupportedDefined By
                BasicAuth✗OAS2,OAS3
                ApiKey✗OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✗OAS3
                OAuth2_Implicit✗OAS2,OAS3
                OAuth2_Password✗OAS2,OAS3
                OAuth2_ClientCredentials✗OAS2,OAS3
                OAuth2_AuthorizationCode✗OAS2,OAS3
                SignatureAuth✗OAS3
                AWSV4Signature✗ToolingExtension

                Wire Format Feature​

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✓OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✗OAS2,OAS3
                - + \ No newline at end of file diff --git a/docs/generators/cpp-restbed-server/index.html b/docs/generators/cpp-restbed-server/index.html index bd06af85ead..bcb7a327b89 100644 --- a/docs/generators/cpp-restbed-server/index.html +++ b/docs/generators/cpp-restbed-server/index.html @@ -15,13 +15,13 @@ - +

                Documentation for the cpp-restbed-server Generator

                METADATA​

                PropertyValueNotes
                generator namecpp-restbed-serverpass this to the generate command after -g
                generator stabilitySTABLE
                generator typeSERVER
                generator languageC++
                generator default templating enginemustache
                helpTxtGenerates a C++ API Server with Restbed (https://github.com/Corvusoft/restbed).

                CONFIG OPTIONS​

                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                OptionDescriptionValuesDefault
                apiPackageC++ namespace for apis (convention: name.space.api).org.openapitools.server.api
                declspecC++ preprocessor to place before the class name for handling dllexport/dllimport.
                defaultIncludeThe default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h"
                modelPackageC++ namespace for models (convention: name.space.model).org.openapitools.server.model
                packageVersionC++ package version.1.0.0
                reservedWordPrefixPrefix to prepend to reserved words in order to avoid conflictsr_

                IMPORT MAPPING​

                Type/AliasImports
                file#include <string>
                restbed::Bytes#include <corvusoft/restbed/byte.hpp>
                std::map#include <map>
                std::set#include <set>
                std::string#include <string>
                std::vector#include <vector>

                INSTANTIATION TYPES​

                Type/AliasInstantiated By

                LANGUAGE PRIMITIVES​

                • bool
                • char
                • double
                • float
                • int
                • int32_t
                • int64_t
                • long

                RESERVED WORDS​

                • NULL
                • alignas
                • alignof
                • and
                • and_eq
                • asm
                • auto
                • bitand
                • bitor
                • bool
                • break
                • case
                • catch
                • char
                • char16_t
                • char32_t
                • class
                • compl
                • concept
                • const
                • const_cast
                • constexpr
                • continue
                • decltype
                • default
                • delete
                • do
                • double
                • dynamic_cast
                • else
                • enum
                • explicit
                • export
                • extern
                • false
                • float
                • for
                • friend
                • goto
                • if
                • inline
                • int
                • linux
                • long
                • mutable
                • namespace
                • new
                • noexcept
                • not
                • not_eq
                • nullptr
                • operator
                • or
                • or_eq
                • private
                • protected
                • public
                • register
                • reinterpret_cast
                • requires
                • return
                • short
                • signed
                • sizeof
                • static
                • static_assert
                • static_cast
                • struct
                • switch
                • template
                • this
                • thread_local
                • throw
                • true
                • try
                • typedef
                • typeid
                • typename
                • union
                • unsigned
                • using
                • virtual
                • void
                • volatile
                • wchar_t
                • while
                • xor
                • xor_eq

                FEATURE SET​

                Client Modification Feature​

                NameSupportedDefined By
                BasePath✗ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✗ToolingExtension
                MockServer✗ToolingExtension

                Data Type Feature​

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Uuid✗
                Array✓OAS2,OAS3
                Null✗OAS3
                AnyType✗OAS2,OAS3
                Object✓OAS2,OAS3
                Maps✓ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✓OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✓ToolingExtension
                MapOfModel✓ToolingExtension
                MapOfCollectionOfPrimitives✓ToolingExtension
                MapOfCollectionOfModel✓ToolingExtension
                MapOfCollectionOfEnum✓ToolingExtension

                Documentation Feature​

                NameSupportedDefined By
                Readme✓ToolingExtension
                Model✓ToolingExtension
                Api✓ToolingExtension

                Global Feature​

                NameSupportedDefined By
                Host✓OAS2,OAS3
                BasePath✓OAS2,OAS3
                Info✓OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✓OAS2,OAS3
                Consumes✓OAS2
                Produces✓OAS2
                ExternalDocumentation✓OAS2,OAS3
                Examples✓OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✗OAS3
                ParameterizedServer✗OAS3
                ParameterStyling✗OAS3
                Callbacks✗OAS3
                LinkObjects✗OAS3

                Parameter Feature​

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✓OAS2,OAS3
                Header✓OAS2,OAS3
                Body✓OAS2
                FormUnencoded✓OAS2
                FormMultipart✓OAS2
                Cookie✗OAS3

                Schema Support Feature​

                NameSupportedDefined By
                Simple✓OAS2,OAS3
                Composite✓OAS2,OAS3
                Polymorphism✗OAS2,OAS3
                Union✗OAS3
                allOf✗OAS2,OAS3
                anyOf✗OAS3
                oneOf✗OAS3
                not✗OAS3

                Security Feature​

                NameSupportedDefined By
                BasicAuth✗OAS2,OAS3
                ApiKey✗OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✗OAS3
                OAuth2_Implicit✗OAS2,OAS3
                OAuth2_Password✗OAS2,OAS3
                OAuth2_ClientCredentials✗OAS2,OAS3
                OAuth2_AuthorizationCode✗OAS2,OAS3
                SignatureAuth✗OAS3
                AWSV4Signature✗ToolingExtension

                Wire Format Feature​

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✓OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✗OAS2,OAS3
                - + \ No newline at end of file diff --git a/docs/generators/cpp-restsdk/index.html b/docs/generators/cpp-restsdk/index.html index 18e413c4c88..42993fc0e1e 100644 --- a/docs/generators/cpp-restsdk/index.html +++ b/docs/generators/cpp-restsdk/index.html @@ -15,13 +15,13 @@ - +

                Documentation for the cpp-restsdk Generator

                METADATA​

                PropertyValueNotes
                generator namecpp-restsdkpass this to the generate command after -g
                generator stabilitySTABLE
                generator typeCLIENT
                generator languageC++
                generator default templating enginemustache
                helpTxtGenerates a C++ API client with C++ REST SDK (https://github.com/Microsoft/cpprestsdk).

                CONFIG OPTIONS​

                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                OptionDescriptionValuesDefault
                apiPackageC++ namespace for apis (convention: name.space.api).org.openapitools.client.api
                declspecC++ preprocessor to place before the class name for handling dllexport/dllimport.
                defaultIncludeThe default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h"
                generateGMocksForApisGenerate Google Mock classes for APIs.null
                modelPackageC++ namespace for models (convention: name.space.model).org.openapitools.client.model
                packageNameC++ package (library) name.CppRestOpenAPIClient
                packageVersionC++ package version.1.0.0
                reservedWordPrefixPrefix to prepend to reserved words in order to avoid conflictsr_
                variableNameFirstCharacterUppercaseMake first character of variable name uppercase (eg. value -> Value)true

                IMPORT MAPPING​

                Type/AliasImports
                AnyType#include "AnyType.h"
                HttpContent#include "HttpContent.h"
                Object#include "Object.h"
                std::map#include <map>
                std::set#include <set>
                std::string#include <string>
                std::vector#include <vector>
                utility::datetime#include <cpprest/details/basic_types.h>
                utility::string_t#include <cpprest/details/basic_types.h>

                INSTANTIATION TYPES​

                Type/AliasInstantiated By

                LANGUAGE PRIMITIVES​

                • bool
                • char
                • double
                • float
                • int
                • int32_t
                • int64_t
                • long

                RESERVED WORDS​

                • NULL
                • alignas
                • alignof
                • and
                • and_eq
                • asm
                • auto
                • bitand
                • bitor
                • bool
                • break
                • case
                • catch
                • char
                • char16_t
                • char32_t
                • class
                • compl
                • concept
                • const
                • const_cast
                • constexpr
                • continue
                • decltype
                • default
                • delete
                • do
                • double
                • dynamic_cast
                • else
                • enum
                • explicit
                • export
                • extern
                • false
                • float
                • for
                • friend
                • goto
                • if
                • inline
                • int
                • linux
                • long
                • mutable
                • namespace
                • new
                • noexcept
                • not
                • not_eq
                • nullptr
                • operator
                • or
                • or_eq
                • private
                • protected
                • public
                • register
                • reinterpret_cast
                • requires
                • return
                • short
                • signed
                • sizeof
                • static
                • static_assert
                • static_cast
                • struct
                • switch
                • template
                • this
                • thread_local
                • throw
                • true
                • try
                • typedef
                • typeid
                • typename
                • union
                • unsigned
                • using
                • virtual
                • void
                • volatile
                • wchar_t
                • while
                • xor
                • xor_eq

                FEATURE SET​

                Client Modification Feature​

                NameSupportedDefined By
                BasePath✗ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✗ToolingExtension
                MockServer✗ToolingExtension

                Data Type Feature​

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Uuid✗
                Array✓OAS2,OAS3
                Null✗OAS3
                AnyType✓OAS2,OAS3
                Object✓OAS2,OAS3
                Maps✓ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✓OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✓ToolingExtension
                MapOfModel✓ToolingExtension
                MapOfCollectionOfPrimitives✓ToolingExtension
                MapOfCollectionOfModel✓ToolingExtension
                MapOfCollectionOfEnum✓ToolingExtension

                Documentation Feature​

                NameSupportedDefined By
                Readme✓ToolingExtension
                Model✓ToolingExtension
                Api✓ToolingExtension

                Global Feature​

                NameSupportedDefined By
                Host✓OAS2,OAS3
                BasePath✓OAS2,OAS3
                Info✓OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✓OAS2,OAS3
                Consumes✓OAS2
                Produces✓OAS2
                ExternalDocumentation✓OAS2,OAS3
                Examples✓OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✗OAS3
                ParameterizedServer✗OAS3
                ParameterStyling✗OAS3
                Callbacks✗OAS3
                LinkObjects✗OAS3

                Parameter Feature​

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✓OAS2,OAS3
                Header✓OAS2,OAS3
                Body✓OAS2
                FormUnencoded✓OAS2
                FormMultipart✓OAS2
                Cookie✗OAS3

                Schema Support Feature​

                NameSupportedDefined By
                Simple✓OAS2,OAS3
                Composite✓OAS2,OAS3
                Polymorphism✓OAS2,OAS3
                Union✗OAS3
                allOf✗OAS2,OAS3
                anyOf✗OAS3
                oneOf✓OAS3
                not✗OAS3

                Security Feature​

                NameSupportedDefined By
                BasicAuth✓OAS2,OAS3
                ApiKey✓OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✗OAS3
                OAuth2_Implicit✓OAS2,OAS3
                OAuth2_Password✗OAS2,OAS3
                OAuth2_ClientCredentials✗OAS2,OAS3
                OAuth2_AuthorizationCode✗OAS2,OAS3
                SignatureAuth✗OAS3
                AWSV4Signature✗ToolingExtension

                Wire Format Feature​

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✓OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✗OAS2,OAS3
                - + \ No newline at end of file diff --git a/docs/generators/cpp-tiny/index.html b/docs/generators/cpp-tiny/index.html index 66b2246e40e..745c33a068b 100644 --- a/docs/generators/cpp-tiny/index.html +++ b/docs/generators/cpp-tiny/index.html @@ -15,13 +15,13 @@ - +

                Documentation for the cpp-tiny Generator

                METADATA​

                PropertyValueNotes
                generator namecpp-tinypass this to the generate command after -g
                generator stabilityBETA
                generator typeCLIENT
                generator languageC++
                generator default templating enginemustache
                helpTxtGenerates a C++ Arduino REST API client.

                CONFIG OPTIONS​

                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                OptionDescriptionValuesDefault
                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                controllername of microcontroller (e.g esp32 or esp8266)esp32
                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                false
                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                true
                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                		true
                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                false
                No changes to the enum's are made, this is the default option.
                true
                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                		false
                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                true
                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                false
                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                		true
                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                reservedWordPrefixPrefix to prepend to reserved words in order to avoid conflictsr_
                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                variableNameFirstCharacterUppercaseMake first character of variable name uppercase (eg. value -> Value)true

                IMPORT MAPPING​

                Type/AliasImports

                INSTANTIATION TYPES​

                Type/AliasInstantiated By

                LANGUAGE PRIMITIVES​

                • bool
                • double
                • float
                • int
                • long
                • std::string

                RESERVED WORDS​

                • NULL
                • alignas
                • alignof
                • and
                • and_eq
                • asm
                • auto
                • bitand
                • bitor
                • bool
                • break
                • case
                • catch
                • char
                • char16_t
                • char32_t
                • class
                • compl
                • concept
                • const
                • const_cast
                • constexpr
                • continue
                • decltype
                • default
                • delete
                • do
                • double
                • dynamic_cast
                • else
                • enum
                • explicit
                • export
                • extern
                • false
                • float
                • for
                • friend
                • goto
                • if
                • inline
                • int
                • linux
                • long
                • mutable
                • namespace
                • new
                • noexcept
                • not
                • not_eq
                • nullptr
                • operator
                • or
                • or_eq
                • private
                • protected
                • public
                • register
                • reinterpret_cast
                • requires
                • return
                • short
                • signed
                • sizeof
                • static
                • static_assert
                • static_cast
                • struct
                • switch
                • template
                • this
                • thread_local
                • throw
                • true
                • try
                • typedef
                • typeid
                • typename
                • union
                • unsigned
                • using
                • virtual
                • void
                • volatile
                • wchar_t
                • while
                • xor
                • xor_eq

                FEATURE SET​

                Client Modification Feature​

                NameSupportedDefined By
                BasePath✗ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✗ToolingExtension
                MockServer✗ToolingExtension

                Data Type Feature​

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Uuid✗
                Array✓OAS2,OAS3
                Null✗OAS3
                AnyType✗OAS2,OAS3
                Object✓OAS2,OAS3
                Maps✗ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✗OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✗ToolingExtension
                MapOfModel✗ToolingExtension
                MapOfCollectionOfPrimitives✗ToolingExtension
                MapOfCollectionOfModel✗ToolingExtension
                MapOfCollectionOfEnum✗ToolingExtension

                Documentation Feature​

                NameSupportedDefined By
                Readme✓ToolingExtension
                Model✓ToolingExtension
                Api✓ToolingExtension

                Global Feature​

                NameSupportedDefined By
                Host✓OAS2,OAS3
                BasePath✓OAS2,OAS3
                Info✓OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✓OAS2,OAS3
                Consumes✓OAS2
                Produces✓OAS2
                ExternalDocumentation✓OAS2,OAS3
                Examples✓OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✗OAS3
                ParameterizedServer✗OAS3
                ParameterStyling✗OAS3
                Callbacks✗OAS3
                LinkObjects✗OAS3

                Parameter Feature​

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✗OAS2,OAS3
                Header✗OAS2,OAS3
                Body✓OAS2
                FormUnencoded✗OAS2
                FormMultipart✗OAS2
                Cookie✗OAS3

                Schema Support Feature​

                NameSupportedDefined By
                Simple✓OAS2,OAS3
                Composite✓OAS2,OAS3
                Polymorphism✗OAS2,OAS3
                Union✗OAS3
                allOf✗OAS2,OAS3
                anyOf✗OAS3
                oneOf✗OAS3
                not✗OAS3

                Security Feature​

                NameSupportedDefined By
                BasicAuth✓OAS2,OAS3
                ApiKey✓OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✓OAS3
                OAuth2_Implicit✓OAS2,OAS3
                OAuth2_Password✓OAS2,OAS3
                OAuth2_ClientCredentials✓OAS2,OAS3
                OAuth2_AuthorizationCode✓OAS2,OAS3
                SignatureAuth✗OAS3
                AWSV4Signature✗ToolingExtension

                Wire Format Feature​

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✗OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✗OAS2,OAS3
                - + \ No newline at end of file diff --git a/docs/generators/cpp-tizen/index.html b/docs/generators/cpp-tizen/index.html index bd97ba72f37..a6b0cb7acf8 100644 --- a/docs/generators/cpp-tizen/index.html +++ b/docs/generators/cpp-tizen/index.html @@ -15,13 +15,13 @@ - +

                Documentation for the cpp-tizen Generator

                METADATA​

                PropertyValueNotes
                generator namecpp-tizenpass this to the generate command after -g
                generator stabilitySTABLE
                generator typeCLIENT
                generator languageC++
                generator default templating enginemustache
                helpTxtGenerates a Samsung Tizen C++ client library.

                CONFIG OPTIONS​

                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                OptionDescriptionValuesDefault
                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                false
                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                true
                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                		true
                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                false
                No changes to the enum's are made, this is the default option.
                true
                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                		false
                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                true
                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                false
                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                		true
                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                reservedWordPrefixPrefix to prepend to reserved words in order to avoid conflictsr_
                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                variableNameFirstCharacterUppercaseMake first character of variable name uppercase (eg. value -> Value)true

                IMPORT MAPPING​

                Type/AliasImports

                INSTANTIATION TYPES​

                Type/AliasInstantiated By

                LANGUAGE PRIMITIVES​

                • bool
                • double
                • float
                • int
                • long long
                • std::string

                RESERVED WORDS​

                • alignas
                • alignof
                • and
                • and_eq
                • asm
                • atomic_cancel
                • atomic_commit
                • atomic_noexcept
                • auto
                • bitand
                • bitor
                • bool
                • break
                • case
                • catch
                • char
                • char16_t
                • char32_t
                • class
                • compl
                • concept
                • const
                • const_cast
                • constexpr
                • continue
                • decltype
                • default
                • delete
                • do
                • double
                • dynamic_cast
                • else
                • enum
                • explicit
                • export
                • extern
                • false
                • float
                • for
                • friend
                • goto
                • if
                • import
                • inline
                • int
                • long
                • module
                • mutable
                • namespace
                • new
                • noexcept
                • not
                • not_eq
                • nullptr
                • operator
                • or
                • or_eq
                • private
                • protected
                • public
                • register
                • reinterpret_cast
                • requires
                • return
                • short
                • signed
                • sizeof
                • static
                • static_assert
                • static_cast
                • struct
                • switch
                • synchronized
                • template
                • this
                • thread_local
                • throw
                • true
                • try
                • typedef
                • typeid
                • typename
                • union
                • unsigned
                • using
                • virtual
                • void
                • volatile
                • wchar_t
                • while
                • xor
                • xor_eq

                FEATURE SET​

                Client Modification Feature​

                NameSupportedDefined By
                BasePath✗ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✗ToolingExtension
                MockServer✗ToolingExtension

                Data Type Feature​

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Uuid✗
                Array✓OAS2,OAS3
                Null✗OAS3
                AnyType✗OAS2,OAS3
                Object✓OAS2,OAS3
                Maps✓ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✓OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✓ToolingExtension
                MapOfModel✓ToolingExtension
                MapOfCollectionOfPrimitives✓ToolingExtension
                MapOfCollectionOfModel✓ToolingExtension
                MapOfCollectionOfEnum✓ToolingExtension

                Documentation Feature​

                NameSupportedDefined By
                Readme✓ToolingExtension
                Model✓ToolingExtension
                Api✓ToolingExtension

                Global Feature​

                NameSupportedDefined By
                Host✓OAS2,OAS3
                BasePath✓OAS2,OAS3
                Info✓OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✓OAS2,OAS3
                Consumes✓OAS2
                Produces✓OAS2
                ExternalDocumentation✓OAS2,OAS3
                Examples✓OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✗OAS3
                ParameterizedServer✗OAS3
                ParameterStyling✗OAS3
                Callbacks✗OAS3
                LinkObjects✗OAS3

                Parameter Feature​

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✓OAS2,OAS3
                Header✓OAS2,OAS3
                Body✓OAS2
                FormUnencoded✓OAS2
                FormMultipart✓OAS2
                Cookie✗OAS3

                Schema Support Feature​

                NameSupportedDefined By
                Simple✓OAS2,OAS3
                Composite✓OAS2,OAS3
                Polymorphism✗OAS2,OAS3
                Union✗OAS3
                allOf✗OAS2,OAS3
                anyOf✗OAS3
                oneOf✗OAS3
                not✗OAS3

                Security Feature​

                NameSupportedDefined By
                BasicAuth✗OAS2,OAS3
                ApiKey✗OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✓OAS3
                OAuth2_Implicit✗OAS2,OAS3
                OAuth2_Password✗OAS2,OAS3
                OAuth2_ClientCredentials✗OAS2,OAS3
                OAuth2_AuthorizationCode✗OAS2,OAS3
                SignatureAuth✗OAS3
                AWSV4Signature✗ToolingExtension

                Wire Format Feature​

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✓OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✗OAS2,OAS3
                - + \ No newline at end of file diff --git a/docs/generators/cpp-ue4/index.html b/docs/generators/cpp-ue4/index.html index 5399a009d58..09a7981566f 100644 --- a/docs/generators/cpp-ue4/index.html +++ b/docs/generators/cpp-ue4/index.html @@ -15,13 +15,13 @@ - +

                Documentation for the cpp-ue4 Generator

                METADATA​

                PropertyValueNotes
                generator namecpp-ue4pass this to the generate command after -g
                generator stabilityBETA
                generator typeCLIENT
                generator languageC++
                generator default templating enginemustache
                helpTxtGenerates a Unreal Engine 4 C++ Module (beta).

                CONFIG OPTIONS​

                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                OptionDescriptionValuesDefault
                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                cppNamespaceC++ namespace (convention: name::space::for::api).OpenAPI
                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                false
                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                true
                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                		true
                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                false
                No changes to the enum's are made, this is the default option.
                true
                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                		false
                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                true
                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                false
                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                		true
                optionalProjectFileGenerate Build.cstrue
                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                reservedWordPrefixPrefix to prepend to reserved words in order to avoid conflictsr_
                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                unrealModuleNameName of the generated unreal module (optional)OpenAPI
                variableNameFirstCharacterUppercaseMake first character of variable name uppercase (eg. value -> Value)true

                IMPORT MAPPING​

                Type/AliasImports
                HttpFileInput#include "OpenAPIHelpers.h"

                INSTANTIATION TYPES​

                Type/AliasInstantiated By

                LANGUAGE PRIMITIVES​

                • FDateTime
                • FGuid
                • FString
                • TArray
                • TArray<uint8>
                • TMap
                • TSet
                • TSharedPtr<FJsonObject>
                • TSharedPtr<FJsonValue>
                • bool
                • double
                • float
                • int32
                • int64

                RESERVED WORDS​

                • NULL
                • alignas
                • alignof
                • and
                • and_eq
                • asm
                • auto
                • bitand
                • bitor
                • bool
                • break
                • case
                • catch
                • char
                • char16_t
                • char32_t
                • class
                • compl
                • concept
                • const
                • const_cast
                • constexpr
                • continue
                • decltype
                • default
                • delete
                • do
                • double
                • dynamic_cast
                • else
                • enum
                • explicit
                • export
                • extern
                • false
                • float
                • for
                • friend
                • goto
                • if
                • inline
                • int
                • linux
                • long
                • mutable
                • namespace
                • new
                • noexcept
                • not
                • not_eq
                • nullptr
                • operator
                • or
                • or_eq
                • private
                • protected
                • public
                • register
                • reinterpret_cast
                • requires
                • return
                • short
                • signed
                • sizeof
                • static
                • static_assert
                • static_cast
                • struct
                • switch
                • template
                • this
                • thread_local
                • throw
                • true
                • try
                • typedef
                • typeid
                • typename
                • union
                • unsigned
                • using
                • virtual
                • void
                • volatile
                • wchar_t
                • while
                • xor
                • xor_eq

                FEATURE SET​

                Client Modification Feature​

                NameSupportedDefined By
                BasePath✗ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✗ToolingExtension
                MockServer✗ToolingExtension

                Data Type Feature​

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Uuid✗
                Array✓OAS2,OAS3
                Null✗OAS3
                AnyType✗OAS2,OAS3
                Object✓OAS2,OAS3
                Maps✓ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✓OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✓ToolingExtension
                MapOfModel✓ToolingExtension
                MapOfCollectionOfPrimitives✓ToolingExtension
                MapOfCollectionOfModel✓ToolingExtension
                MapOfCollectionOfEnum✓ToolingExtension

                Documentation Feature​

                NameSupportedDefined By
                Readme✗ToolingExtension
                Model✓ToolingExtension
                Api✓ToolingExtension

                Global Feature​

                NameSupportedDefined By
                Host✓OAS2,OAS3
                BasePath✓OAS2,OAS3
                Info✓OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✓OAS2,OAS3
                Consumes✓OAS2
                Produces✓OAS2
                ExternalDocumentation✓OAS2,OAS3
                Examples✓OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✗OAS3
                ParameterizedServer✗OAS3
                ParameterStyling✗OAS3
                Callbacks✓OAS3
                LinkObjects✗OAS3

                Parameter Feature​

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✓OAS2,OAS3
                Header✓OAS2,OAS3
                Body✓OAS2
                FormUnencoded✓OAS2
                FormMultipart✓OAS2
                Cookie✓OAS3

                Schema Support Feature​

                NameSupportedDefined By
                Simple✓OAS2,OAS3
                Composite✓OAS2,OAS3
                Polymorphism✓OAS2,OAS3
                Union✗OAS3
                allOf✗OAS2,OAS3
                anyOf✗OAS3
                oneOf✗OAS3
                not✗OAS3

                Security Feature​

                NameSupportedDefined By
                BasicAuth✓OAS2,OAS3
                ApiKey✓OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✓OAS3
                OAuth2_Implicit✓OAS2,OAS3
                OAuth2_Password✓OAS2,OAS3
                OAuth2_ClientCredentials✓OAS2,OAS3
                OAuth2_AuthorizationCode✓OAS2,OAS3
                SignatureAuth✗OAS3
                AWSV4Signature✗ToolingExtension

                Wire Format Feature​

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✓OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✗OAS2,OAS3
                - + \ No newline at end of file diff --git a/docs/generators/crystal/index.html b/docs/generators/crystal/index.html index dd39bc52b9b..e5dde5245d0 100644 --- a/docs/generators/crystal/index.html +++ b/docs/generators/crystal/index.html @@ -15,13 +15,13 @@ - +

                Documentation for the crystal Generator

                METADATA​

                PropertyValueNotes
                generator namecrystalpass this to the generate command after -g
                generator stabilityBETA
                generator typeCLIENT
                generator languageCrystal
                generator default templating enginemustache
                helpTxtGenerates a Crystal client library (beta).

                CONFIG OPTIONS​

                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                OptionDescriptionValuesDefault
                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                false
                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                true
                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                		true
                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                false
                No changes to the enum's are made, this is the default option.
                true
                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                		false
                hideGenerationTimestampHides the generation timestamp when files are generated.true
                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                true
                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                false
                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                		true
                moduleNamemodule name (e.g. TwitterClientOpenAPIClient
                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                shardAuthorshard author (only one is supported).null
                shardAuthorEmailshard author email (only one is supported).null
                shardDescriptionshard description.This shard maps to a REST API
                shardHomepageshard homepage.http://org.openapitools
                shardLicenseshard license.unlicense
                shardNameshard name (e.g. twitter_clientopenapi_client
                shardVersionshard version.1.0.0
                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                IMPORT MAPPING​

                Type/AliasImports

                INSTANTIATION TYPES​

                Type/AliasInstantiated By
                arrayArray
                mapHash
                setSet

                LANGUAGE PRIMITIVES​

                • ::File
                • Array
                • Boolean
                • Date
                • Float
                • Hash
                • Integer
                • Object
                • String
                • Time

                RESERVED WORDS​

                • abstract
                • alias
                • annotation
                • as
                • as?
                • asm
                • begin
                • break
                • case
                • class
                • def
                • do
                • else
                • elsif
                • end
                • ensure
                • enum
                • extend
                • false
                • for
                • fun
                • if
                • in
                • include
                • instance
                • is_a?
                • lib
                • macro
                • module
                • next
                • nil
                • nil?
                • of
                • out
                • pointerof
                • private
                • protected
                • require
                • rescue
                • responds_to?
                • return
                • select
                • self
                • sizeof
                • struct
                • super
                • then
                • true
                • type
                • typeof
                • uninitialized
                • union
                • unless
                • until
                • verbatim
                • when
                • while
                • with
                • yield

                FEATURE SET​

                Client Modification Feature​

                NameSupportedDefined By
                BasePath✓ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✓ToolingExtension
                MockServer✗ToolingExtension

                Data Type Feature​

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Uuid✗
                Array✓OAS2,OAS3
                Null✗OAS3
                AnyType✗OAS2,OAS3
                Object✓OAS2,OAS3
                Maps✓ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✓OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✓ToolingExtension
                MapOfModel✓ToolingExtension
                MapOfCollectionOfPrimitives✓ToolingExtension
                MapOfCollectionOfModel✓ToolingExtension
                MapOfCollectionOfEnum✓ToolingExtension

                Documentation Feature​

                NameSupportedDefined By
                Readme✓ToolingExtension
                Model✓ToolingExtension
                Api✓ToolingExtension

                Global Feature​

                NameSupportedDefined By
                Host✓OAS2,OAS3
                BasePath✓OAS2,OAS3
                Info✓OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✓OAS2,OAS3
                Consumes✓OAS2
                Produces✓OAS2
                ExternalDocumentation✓OAS2,OAS3
                Examples✓OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✗OAS3
                ParameterizedServer✗OAS3
                ParameterStyling✗OAS3
                Callbacks✗OAS3
                LinkObjects✗OAS3

                Parameter Feature​

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✓OAS2,OAS3
                Header✓OAS2,OAS3
                Body✓OAS2
                FormUnencoded✓OAS2
                FormMultipart✓OAS2
                Cookie✗OAS3

                Schema Support Feature​

                NameSupportedDefined By
                Simple✓OAS2,OAS3
                Composite✓OAS2,OAS3
                Polymorphism✓OAS2,OAS3
                Union✗OAS3
                allOf✗OAS2,OAS3
                anyOf✗OAS3
                oneOf✗OAS3
                not✗OAS3

                Security Feature​

                NameSupportedDefined By
                BasicAuth✓OAS2,OAS3
                ApiKey✓OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✓OAS3
                OAuth2_Implicit✓OAS2,OAS3
                OAuth2_Password✗OAS2,OAS3
                OAuth2_ClientCredentials✗OAS2,OAS3
                OAuth2_AuthorizationCode✗OAS2,OAS3
                SignatureAuth✗OAS3
                AWSV4Signature✗ToolingExtension

                Wire Format Feature​

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✓OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✓OAS2,OAS3
                - + \ No newline at end of file diff --git a/docs/generators/csharp-functions/index.html b/docs/generators/csharp-functions/index.html index 644bb6419d3..b7990eaa735 100644 --- a/docs/generators/csharp-functions/index.html +++ b/docs/generators/csharp-functions/index.html @@ -15,13 +15,13 @@ - +

                Documentation for the csharp-functions Generator

                METADATA​

                PropertyValueNotes
                generator namecsharp-functionspass this to the generate command after -g
                generator stabilitySTABLE
                generator typeSERVER
                generator languageC#
                generator default templating enginemustache
                helpTxtCreates Azure function templates on top of the models/converters created by the C# codegens. This function is contained in a partial class. Default Get/Create/Patch/Post etc. methods are created with an underscore prefix. The assumption is that when the function is implemented, the partial class will be completed with another partial class. The implementing code should be located in a method of the same name, only without the underscore prefix. If no such method is found then the function will throw a Not Implemented exception. This setup allows the endpoints to be specified in the schema at build time, and separated from the implementing function.

                CONFIG OPTIONS​

                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                OptionDescriptionValuesDefault
                azureFunctionsVersionAzure functions version: v4, v3
                v4
                Azure Functions v4
                v3
                Azure Functions v3
                		v4
                buildTargetTarget to build an application or library
                program
                Generate code for a standalone server
                library
                Generate code for a server abstract class library
                		program
                classModifierClass Modifier for function classes: Empty string or abstract.
                enumNameSuffixSuffix that will be appended to all enum names.Enum
                enumValueSuffixSuffix that will be appended to all enum values.Enum
                generateBodyGenerates method body.true
                licenseNameThe name of the licenseNoLicense
                licenseUrlThe URL of the licensehttp://localhost
                modelClassModifierModel Class Modifier can be nothing or partialpartial
                netCoreVersion.NET Core version: 6.0, 5.0, 3.1, 3.0
                3.0
                .NET Core 3.0
                3.1
                .NET Core 3.1
                5.0
                .NET Core 5.0
                6.0
                .NET Core 6.0
                		3.1
                newtonsoftVersionVersion for Newtonsoft.Json for .NET Core 3.0+3.0.0
                nullableReferenceTypesUse nullable annotations in the project. Only supported on C# 8 / ASP.NET Core 3.1 or newer.false
                operationIsAsyncSet methods to async or sync (default).false
                operationModifierOperation Modifier can be virtual or abstract
                virtual
                Keep method virtual
                abstract
                Make method abstract
                		virtual
                operationResultTaskSet methods result to Task<>.false
                packageAuthorsSpecifies Authors property in the .NET Core project file.OpenAPI
                packageCopyrightSpecifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.No Copyright
                packageDescriptionSpecifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.A library generated from a OpenAPI doc
                packageGuidThe GUID that will be associated with the C# projectnull
                packageNameC# package name (convention: Title.Case).Org.OpenAPITools
                packageTitleSpecifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.OpenAPI Library
                packageVersionC# package version.1.0.0
                returnICollectionReturn ICollection<T> instead of the concrete type.false
                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                sourceFoldersource folder for generated codesrc
                useCollectionDeserialize array types to Collection<T> instead of List<T>.false
                useDateTimeForDateUse DateTime to model date properties even if DateOnly supported. (.net 6.0+ only)false
                useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
                useNewtonsoftUses the Newtonsoft JSON library.true

                IMPORT MAPPING​

                Type/AliasImports

                INSTANTIATION TYPES​

                Type/AliasInstantiated By
                arrayList
                listList
                mapDictionary

                LANGUAGE PRIMITIVES​

                • Boolean
                • Collection
                • DateOnly
                • DateOnly?
                • DateTime
                • DateTime?
                • DateTimeOffset
                • DateTimeOffset?
                • Decimal
                • Dictionary
                • Double
                • Float
                • Guid
                • Guid?
                • ICollection
                • Int32
                • Int64
                • List
                • Object
                • String
                • System.IO.Stream
                • bool
                • bool?
                • byte[]
                • decimal
                • decimal?
                • double
                • double?
                • float
                • float?
                • int
                • int?
                • long
                • long?
                • string
                • uint
                • uint?
                • ulong
                • ulong?

                RESERVED WORDS​

                • Client
                • Configuration
                • Environment
                • OperatingSystem
                • TimeZone
                • Version
                • abstract
                • as
                • async
                • await
                • base
                • bool
                • break
                • byte
                • case
                • catch
                • char
                • checked
                • class
                • client
                • const
                • continue
                • decimal
                • default
                • delegate
                • do
                • double
                • dynamic
                • else
                • enum
                • event
                • explicit
                • extern
                • false
                • finally
                • fixed
                • float
                • for
                • foreach
                • goto
                • if
                • implicit
                • in
                • int
                • interface
                • internal
                • is
                • localVarFileParams
                • localVarFormParams
                • localVarHeaderParams
                • localVarHttpContentType
                • localVarHttpContentTypes
                • localVarHttpHeaderAccept
                • localVarHttpHeaderAccepts
                • localVarPath
                • localVarPathParams
                • localVarPostBody
                • localVarQueryParams
                • localVarResponse
                • localVarStatusCode
                • lock
                • long
                • namespace
                • new
                • null
                • object
                • operator
                • out
                • override
                • parameter
                • params
                • private
                • protected
                • public
                • readonly
                • ref
                • return
                • sbyte
                • sealed
                • short
                • sizeof
                • stackalloc
                • static
                • string
                • struct
                • switch
                • system
                • this
                • throw
                • true
                • try
                • typeof
                • uint
                • ulong
                • unchecked
                • unsafe
                • ushort
                • using
                • var
                • virtual
                • void
                • volatile
                • while
                • yield

                FEATURE SET​

                Client Modification Feature​

                NameSupportedDefined By
                BasePath✗ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✗ToolingExtension
                MockServer✗ToolingExtension

                Data Type Feature​

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Uuid✗
                Array✓OAS2,OAS3
                Null✗OAS3
                AnyType✗OAS2,OAS3
                Object✓OAS2,OAS3
                Maps✓ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✓OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✓ToolingExtension
                MapOfModel✓ToolingExtension
                MapOfCollectionOfPrimitives✓ToolingExtension
                MapOfCollectionOfModel✓ToolingExtension
                MapOfCollectionOfEnum✓ToolingExtension

                Documentation Feature​

                NameSupportedDefined By
                Readme✓ToolingExtension
                Model✓ToolingExtension
                Api✓ToolingExtension

                Global Feature​

                NameSupportedDefined By
                Host✓OAS2,OAS3
                BasePath✓OAS2,OAS3
                Info✓OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✓OAS2,OAS3
                Consumes✓OAS2
                Produces✓OAS2
                ExternalDocumentation✓OAS2,OAS3
                Examples✓OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✗OAS3
                ParameterizedServer✗OAS3
                ParameterStyling✗OAS3
                Callbacks✗OAS3
                LinkObjects✗OAS3

                Parameter Feature​

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✓OAS2,OAS3
                Header✓OAS2,OAS3
                Body✓OAS2
                FormUnencoded✓OAS2
                FormMultipart✓OAS2
                Cookie✓OAS3

                Schema Support Feature​

                NameSupportedDefined By
                Simple✓OAS2,OAS3
                Composite✓OAS2,OAS3
                Polymorphism✓OAS2,OAS3
                Union✗OAS3
                allOf✗OAS2,OAS3
                anyOf✗OAS3
                oneOf✗OAS3
                not✗OAS3

                Security Feature​

                NameSupportedDefined By
                BasicAuth✓OAS2,OAS3
                ApiKey✓OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✓OAS3
                OAuth2_Implicit✗OAS2,OAS3
                OAuth2_Password✗OAS2,OAS3
                OAuth2_ClientCredentials✗OAS2,OAS3
                OAuth2_AuthorizationCode✗OAS2,OAS3
                SignatureAuth✗OAS3
                AWSV4Signature✗ToolingExtension

                Wire Format Feature​

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✓OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✗OAS2,OAS3
                - + \ No newline at end of file diff --git a/docs/generators/csharp/index.html b/docs/generators/csharp/index.html index 7533751cf48..f68a704bd81 100644 --- a/docs/generators/csharp/index.html +++ b/docs/generators/csharp/index.html @@ -15,13 +15,13 @@ - +

                Documentation for the csharp Generator

                METADATA​

                PropertyValueNotes
                generator namecsharppass this to the generate command after -g
                generator stabilitySTABLE
                generator typeCLIENT
                generator languageC#
                generator default templating enginemustache
                helpTxtGenerates a C# client library (.NET Standard, .NET Core).

                CONFIG OPTIONS​

                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                OptionDescriptionValuesDefault
                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                apiNameMust be a valid C# class name. Only used in Generic Host library. Default: ApiApi
                caseInsensitiveResponseHeadersMake API response's headers case-insensitivefalse
                conditionalSerializationSerialize only those properties which are initialized by user, accepted values are true or false, default value is false.false
                dateFormatThe default Date format (only generichost library supports this option).yyyy'-'MM'-'dd
                dateTimeFormatThe default DateTime format (only generichost library supports this option).yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fffffffK
                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                false
                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                true
                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                		true
                equatableOverrides Equals and GetHashCode methods.false
                hideGenerationTimestampHides the generation timestamp when files are generated.true
                interfacePrefixPrefix interfaces with a community standard or widely accepted prefix.I
                libraryHTTP library template (sub-template) to use
                generichost
                HttpClient with Generic Host dependency injection (https://docs.microsoft.com/en-us/dotnet/core/extensions/generic-host) (Experimental. Subject to breaking changes without notice.)
                httpclient
                HttpClient (https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient) (Experimental. Subject to breaking changes without notice.)
                unityWebRequest
                UnityWebRequest (...) (Experimental. Subject to breaking changes without notice.)
                restsharp
                RestSharp (https://github.com/restsharp/RestSharp)
                		restsharp
                licenseIdThe identifier of the licensenull
                modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namePascalCase
                modelPropertySortingOne of legacy, alphabetical, default.default
                netCoreProjectFileUse the new format (.NET Core) for .NET project files (.csproj).false
                nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.false
                nullableReferenceTypesUse nullable annotations in the project. Only supported on C# 8 / ASP.NET Core 3.1 or newer. Starting in .NET 6.0 the default is true.false
                operationParameterSortingOne of legacy, alphabetical, default.default
                optionalAssemblyInfoGenerate AssemblyInfo.cs.true
                optionalEmitDefaultValuesSet DataMember's EmitDefaultValue.false
                optionalMethodArgumentC# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).true
                optionalProjectFileGenerate {PackageName}.csproj.true
                packageGuidThe GUID that will be associated with the C# projectnull
                packageNameC# package name (convention: Title.Case).Org.OpenAPITools
                packageTagsTags to identify the packagenull
                packageVersionC# package version.1.0.0
                releaseNoteRelease note, default to 'Minor update'.Minor update
                returnICollectionReturn ICollection<T> instead of the concrete type.false
                sourceFoldersource folder for generated codesrc
                targetFrameworkThe target .NET framework version. To target multiple frameworks, use ; as the separator, e.g. netstandard2.1;netcoreapp3.1
                netstandard1.3
                .NET Standard 1.3
                netstandard1.4
                .NET Standard 1.4
                netstandard1.5
                .NET Standard 1.5
                netstandard1.6
                .NET Standard 1.6
                netstandard2.0
                .NET Standard 2.0
                netstandard2.1
                .NET Standard 2.1
                net47
                .NET Framework 4.7
                net48
                .NET Framework 4.8
                net6.0
                .NET 6.0 (End of Support 12 November 2024)
                net7.0
                .NET 7.0
                net8.0
                .NET 8.0
                		net8.0
                useCollectionDeserialize array types to Collection<T> instead of List<T>.false
                useDateTimeForDateUse DateTime to model date properties even if DateOnly supported. (.net 6.0+ only)false
                useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
                useIntForTimeoutUse int for Timeout (fall back to v7.9.0 templates). This option (for restsharp only) will be deprecated so please migrated to TimeSpan instead.false
                useOneOfDiscriminatorLookupUse the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped.false
                useSourceGenerationUse source generation where available (only generichost library supports this option).false
                validatableGenerates self-validatable models.true
                zeroBasedEnumsEnumerations with string values will start from 0 when true, 1 when false. If not set, enumerations with string values will start from 0 if the first value is 'unknown', case insensitive.null

                IMPORT MAPPING​

                Type/AliasImports

                INSTANTIATION TYPES​

                Type/AliasInstantiated By
                arrayList
                listList
                mapDictionary

                LANGUAGE PRIMITIVES​

                • Boolean
                • Collection
                • DateOnly
                • DateOnly?
                • DateTime
                • DateTime?
                • DateTimeOffset
                • DateTimeOffset?
                • Decimal
                • Dictionary
                • Double
                • Float
                • Guid
                • Guid?
                • ICollection
                • Int32
                • Int64
                • List
                • Object
                • String
                • System.IO.Stream
                • bool
                • bool?
                • byte[]
                • decimal
                • decimal?
                • double
                • double?
                • float
                • float?
                • int
                • int?
                • long
                • long?
                • string
                • uint
                • uint?
                • ulong
                • ulong?

                RESERVED WORDS​

                • Client
                • Configuration
                • Environment
                • OperatingSystem
                • TimeZone
                • Version
                • abstract
                • as
                • base
                • bool
                • break
                • byte
                • case
                • catch
                • char
                • checked
                • class
                • client
                • const
                • continue
                • decimal
                • default
                • delegate
                • do
                • double
                • else
                • enum
                • event
                • explicit
                • extern
                • false
                • finally
                • fixed
                • float
                • for
                • foreach
                • goto
                • if
                • implicit
                • in
                • int
                • interface
                • internal
                • is
                • localVarFileParams
                • localVarFormParams
                • localVarHeaderParams
                • localVarHttpContentType
                • localVarHttpContentTypes
                • localVarHttpHeaderAccept
                • localVarHttpHeaderAccepts
                • localVarPath
                • localVarPathParams
                • localVarPostBody
                • localVarQueryParams
                • localVarResponse
                • localVarStatusCode
                • lock
                • long
                • namespace
                • new
                • null
                • object
                • operator
                • out
                • override
                • parameter
                • params
                • private
                • protected
                • public
                • readonly
                • ref
                • return
                • sbyte
                • sealed
                • short
                • sizeof
                • stackalloc
                • static
                • string
                • struct
                • switch
                • system
                • this
                • throw
                • true
                • try
                • typeof
                • uint
                • ulong
                • unchecked
                • unsafe
                • ushort
                • using
                • virtual
                • void
                • volatile
                • while

                FEATURE SET​

                Client Modification Feature​

                NameSupportedDefined By
                BasePath✓ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✓ToolingExtension
                MockServer✗ToolingExtension

                Data Type Feature​

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Uuid✗
                Array✓OAS2,OAS3
                Null✗OAS3
                AnyType✗OAS2,OAS3
                Object✓OAS2,OAS3
                Maps✓ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✓OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✓ToolingExtension
                MapOfModel✓ToolingExtension
                MapOfCollectionOfPrimitives✓ToolingExtension
                MapOfCollectionOfModel✓ToolingExtension
                MapOfCollectionOfEnum✓ToolingExtension

                Documentation Feature​

                NameSupportedDefined By
                Readme✓ToolingExtension
                Model✓ToolingExtension
                Api✓ToolingExtension

                Global Feature​

                NameSupportedDefined By
                Host✓OAS2,OAS3
                BasePath✓OAS2,OAS3
                Info✓OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✓OAS2,OAS3
                Consumes✓OAS2
                Produces✓OAS2
                ExternalDocumentation✓OAS2,OAS3
                Examples✓OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✗OAS3
                ParameterizedServer✗OAS3
                ParameterStyling✗OAS3
                Callbacks✗OAS3
                LinkObjects✗OAS3

                Parameter Feature​

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✓OAS2,OAS3
                Header✓OAS2,OAS3
                Body✓OAS2
                FormUnencoded✓OAS2
                FormMultipart✓OAS2
                Cookie✓OAS3

                Schema Support Feature​

                NameSupportedDefined By
                Simple✓OAS2,OAS3
                Composite✓OAS2,OAS3
                Polymorphism✓OAS2,OAS3
                Union✗OAS3
                allOf✗OAS2,OAS3
                anyOf✗OAS3
                oneOf✗OAS3
                not✗OAS3

                Security Feature​

                NameSupportedDefined By
                BasicAuth✓OAS2,OAS3
                ApiKey✓OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✓OAS3
                OAuth2_Implicit✓OAS2,OAS3
                OAuth2_Password✗OAS2,OAS3
                OAuth2_ClientCredentials✓OAS2,OAS3
                OAuth2_AuthorizationCode✗OAS2,OAS3
                SignatureAuth✓OAS3
                AWSV4Signature✗ToolingExtension

                Wire Format Feature​

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✓OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✗OAS2,OAS3
                - + \ No newline at end of file diff --git a/docs/generators/cwiki/index.html b/docs/generators/cwiki/index.html index 5242d268f8c..3c737957681 100644 --- a/docs/generators/cwiki/index.html +++ b/docs/generators/cwiki/index.html @@ -15,13 +15,13 @@ - +

                Documentation for the cwiki Generator

                METADATA​

                PropertyValueNotes
                generator namecwikipass this to the generate command after -g
                generator stabilitySTABLE
                generator typeDOCUMENTATION
                generator default templating enginemustache
                helpTxtGenerates confluence wiki markup.

                CONFIG OPTIONS​

                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                OptionDescriptionValuesDefault
                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                appDescriptiondescription of the applicationnull
                appNameshort name of the applicationnull
                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.null
                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                false
                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                true
                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                		true
                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                false
                No changes to the enum's are made, this is the default option.
                true
                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                		false
                groupIdgroupId in generated pom.xmlnull
                infoEmailan email address to contact for inquiries about the applicationnull
                infoUrla URL where users can get more information about the applicationnull
                invokerPackageroot package for generated codenull
                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                true
                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                false
                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                		true
                licenseInfoa short description of the licensenull
                licenseUrla URL pointing to the full licensenull
                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                IMPORT MAPPING​

                Type/AliasImports

                INSTANTIATION TYPES​

                Type/AliasInstantiated By

                LANGUAGE PRIMITIVES​

                  RESERVED WORDS​

                    FEATURE SET​

                    Client Modification Feature​

                    NameSupportedDefined By
                    BasePath✗ToolingExtension
                    Authorizations✗ToolingExtension
                    UserAgent✗ToolingExtension
                    MockServer✗ToolingExtension

                    Data Type Feature​

                    NameSupportedDefined By
                    Custom✗OAS2,OAS3
                    Int32✓OAS2,OAS3
                    Int64✓OAS2,OAS3
                    Float✓OAS2,OAS3
                    Double✓OAS2,OAS3
                    Decimal✓ToolingExtension
                    String✓OAS2,OAS3
                    Byte✓OAS2,OAS3
                    Binary✓OAS2,OAS3
                    Boolean✓OAS2,OAS3
                    Date✓OAS2,OAS3
                    DateTime✓OAS2,OAS3
                    Password✓OAS2,OAS3
                    File✓OAS2
                    Uuid✗
                    Array✓OAS2,OAS3
                    Null✗OAS3
                    AnyType✗OAS2,OAS3
                    Object✓OAS2,OAS3
                    Maps✓ToolingExtension
                    CollectionFormat✓OAS2
                    CollectionFormatMulti✓OAS2
                    Enum✓OAS2,OAS3
                    ArrayOfEnum✓ToolingExtension
                    ArrayOfModel✓ToolingExtension
                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                    ArrayOfCollectionOfModel✓ToolingExtension
                    ArrayOfCollectionOfEnum✓ToolingExtension
                    MapOfEnum✓ToolingExtension
                    MapOfModel✓ToolingExtension
                    MapOfCollectionOfPrimitives✓ToolingExtension
                    MapOfCollectionOfModel✓ToolingExtension
                    MapOfCollectionOfEnum✓ToolingExtension

                    Documentation Feature​

                    NameSupportedDefined By
                    Readme✗ToolingExtension
                    Model✗ToolingExtension
                    Api✗ToolingExtension

                    Global Feature​

                    NameSupportedDefined By
                    Host✓OAS2,OAS3
                    BasePath✓OAS2,OAS3
                    Info✓OAS2,OAS3
                    Schemes✗OAS2,OAS3
                    PartialSchemes✓OAS2,OAS3
                    Consumes✓OAS2
                    Produces✓OAS2
                    ExternalDocumentation✓OAS2,OAS3
                    Examples✓OAS2,OAS3
                    XMLStructureDefinitions✗OAS2,OAS3
                    MultiServer✗OAS3
                    ParameterizedServer✗OAS3
                    ParameterStyling✗OAS3
                    Callbacks✓OAS3
                    LinkObjects✗OAS3

                    Parameter Feature​

                    NameSupportedDefined By
                    Path✓OAS2,OAS3
                    Query✓OAS2,OAS3
                    Header✓OAS2,OAS3
                    Body✓OAS2
                    FormUnencoded✓OAS2
                    FormMultipart✓OAS2
                    Cookie✗OAS3

                    Schema Support Feature​

                    NameSupportedDefined By
                    Simple✓OAS2,OAS3
                    Composite✓OAS2,OAS3
                    Polymorphism✗OAS2,OAS3
                    Union✗OAS3
                    allOf✗OAS2,OAS3
                    anyOf✗OAS3
                    oneOf✗OAS3
                    not✗OAS3

                    Security Feature​

                    NameSupportedDefined By
                    BasicAuth✗OAS2,OAS3
                    ApiKey✗OAS2,OAS3
                    OpenIDConnect✗OAS3
                    BearerToken✗OAS3
                    OAuth2_Implicit✗OAS2,OAS3
                    OAuth2_Password✗OAS2,OAS3
                    OAuth2_ClientCredentials✗OAS2,OAS3
                    OAuth2_AuthorizationCode✗OAS2,OAS3
                    SignatureAuth✗OAS3
                    AWSV4Signature✗ToolingExtension

                    Wire Format Feature​

                    NameSupportedDefined By
                    JSON✓OAS2,OAS3
                    XML✓OAS2,OAS3
                    PROTOBUF✗ToolingExtension
                    Custom✓OAS2,OAS3
                    - + \ No newline at end of file diff --git a/docs/generators/dart-dio/index.html b/docs/generators/dart-dio/index.html index bdcfef6b04b..70384afed37 100644 --- a/docs/generators/dart-dio/index.html +++ b/docs/generators/dart-dio/index.html @@ -15,13 +15,13 @@ - +

                    Documentation for the dart-dio Generator

                    METADATA​

                    PropertyValueNotes
                    generator namedart-diopass this to the generate command after -g
                    generator stabilitySTABLE
                    generator typeCLIENT
                    generator languageDart
                    generator default templating enginemustache
                    helpTxtGenerates a Dart Dio client library.

                    CONFIG OPTIONS​

                    These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                    OptionDescriptionValuesDefault
                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                    dateLibrarySpecify Date library
                    core
                    [DEFAULT] Dart core library (DateTime)
                    timemachine
                    Time Machine is date and time library for Flutter, Web, and Server with support for timezones, calendars, cultures, formatting and parsing.
                    		core
                    disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                    false
                    The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                    true
                    Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                    		true
                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                    enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                    false
                    No changes to the enum's are made, this is the default option.
                    true
                    With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                    		false
                    equalityCheckMethodSpecify equality check method. Takes effect only in case if serializationLibrary is json_serializable.
                    default
                    [DEFAULT] Built in hash code generation method
                    equatable
                    Uses equatable library for equality checking
                    		default
                    finalPropertiesWhether properties are marked as final when using Json Serializable for serializationtrue
                    legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                    true
                    The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                    false
                    The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                    		true
                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                    pubAuthorAuthor name in generated pubspecAuthor
                    pubAuthorEmailEmail address of the author in generated pubspecauthor@homepage
                    pubDescriptionDescription in generated pubspecOpenAPI API client
                    pubHomepageHomepage in generated pubspechomepage
                    pubLibraryLibrary name in generated codeopenapi.api
                    pubNameName in generated pubspecopenapi
                    pubPublishToPublish_to in generated pubspecnull
                    pubRepositoryRepository in generated pubspecnull
                    pubVersionVersion in generated pubspec1.0.0
                    serializationLibrarySpecify serialization library
                    built_value
                    [DEFAULT] built_value
                    json_serializable
                    [BETA] json_serializable
                    		built_value
                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                    sourceFoldersource folder for generated codesrc
                    useEnumExtensionAllow the 'x-enum-values' extension for enumsfalse

                    IMPORT MAPPING​

                    Type/AliasImports

                    INSTANTIATION TYPES​

                    Type/AliasInstantiated By

                    LANGUAGE PRIMITIVES​

                    • String
                    • bool
                    • double
                    • int
                    • num

                    RESERVED WORDS​

                    • abstract
                    • as
                    • assert
                    • async
                    • augment
                    • await
                    • base
                    • break
                    • case
                    • catch
                    • class
                    • const
                    • continue
                    • covariant
                    • default
                    • deferred
                    • do
                    • dynamic
                    • else
                    • enum
                    • export
                    • extends
                    • extension
                    • external
                    • factory
                    • false
                    • final
                    • finally
                    • for
                    • function
                    • get
                    • hide
                    • if
                    • implements
                    • import
                    • in
                    • inout
                    • interface
                    • is
                    • late
                    • library
                    • mixin
                    • native
                    • new
                    • null
                    • of
                    • on
                    • operator
                    • out
                    • part
                    • patch
                    • required
                    • rethrow
                    • return
                    • sealed
                    • set
                    • show
                    • source
                    • static
                    • super
                    • switch
                    • sync
                    • this
                    • throw
                    • true
                    • try
                    • typedef
                    • var
                    • void
                    • when
                    • while
                    • with
                    • yield

                    FEATURE SET​

                    Client Modification Feature​

                    NameSupportedDefined By
                    BasePath✓ToolingExtension
                    Authorizations✓ToolingExtension
                    UserAgent✓ToolingExtension
                    MockServer✗ToolingExtension

                    Data Type Feature​

                    NameSupportedDefined By
                    Custom✗OAS2,OAS3
                    Int32✓OAS2,OAS3
                    Int64✓OAS2,OAS3
                    Float✓OAS2,OAS3
                    Double✓OAS2,OAS3
                    Decimal✓ToolingExtension
                    String✓OAS2,OAS3
                    Byte✓OAS2,OAS3
                    Binary✓OAS2,OAS3
                    Boolean✓OAS2,OAS3
                    Date✓OAS2,OAS3
                    DateTime✓OAS2,OAS3
                    Password✓OAS2,OAS3
                    File✓OAS2
                    Uuid✗
                    Array✓OAS2,OAS3
                    Null✗OAS3
                    AnyType✗OAS2,OAS3
                    Object✓OAS2,OAS3
                    Maps✓ToolingExtension
                    CollectionFormat✓OAS2
                    CollectionFormatMulti✓OAS2
                    Enum✓OAS2,OAS3
                    ArrayOfEnum✓ToolingExtension
                    ArrayOfModel✓ToolingExtension
                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                    ArrayOfCollectionOfModel✓ToolingExtension
                    ArrayOfCollectionOfEnum✓ToolingExtension
                    MapOfEnum✓ToolingExtension
                    MapOfModel✓ToolingExtension
                    MapOfCollectionOfPrimitives✓ToolingExtension
                    MapOfCollectionOfModel✓ToolingExtension
                    MapOfCollectionOfEnum✓ToolingExtension

                    Documentation Feature​

                    NameSupportedDefined By
                    Readme✓ToolingExtension
                    Model✓ToolingExtension
                    Api✓ToolingExtension

                    Global Feature​

                    NameSupportedDefined By
                    Host✓OAS2,OAS3
                    BasePath✓OAS2,OAS3
                    Info✓OAS2,OAS3
                    Schemes✗OAS2,OAS3
                    PartialSchemes✓OAS2,OAS3
                    Consumes✓OAS2
                    Produces✓OAS2
                    ExternalDocumentation✓OAS2,OAS3
                    Examples✓OAS2,OAS3
                    XMLStructureDefinitions✗OAS2,OAS3
                    MultiServer✗OAS3
                    ParameterizedServer✗OAS3
                    ParameterStyling✗OAS3
                    Callbacks✗OAS3
                    LinkObjects✗OAS3

                    Parameter Feature​

                    NameSupportedDefined By
                    Path✓OAS2,OAS3
                    Query✓OAS2,OAS3
                    Header✓OAS2,OAS3
                    Body✓OAS2
                    FormUnencoded✓OAS2
                    FormMultipart✓OAS2
                    Cookie✓OAS3

                    Schema Support Feature​

                    NameSupportedDefined By
                    Simple✓OAS2,OAS3
                    Composite✓OAS2,OAS3
                    Polymorphism✓OAS2,OAS3
                    Union✓OAS3
                    allOf✓OAS2,OAS3
                    anyOf✓OAS3
                    oneOf✓OAS3
                    not✗OAS3

                    Security Feature​

                    NameSupportedDefined By
                    BasicAuth✓OAS2,OAS3
                    ApiKey✓OAS2,OAS3
                    OpenIDConnect✗OAS3
                    BearerToken✓OAS3
                    OAuth2_Implicit✓OAS2,OAS3
                    OAuth2_Password✗OAS2,OAS3
                    OAuth2_ClientCredentials✗OAS2,OAS3
                    OAuth2_AuthorizationCode✗OAS2,OAS3
                    SignatureAuth✗OAS3
                    AWSV4Signature✗ToolingExtension

                    Wire Format Feature​

                    NameSupportedDefined By
                    JSON✓OAS2,OAS3
                    XML✗OAS2,OAS3
                    PROTOBUF✗ToolingExtension
                    Custom✗OAS2,OAS3
                    - + \ No newline at end of file diff --git a/docs/generators/dart/index.html b/docs/generators/dart/index.html index af78e18259c..0622f3d02ea 100644 --- a/docs/generators/dart/index.html +++ b/docs/generators/dart/index.html @@ -15,13 +15,13 @@ - +

                    Documentation for the dart Generator

                    METADATA​

                    PropertyValueNotes
                    generator namedartpass this to the generate command after -g
                    generator stabilitySTABLE
                    generator typeCLIENT
                    generator languageDart
                    generator default templating enginemustache
                    helpTxtGenerates a Dart client library.

                    CONFIG OPTIONS​

                    These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                    OptionDescriptionValuesDefault
                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                    disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                    false
                    The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                    true
                    Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                    		true
                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                    enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                    false
                    No changes to the enum's are made, this is the default option.
                    true
                    With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                    		false
                    legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                    true
                    The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                    false
                    The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                    		true
                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                    pubAuthorAuthor name in generated pubspecAuthor
                    pubAuthorEmailEmail address of the author in generated pubspecauthor@homepage
                    pubDescriptionDescription in generated pubspecOpenAPI API client
                    pubHomepageHomepage in generated pubspechomepage
                    pubLibraryLibrary name in generated codeopenapi.api
                    pubNameName in generated pubspecopenapi
                    pubPublishToPublish_to in generated pubspecnull
                    pubRepositoryRepository in generated pubspecnull
                    pubVersionVersion in generated pubspec1.0.0
                    serializationLibrarySpecify serialization library
                    native_serialization
                    Use native serializer, backwards compatible
                    		native_serialization
                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                    sourceFoldersource folder for generated codesrc
                    useEnumExtensionAllow the 'x-enum-values' extension for enumsfalse

                    IMPORT MAPPING​

                    Type/AliasImports

                    INSTANTIATION TYPES​

                    Type/AliasInstantiated By

                    LANGUAGE PRIMITIVES​

                    • String
                    • bool
                    • double
                    • int
                    • num

                    RESERVED WORDS​

                    • abstract
                    • as
                    • assert
                    • async
                    • augment
                    • await
                    • base
                    • break
                    • case
                    • catch
                    • class
                    • const
                    • continue
                    • covariant
                    • default
                    • deferred
                    • do
                    • dynamic
                    • else
                    • enum
                    • export
                    • extends
                    • extension
                    • external
                    • factory
                    • false
                    • final
                    • finally
                    • for
                    • function
                    • get
                    • hide
                    • if
                    • implements
                    • import
                    • in
                    • inout
                    • interface
                    • is
                    • late
                    • library
                    • mixin
                    • native
                    • new
                    • null
                    • of
                    • on
                    • operator
                    • out
                    • part
                    • patch
                    • required
                    • rethrow
                    • return
                    • sealed
                    • set
                    • show
                    • source
                    • static
                    • super
                    • switch
                    • sync
                    • this
                    • throw
                    • true
                    • try
                    • typedef
                    • var
                    • void
                    • when
                    • while
                    • with
                    • yield

                    FEATURE SET​

                    Client Modification Feature​

                    NameSupportedDefined By
                    BasePath✓ToolingExtension
                    Authorizations✗ToolingExtension
                    UserAgent✗ToolingExtension
                    MockServer✗ToolingExtension

                    Data Type Feature​

                    NameSupportedDefined By
                    Custom✗OAS2,OAS3
                    Int32✓OAS2,OAS3
                    Int64✓OAS2,OAS3
                    Float✓OAS2,OAS3
                    Double✓OAS2,OAS3
                    Decimal✓ToolingExtension
                    String✓OAS2,OAS3
                    Byte✓OAS2,OAS3
                    Binary✓OAS2,OAS3
                    Boolean✓OAS2,OAS3
                    Date✓OAS2,OAS3
                    DateTime✓OAS2,OAS3
                    Password✓OAS2,OAS3
                    File✓OAS2
                    Uuid✗
                    Array✓OAS2,OAS3
                    Null✗OAS3
                    AnyType✗OAS2,OAS3
                    Object✓OAS2,OAS3
                    Maps✓ToolingExtension
                    CollectionFormat✓OAS2
                    CollectionFormatMulti✓OAS2
                    Enum✓OAS2,OAS3
                    ArrayOfEnum✓ToolingExtension
                    ArrayOfModel✓ToolingExtension
                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                    ArrayOfCollectionOfModel✓ToolingExtension
                    ArrayOfCollectionOfEnum✓ToolingExtension
                    MapOfEnum✓ToolingExtension
                    MapOfModel✓ToolingExtension
                    MapOfCollectionOfPrimitives✓ToolingExtension
                    MapOfCollectionOfModel✓ToolingExtension
                    MapOfCollectionOfEnum✓ToolingExtension

                    Documentation Feature​

                    NameSupportedDefined By
                    Readme✓ToolingExtension
                    Model✓ToolingExtension
                    Api✓ToolingExtension

                    Global Feature​

                    NameSupportedDefined By
                    Host✓OAS2,OAS3
                    BasePath✓OAS2,OAS3
                    Info✓OAS2,OAS3
                    Schemes✗OAS2,OAS3
                    PartialSchemes✓OAS2,OAS3
                    Consumes✓OAS2
                    Produces✓OAS2
                    ExternalDocumentation✓OAS2,OAS3
                    Examples✓OAS2,OAS3
                    XMLStructureDefinitions✗OAS2,OAS3
                    MultiServer✗OAS3
                    ParameterizedServer✗OAS3
                    ParameterStyling✗OAS3
                    Callbacks✗OAS3
                    LinkObjects✗OAS3

                    Parameter Feature​

                    NameSupportedDefined By
                    Path✓OAS2,OAS3
                    Query✓OAS2,OAS3
                    Header✓OAS2,OAS3
                    Body✓OAS2
                    FormUnencoded✓OAS2
                    FormMultipart✓OAS2
                    Cookie✓OAS3

                    Schema Support Feature​

                    NameSupportedDefined By
                    Simple✓OAS2,OAS3
                    Composite✗OAS2,OAS3
                    Polymorphism✗OAS2,OAS3
                    Union✗OAS3
                    allOf✗OAS2,OAS3
                    anyOf✗OAS3
                    oneOf✗OAS3
                    not✗OAS3

                    Security Feature​

                    NameSupportedDefined By
                    BasicAuth✓OAS2,OAS3
                    ApiKey✓OAS2,OAS3
                    OpenIDConnect✗OAS3
                    BearerToken✓OAS3
                    OAuth2_Implicit✓OAS2,OAS3
                    OAuth2_Password✗OAS2,OAS3
                    OAuth2_ClientCredentials✗OAS2,OAS3
                    OAuth2_AuthorizationCode✗OAS2,OAS3
                    SignatureAuth✗OAS3
                    AWSV4Signature✗ToolingExtension

                    Wire Format Feature​

                    NameSupportedDefined By
                    JSON✓OAS2,OAS3
                    XML✗OAS2,OAS3
                    PROTOBUF✗ToolingExtension
                    Custom✗OAS2,OAS3
                    - + \ No newline at end of file diff --git a/docs/generators/dynamic-html/index.html b/docs/generators/dynamic-html/index.html index dfc43d53fbe..ff8bea0810e 100644 --- a/docs/generators/dynamic-html/index.html +++ b/docs/generators/dynamic-html/index.html @@ -15,13 +15,13 @@ - +

                    Documentation for the dynamic-html Generator

                    METADATA​

                    PropertyValueNotes
                    generator namedynamic-htmlpass this to the generate command after -g
                    generator stabilitySTABLE
                    generator typeDOCUMENTATION
                    generator default templating enginemustache
                    helpTxtGenerates a dynamic HTML site.

                    CONFIG OPTIONS​

                    These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                    OptionDescriptionValuesDefault
                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                    artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                    artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.null
                    disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                    false
                    The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                    true
                    Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                    		true
                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                    enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                    false
                    No changes to the enum's are made, this is the default option.
                    true
                    With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                    		false
                    groupIdgroupId in generated pom.xmlnull
                    invokerPackageroot package for generated codenull
                    legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                    true
                    The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                    false
                    The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                    		true
                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                    IMPORT MAPPING​

                    Type/AliasImports

                    INSTANTIATION TYPES​

                    Type/AliasInstantiated By
                    arrayArrayList
                    mapHashMap

                    LANGUAGE PRIMITIVES​

                      RESERVED WORDS​

                        FEATURE SET​

                        Client Modification Feature​

                        NameSupportedDefined By
                        BasePath✗ToolingExtension
                        Authorizations✗ToolingExtension
                        UserAgent✗ToolingExtension
                        MockServer✗ToolingExtension

                        Data Type Feature​

                        NameSupportedDefined By
                        Custom✓OAS2,OAS3
                        Int32✓OAS2,OAS3
                        Int64✓OAS2,OAS3
                        Float✓OAS2,OAS3
                        Double✓OAS2,OAS3
                        Decimal✓ToolingExtension
                        String✓OAS2,OAS3
                        Byte✓OAS2,OAS3
                        Binary✓OAS2,OAS3
                        Boolean✓OAS2,OAS3
                        Date✓OAS2,OAS3
                        DateTime✓OAS2,OAS3
                        Password✓OAS2,OAS3
                        File✓OAS2
                        Uuid✓
                        Array✓OAS2,OAS3
                        Null✓OAS3
                        AnyType✓OAS2,OAS3
                        Object✓OAS2,OAS3
                        Maps✓ToolingExtension
                        CollectionFormat✓OAS2
                        CollectionFormatMulti✓OAS2
                        Enum✓OAS2,OAS3
                        ArrayOfEnum✓ToolingExtension
                        ArrayOfModel✓ToolingExtension
                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                        ArrayOfCollectionOfModel✓ToolingExtension
                        ArrayOfCollectionOfEnum✓ToolingExtension
                        MapOfEnum✓ToolingExtension
                        MapOfModel✓ToolingExtension
                        MapOfCollectionOfPrimitives✓ToolingExtension
                        MapOfCollectionOfModel✓ToolingExtension
                        MapOfCollectionOfEnum✓ToolingExtension

                        Documentation Feature​

                        NameSupportedDefined By
                        Readme✓ToolingExtension
                        Model✓ToolingExtension
                        Api✓ToolingExtension

                        Global Feature​

                        NameSupportedDefined By
                        Host✓OAS2,OAS3
                        BasePath✓OAS2,OAS3
                        Info✓OAS2,OAS3
                        Schemes✓OAS2,OAS3
                        PartialSchemes✓OAS2,OAS3
                        Consumes✓OAS2
                        Produces✓OAS2
                        ExternalDocumentation✓OAS2,OAS3
                        Examples✓OAS2,OAS3
                        XMLStructureDefinitions✓OAS2,OAS3
                        MultiServer✓OAS3
                        ParameterizedServer✓OAS3
                        ParameterStyling✓OAS3
                        Callbacks✓OAS3
                        LinkObjects✓OAS3

                        Parameter Feature​

                        NameSupportedDefined By
                        Path✓OAS2,OAS3
                        Query✓OAS2,OAS3
                        Header✓OAS2,OAS3
                        Body✓OAS2
                        FormUnencoded✓OAS2
                        FormMultipart✓OAS2
                        Cookie✓OAS3

                        Schema Support Feature​

                        NameSupportedDefined By
                        Simple✓OAS2,OAS3
                        Composite✓OAS2,OAS3
                        Polymorphism✓OAS2,OAS3
                        Union✓OAS3
                        allOf✓OAS2,OAS3
                        anyOf✓OAS3
                        oneOf✓OAS3
                        not✓OAS3

                        Security Feature​

                        NameSupportedDefined By
                        BasicAuth✓OAS2,OAS3
                        ApiKey✓OAS2,OAS3
                        OpenIDConnect✓OAS3
                        BearerToken✓OAS3
                        OAuth2_Implicit✓OAS2,OAS3
                        OAuth2_Password✓OAS2,OAS3
                        OAuth2_ClientCredentials✓OAS2,OAS3
                        OAuth2_AuthorizationCode✓OAS2,OAS3
                        SignatureAuth✓OAS3
                        AWSV4Signature✓ToolingExtension

                        Wire Format Feature​

                        NameSupportedDefined By
                        JSON✓OAS2,OAS3
                        XML✓OAS2,OAS3
                        PROTOBUF✓ToolingExtension
                        Custom✓OAS2,OAS3
                        - + \ No newline at end of file diff --git a/docs/generators/eiffel/index.html b/docs/generators/eiffel/index.html index 9294bc54af8..e2cfbecda94 100644 --- a/docs/generators/eiffel/index.html +++ b/docs/generators/eiffel/index.html @@ -15,13 +15,13 @@ - +

                        Documentation for the eiffel Generator

                        METADATA​

                        PropertyValueNotes
                        generator nameeiffelpass this to the generate command after -g
                        generator stabilitySTABLE
                        generator typeCLIENT
                        generator languageEiffel
                        generator default templating enginemustache
                        helpTxtGenerates a Eiffel client library (beta).

                        CONFIG OPTIONS​

                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                        OptionDescriptionValuesDefault
                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                        packageNameEiffel Cluster name (convention: lowercase).openapi
                        packageVersionEiffel package version.1.0.0

                        IMPORT MAPPING​

                        Type/AliasImports
                        FileFILE
                        ListLIST
                        MapSTRING_TABLE
                        SetSET
                        fileFILE

                        INSTANTIATION TYPES​

                        Type/AliasInstantiated By
                        arrayARRAYED_LIST
                        listARRAYED_LIST
                        mapSTRING_TABLE

                        LANGUAGE PRIMITIVES​

                        • BOOLEAN
                        • INTEGER_16
                        • INTEGER_32
                        • INTEGER_64
                        • INTEGER_8
                        • NATURAL_16
                        • NATURAL_32
                        • NATURAL_64
                        • NATURAL_8
                        • REAL_32
                        • REAL_64

                        RESERVED WORDS​

                        • across
                        • agent
                        • alias
                        • all
                        • and
                        • as
                        • assign
                        • attached
                        • attribute
                        • check
                        • class
                        • convert
                        • create
                        • current
                        • debug
                        • deferred
                        • detachable
                        • do
                        • else
                        • elseif
                        • end
                        • ensure
                        • expanded
                        • export
                        • external
                        • false
                        • feature
                        • from
                        • frozen
                        • if
                        • implies
                        • inherit
                        • inspect
                        • invariant
                        • like
                        • local
                        • loop
                        • not
                        • note
                        • obsolete
                        • old
                        • once
                        • only
                        • or
                        • precursor
                        • redefine
                        • rename
                        • require
                        • rescue
                        • result
                        • retry
                        • select
                        • separate
                        • then
                        • true
                        • tuple
                        • undefine
                        • until
                        • variant
                        • void
                        • when
                        • xor

                        FEATURE SET​

                        Client Modification Feature​

                        NameSupportedDefined By
                        BasePath✓ToolingExtension
                        Authorizations✗ToolingExtension
                        UserAgent✓ToolingExtension
                        MockServer✗ToolingExtension

                        Data Type Feature​

                        NameSupportedDefined By
                        Custom✗OAS2,OAS3
                        Int32✓OAS2,OAS3
                        Int64✓OAS2,OAS3
                        Float✓OAS2,OAS3
                        Double✓OAS2,OAS3
                        Decimal✓ToolingExtension
                        String✓OAS2,OAS3
                        Byte✓OAS2,OAS3
                        Binary✓OAS2,OAS3
                        Boolean✓OAS2,OAS3
                        Date✓OAS2,OAS3
                        DateTime✓OAS2,OAS3
                        Password✓OAS2,OAS3
                        File✓OAS2
                        Uuid✗
                        Array✓OAS2,OAS3
                        Null✗OAS3
                        AnyType✗OAS2,OAS3
                        Object✓OAS2,OAS3
                        Maps✓ToolingExtension
                        CollectionFormat✓OAS2
                        CollectionFormatMulti✓OAS2
                        Enum✓OAS2,OAS3
                        ArrayOfEnum✓ToolingExtension
                        ArrayOfModel✓ToolingExtension
                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                        ArrayOfCollectionOfModel✓ToolingExtension
                        ArrayOfCollectionOfEnum✓ToolingExtension
                        MapOfEnum✓ToolingExtension
                        MapOfModel✓ToolingExtension
                        MapOfCollectionOfPrimitives✓ToolingExtension
                        MapOfCollectionOfModel✓ToolingExtension
                        MapOfCollectionOfEnum✓ToolingExtension

                        Documentation Feature​

                        NameSupportedDefined By
                        Readme✓ToolingExtension
                        Model✓ToolingExtension
                        Api✓ToolingExtension

                        Global Feature​

                        NameSupportedDefined By
                        Host✓OAS2,OAS3
                        BasePath✓OAS2,OAS3
                        Info✓OAS2,OAS3
                        Schemes✗OAS2,OAS3
                        PartialSchemes✓OAS2,OAS3
                        Consumes✓OAS2
                        Produces✓OAS2
                        ExternalDocumentation✓OAS2,OAS3
                        Examples✓OAS2,OAS3
                        XMLStructureDefinitions✗OAS2,OAS3
                        MultiServer✗OAS3
                        ParameterizedServer✗OAS3
                        ParameterStyling✗OAS3
                        Callbacks✗OAS3
                        LinkObjects✗OAS3

                        Parameter Feature​

                        NameSupportedDefined By
                        Path✓OAS2,OAS3
                        Query✓OAS2,OAS3
                        Header✓OAS2,OAS3
                        Body✓OAS2
                        FormUnencoded✓OAS2
                        FormMultipart✓OAS2
                        Cookie✗OAS3

                        Schema Support Feature​

                        NameSupportedDefined By
                        Simple✓OAS2,OAS3
                        Composite✓OAS2,OAS3
                        Polymorphism✓OAS2,OAS3
                        Union✗OAS3
                        allOf✗OAS2,OAS3
                        anyOf✗OAS3
                        oneOf✗OAS3
                        not✗OAS3

                        Security Feature​

                        NameSupportedDefined By
                        BasicAuth✓OAS2,OAS3
                        ApiKey✓OAS2,OAS3
                        OpenIDConnect✗OAS3
                        BearerToken✗OAS3
                        OAuth2_Implicit✓OAS2,OAS3
                        OAuth2_Password✗OAS2,OAS3
                        OAuth2_ClientCredentials✗OAS2,OAS3
                        OAuth2_AuthorizationCode✗OAS2,OAS3
                        SignatureAuth✗OAS3
                        AWSV4Signature✗ToolingExtension

                        Wire Format Feature​

                        NameSupportedDefined By
                        JSON✓OAS2,OAS3
                        XML✓OAS2,OAS3
                        PROTOBUF✗ToolingExtension
                        Custom✗OAS2,OAS3
                        - + \ No newline at end of file diff --git a/docs/generators/elixir/index.html b/docs/generators/elixir/index.html index b199f9485a7..70c4d656407 100644 --- a/docs/generators/elixir/index.html +++ b/docs/generators/elixir/index.html @@ -15,13 +15,13 @@ - +

                        Documentation for the elixir Generator

                        METADATA​

                        PropertyValueNotes
                        generator nameelixirpass this to the generate command after -g
                        generator stabilitySTABLE
                        generator typeCLIENT
                        generator languageElixir
                        generator default templating enginemustache
                        helpTxtGenerates an elixir client library (alpha).

                        CONFIG OPTIONS​

                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                        OptionDescriptionValuesDefault
                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                        false
                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                        true
                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                        		true
                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                        false
                        No changes to the enum's are made, this is the default option.
                        true
                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                        		false
                        invokerPackageThe main namespace to use for all classes. e.g. Yay.Petsnull
                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                        true
                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                        false
                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                        		true
                        licenseHeaderThe license header to prepend to the top of all source files.null
                        packageNameElixir package name (convention: lowercase).null
                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                        IMPORT MAPPING​

                        Type/AliasImports

                        INSTANTIATION TYPES​

                        Type/AliasInstantiated By

                        LANGUAGE PRIMITIVES​

                        • AnyType
                        • Atom
                        • Boolean
                        • Decimal
                        • Float
                        • Integer
                        • List
                        • Map
                        • PID
                        • String
                        • Tuple
                        • any()
                        • map()

                        RESERVED WORDS​

                        • __CALLER__
                        • __DIR__
                        • __ENV__
                        • __FILE__
                        • __MODULE__
                        • __struct__
                        • after
                        • and
                        • catch
                        • do
                        • else
                        • end
                        • false
                        • fn
                        • in
                        • nil
                        • not
                        • or
                        • rescue
                        • true
                        • when

                        FEATURE SET​

                        Client Modification Feature​

                        NameSupportedDefined By
                        BasePath✓ToolingExtension
                        Authorizations✗ToolingExtension
                        UserAgent✗ToolingExtension
                        MockServer✗ToolingExtension

                        Data Type Feature​

                        NameSupportedDefined By
                        Custom✗OAS2,OAS3
                        Int32✓OAS2,OAS3
                        Int64✓OAS2,OAS3
                        Float✓OAS2,OAS3
                        Double✓OAS2,OAS3
                        Decimal✓ToolingExtension
                        String✓OAS2,OAS3
                        Byte✓OAS2,OAS3
                        Binary✓OAS2,OAS3
                        Boolean✓OAS2,OAS3
                        Date✓OAS2,OAS3
                        DateTime✓OAS2,OAS3
                        Password✓OAS2,OAS3
                        File✓OAS2
                        Uuid✗
                        Array✓OAS2,OAS3
                        Null✗OAS3
                        AnyType✓OAS2,OAS3
                        Object✓OAS2,OAS3
                        Maps✓ToolingExtension
                        CollectionFormat✓OAS2
                        CollectionFormatMulti✓OAS2
                        Enum✓OAS2,OAS3
                        ArrayOfEnum✓ToolingExtension
                        ArrayOfModel✓ToolingExtension
                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                        ArrayOfCollectionOfModel✓ToolingExtension
                        ArrayOfCollectionOfEnum✓ToolingExtension
                        MapOfEnum✓ToolingExtension
                        MapOfModel✓ToolingExtension
                        MapOfCollectionOfPrimitives✓ToolingExtension
                        MapOfCollectionOfModel✓ToolingExtension
                        MapOfCollectionOfEnum✓ToolingExtension

                        Documentation Feature​

                        NameSupportedDefined By
                        Readme✓ToolingExtension
                        Model✓ToolingExtension
                        Api✓ToolingExtension

                        Global Feature​

                        NameSupportedDefined By
                        Host✓OAS2,OAS3
                        BasePath✓OAS2,OAS3
                        Info✓OAS2,OAS3
                        Schemes✗OAS2,OAS3
                        PartialSchemes✓OAS2,OAS3
                        Consumes✓OAS2
                        Produces✓OAS2
                        ExternalDocumentation✓OAS2,OAS3
                        Examples✓OAS2,OAS3
                        XMLStructureDefinitions✗OAS2,OAS3
                        MultiServer✗OAS3
                        ParameterizedServer✗OAS3
                        ParameterStyling✗OAS3
                        Callbacks✗OAS3
                        LinkObjects✗OAS3

                        Parameter Feature​

                        NameSupportedDefined By
                        Path✓OAS2,OAS3
                        Query✓OAS2,OAS3
                        Header✓OAS2,OAS3
                        Body✓OAS2
                        FormUnencoded✓OAS2
                        FormMultipart✓OAS2
                        Cookie✗OAS3

                        Schema Support Feature​

                        NameSupportedDefined By
                        Simple✓OAS2,OAS3
                        Composite✓OAS2,OAS3
                        Polymorphism✗OAS2,OAS3
                        Union✗OAS3
                        allOf✗OAS2,OAS3
                        anyOf✗OAS3
                        oneOf✗OAS3
                        not✗OAS3

                        Security Feature​

                        NameSupportedDefined By
                        BasicAuth✓OAS2,OAS3
                        ApiKey✗OAS2,OAS3
                        OpenIDConnect✗OAS3
                        BearerToken✗OAS3
                        OAuth2_Implicit✓OAS2,OAS3
                        OAuth2_Password✗OAS2,OAS3
                        OAuth2_ClientCredentials✗OAS2,OAS3
                        OAuth2_AuthorizationCode✗OAS2,OAS3
                        SignatureAuth✗OAS3
                        AWSV4Signature✗ToolingExtension

                        Wire Format Feature​

                        NameSupportedDefined By
                        JSON✓OAS2,OAS3
                        XML✓OAS2,OAS3
                        PROTOBUF✗ToolingExtension
                        Custom✗OAS2,OAS3
                        - + \ No newline at end of file diff --git a/docs/generators/elm/index.html b/docs/generators/elm/index.html index 9b145ca4c8c..85bd2161881 100644 --- a/docs/generators/elm/index.html +++ b/docs/generators/elm/index.html @@ -15,13 +15,13 @@ - +

                        Documentation for the elm Generator

                        METADATA​

                        PropertyValueNotes
                        generator nameelmpass this to the generate command after -g
                        generator stabilitySTABLE
                        generator typeCLIENT
                        generator languageElm
                        generator default templating enginemustache
                        helpTxtGenerates an Elm client library.

                        CONFIG OPTIONS​

                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                        OptionDescriptionValuesDefault

                        IMPORT MAPPING​

                        Type/AliasImports

                        INSTANTIATION TYPES​

                        Type/AliasInstantiated By
                        arrayList
                        mapDict

                        LANGUAGE PRIMITIVES​

                        • Bool
                        • Dict
                        • Float
                        • Int
                        • List
                        • String

                        RESERVED WORDS​

                        • as
                        • case
                        • else
                        • exposing
                        • if
                        • import
                        • in
                        • let
                        • module
                        • of
                        • port
                        • then
                        • type
                        • where

                        FEATURE SET​

                        Client Modification Feature​

                        NameSupportedDefined By
                        BasePath✓ToolingExtension
                        Authorizations✗ToolingExtension
                        UserAgent✗ToolingExtension
                        MockServer✗ToolingExtension

                        Data Type Feature​

                        NameSupportedDefined By
                        Custom✗OAS2,OAS3
                        Int32✓OAS2,OAS3
                        Int64✓OAS2,OAS3
                        Float✓OAS2,OAS3
                        Double✓OAS2,OAS3
                        Decimal✓ToolingExtension
                        String✓OAS2,OAS3
                        Byte✓OAS2,OAS3
                        Binary✓OAS2,OAS3
                        Boolean✓OAS2,OAS3
                        Date✓OAS2,OAS3
                        DateTime✓OAS2,OAS3
                        Password✓OAS2,OAS3
                        File✓OAS2
                        Uuid✗
                        Array✓OAS2,OAS3
                        Null✗OAS3
                        AnyType✗OAS2,OAS3
                        Object✓OAS2,OAS3
                        Maps✓ToolingExtension
                        CollectionFormat✓OAS2
                        CollectionFormatMulti✓OAS2
                        Enum✓OAS2,OAS3
                        ArrayOfEnum✓ToolingExtension
                        ArrayOfModel✓ToolingExtension
                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                        ArrayOfCollectionOfModel✓ToolingExtension
                        ArrayOfCollectionOfEnum✓ToolingExtension
                        MapOfEnum✓ToolingExtension
                        MapOfModel✓ToolingExtension
                        MapOfCollectionOfPrimitives✓ToolingExtension
                        MapOfCollectionOfModel✓ToolingExtension
                        MapOfCollectionOfEnum✓ToolingExtension

                        Documentation Feature​

                        NameSupportedDefined By
                        Readme✓ToolingExtension
                        Model✓ToolingExtension
                        Api✓ToolingExtension

                        Global Feature​

                        NameSupportedDefined By
                        Host✓OAS2,OAS3
                        BasePath✓OAS2,OAS3
                        Info✓OAS2,OAS3
                        Schemes✗OAS2,OAS3
                        PartialSchemes✓OAS2,OAS3
                        Consumes✓OAS2
                        Produces✓OAS2
                        ExternalDocumentation✓OAS2,OAS3
                        Examples✓OAS2,OAS3
                        XMLStructureDefinitions✗OAS2,OAS3
                        MultiServer✗OAS3
                        ParameterizedServer✗OAS3
                        ParameterStyling✗OAS3
                        Callbacks✗OAS3
                        LinkObjects✗OAS3

                        Parameter Feature​

                        NameSupportedDefined By
                        Path✓OAS2,OAS3
                        Query✓OAS2,OAS3
                        Header✓OAS2,OAS3
                        Body✓OAS2
                        FormUnencoded✓OAS2
                        FormMultipart✓OAS2
                        Cookie✗OAS3

                        Schema Support Feature​

                        NameSupportedDefined By
                        Simple✓OAS2,OAS3
                        Composite✓OAS2,OAS3
                        Polymorphism✗OAS2,OAS3
                        Union✗OAS3
                        allOf✗OAS2,OAS3
                        anyOf✗OAS3
                        oneOf✗OAS3
                        not✗OAS3

                        Security Feature​

                        NameSupportedDefined By
                        BasicAuth✗OAS2,OAS3
                        ApiKey✗OAS2,OAS3
                        OpenIDConnect✗OAS3
                        BearerToken✓OAS3
                        OAuth2_Implicit✗OAS2,OAS3
                        OAuth2_Password✗OAS2,OAS3
                        OAuth2_ClientCredentials✗OAS2,OAS3
                        OAuth2_AuthorizationCode✗OAS2,OAS3
                        SignatureAuth✗OAS3
                        AWSV4Signature✗ToolingExtension

                        Wire Format Feature​

                        NameSupportedDefined By
                        JSON✓OAS2,OAS3
                        XML✗OAS2,OAS3
                        PROTOBUF✗ToolingExtension
                        Custom✗OAS2,OAS3
                        - + \ No newline at end of file diff --git a/docs/generators/erlang-client/index.html b/docs/generators/erlang-client/index.html index a1c75f54a0f..f1f99871d85 100644 --- a/docs/generators/erlang-client/index.html +++ b/docs/generators/erlang-client/index.html @@ -15,13 +15,13 @@ - +

                        Documentation for the erlang-client Generator

                        METADATA​

                        PropertyValueNotes
                        generator nameerlang-clientpass this to the generate command after -g
                        generator stabilitySTABLE
                        generator typeCLIENT
                        generator languageErlang
                        generator default templating enginemustache
                        helpTxtGenerates an Erlang client library (beta).

                        CONFIG OPTIONS​

                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                        OptionDescriptionValuesDefault
                        packageNameErlang application name (convention: lowercase).openapi
                        packageVersionErlang application version1.0.0

                        IMPORT MAPPING​

                        Type/AliasImports

                        INSTANTIATION TYPES​

                        Type/AliasInstantiated By

                        LANGUAGE PRIMITIVES​

                          RESERVED WORDS​

                          • after
                          • and
                          • andalso
                          • band
                          • begin
                          • bnot
                          • bor
                          • bsl
                          • bsr
                          • bxor
                          • case
                          • catch
                          • cond
                          • div
                          • end
                          • fun
                          • if
                          • let
                          • not
                          • of
                          • or
                          • orelse
                          • receive
                          • rem
                          • try
                          • when
                          • xor

                          FEATURE SET​

                          Client Modification Feature​

                          NameSupportedDefined By
                          BasePath✓ToolingExtension
                          Authorizations✗ToolingExtension
                          UserAgent✗ToolingExtension
                          MockServer✗ToolingExtension

                          Data Type Feature​

                          NameSupportedDefined By
                          Custom✗OAS2,OAS3
                          Int32✓OAS2,OAS3
                          Int64✓OAS2,OAS3
                          Float✓OAS2,OAS3
                          Double✓OAS2,OAS3
                          Decimal✓ToolingExtension
                          String✓OAS2,OAS3
                          Byte✓OAS2,OAS3
                          Binary✓OAS2,OAS3
                          Boolean✓OAS2,OAS3
                          Date✓OAS2,OAS3
                          DateTime✓OAS2,OAS3
                          Password✓OAS2,OAS3
                          File✓OAS2
                          Uuid✗
                          Array✓OAS2,OAS3
                          Null✗OAS3
                          AnyType✗OAS2,OAS3
                          Object✓OAS2,OAS3
                          Maps✓ToolingExtension
                          CollectionFormat✓OAS2
                          CollectionFormatMulti✓OAS2
                          Enum✓OAS2,OAS3
                          ArrayOfEnum✓ToolingExtension
                          ArrayOfModel✓ToolingExtension
                          ArrayOfCollectionOfPrimitives✓ToolingExtension
                          ArrayOfCollectionOfModel✓ToolingExtension
                          ArrayOfCollectionOfEnum✓ToolingExtension
                          MapOfEnum✓ToolingExtension
                          MapOfModel✓ToolingExtension
                          MapOfCollectionOfPrimitives✓ToolingExtension
                          MapOfCollectionOfModel✓ToolingExtension
                          MapOfCollectionOfEnum✓ToolingExtension

                          Documentation Feature​

                          NameSupportedDefined By
                          Readme✓ToolingExtension
                          Model✓ToolingExtension
                          Api✓ToolingExtension

                          Global Feature​

                          NameSupportedDefined By
                          Host✓OAS2,OAS3
                          BasePath✓OAS2,OAS3
                          Info✓OAS2,OAS3
                          Schemes✗OAS2,OAS3
                          PartialSchemes✓OAS2,OAS3
                          Consumes✓OAS2
                          Produces✓OAS2
                          ExternalDocumentation✓OAS2,OAS3
                          Examples✓OAS2,OAS3
                          XMLStructureDefinitions✗OAS2,OAS3
                          MultiServer✗OAS3
                          ParameterizedServer✗OAS3
                          ParameterStyling✗OAS3
                          Callbacks✗OAS3
                          LinkObjects✗OAS3

                          Parameter Feature​

                          NameSupportedDefined By
                          Path✓OAS2,OAS3
                          Query✓OAS2,OAS3
                          Header✓OAS2,OAS3
                          Body✓OAS2
                          FormUnencoded✓OAS2
                          FormMultipart✓OAS2
                          Cookie✗OAS3

                          Schema Support Feature​

                          NameSupportedDefined By
                          Simple✓OAS2,OAS3
                          Composite✓OAS2,OAS3
                          Polymorphism✗OAS2,OAS3
                          Union✗OAS3
                          allOf✗OAS2,OAS3
                          anyOf✗OAS3
                          oneOf✗OAS3
                          not✗OAS3

                          Security Feature​

                          NameSupportedDefined By
                          BasicAuth✗OAS2,OAS3
                          ApiKey✓OAS2,OAS3
                          OpenIDConnect✗OAS3
                          BearerToken✗OAS3
                          OAuth2_Implicit✗OAS2,OAS3
                          OAuth2_Password✗OAS2,OAS3
                          OAuth2_ClientCredentials✗OAS2,OAS3
                          OAuth2_AuthorizationCode✗OAS2,OAS3
                          SignatureAuth✗OAS3
                          AWSV4Signature✗ToolingExtension

                          Wire Format Feature​

                          NameSupportedDefined By
                          JSON✓OAS2,OAS3
                          XML✗OAS2,OAS3
                          PROTOBUF✗ToolingExtension
                          Custom✗OAS2,OAS3
                          - + \ No newline at end of file diff --git a/docs/generators/erlang-proper/index.html b/docs/generators/erlang-proper/index.html index e5b320e985c..e24b497bbaa 100644 --- a/docs/generators/erlang-proper/index.html +++ b/docs/generators/erlang-proper/index.html @@ -15,13 +15,13 @@ - +

                          Documentation for the erlang-proper Generator

                          METADATA​

                          PropertyValueNotes
                          generator nameerlang-properpass this to the generate command after -g
                          generator stabilitySTABLE
                          generator typeCLIENT
                          generator languageErlang
                          generator default templating enginemustache
                          helpTxtGenerates an Erlang library with PropEr generators (beta).

                          CONFIG OPTIONS​

                          These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                          OptionDescriptionValuesDefault
                          packageNameErlang application name (convention: lowercase).openapi
                          packageVersionErlang application version1.0.0

                          IMPORT MAPPING​

                          Type/AliasImports

                          INSTANTIATION TYPES​

                          Type/AliasInstantiated By

                          LANGUAGE PRIMITIVES​

                            RESERVED WORDS​

                            • after
                            • and
                            • andalso
                            • band
                            • begin
                            • bnot
                            • bor
                            • bsl
                            • bsr
                            • bxor
                            • case
                            • catch
                            • cond
                            • div
                            • end
                            • fun
                            • if
                            • let
                            • not
                            • of
                            • or
                            • orelse
                            • receive
                            • rem
                            • try
                            • when
                            • xor

                            FEATURE SET​

                            Client Modification Feature​

                            NameSupportedDefined By
                            BasePath✓ToolingExtension
                            Authorizations✗ToolingExtension
                            UserAgent✗ToolingExtension
                            MockServer✗ToolingExtension

                            Data Type Feature​

                            NameSupportedDefined By
                            Custom✗OAS2,OAS3
                            Int32✓OAS2,OAS3
                            Int64✓OAS2,OAS3
                            Float✓OAS2,OAS3
                            Double✓OAS2,OAS3
                            Decimal✓ToolingExtension
                            String✓OAS2,OAS3
                            Byte✓OAS2,OAS3
                            Binary✓OAS2,OAS3
                            Boolean✓OAS2,OAS3
                            Date✓OAS2,OAS3
                            DateTime✓OAS2,OAS3
                            Password✓OAS2,OAS3
                            File✓OAS2
                            Uuid✗
                            Array✓OAS2,OAS3
                            Null✗OAS3
                            AnyType✗OAS2,OAS3
                            Object✓OAS2,OAS3
                            Maps✓ToolingExtension
                            CollectionFormat✓OAS2
                            CollectionFormatMulti✓OAS2
                            Enum✓OAS2,OAS3
                            ArrayOfEnum✓ToolingExtension
                            ArrayOfModel✓ToolingExtension
                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                            ArrayOfCollectionOfModel✓ToolingExtension
                            ArrayOfCollectionOfEnum✓ToolingExtension
                            MapOfEnum✓ToolingExtension
                            MapOfModel✓ToolingExtension
                            MapOfCollectionOfPrimitives✓ToolingExtension
                            MapOfCollectionOfModel✓ToolingExtension
                            MapOfCollectionOfEnum✓ToolingExtension

                            Documentation Feature​

                            NameSupportedDefined By
                            Readme✓ToolingExtension
                            Model✓ToolingExtension
                            Api✓ToolingExtension

                            Global Feature​

                            NameSupportedDefined By
                            Host✓OAS2,OAS3
                            BasePath✓OAS2,OAS3
                            Info✓OAS2,OAS3
                            Schemes✗OAS2,OAS3
                            PartialSchemes✓OAS2,OAS3
                            Consumes✓OAS2
                            Produces✓OAS2
                            ExternalDocumentation✓OAS2,OAS3
                            Examples✓OAS2,OAS3
                            XMLStructureDefinitions✗OAS2,OAS3
                            MultiServer✗OAS3
                            ParameterizedServer✗OAS3
                            ParameterStyling✗OAS3
                            Callbacks✗OAS3
                            LinkObjects✗OAS3

                            Parameter Feature​

                            NameSupportedDefined By
                            Path✓OAS2,OAS3
                            Query✓OAS2,OAS3
                            Header✓OAS2,OAS3
                            Body✓OAS2
                            FormUnencoded✓OAS2
                            FormMultipart✓OAS2
                            Cookie✗OAS3

                            Schema Support Feature​

                            NameSupportedDefined By
                            Simple✓OAS2,OAS3
                            Composite✓OAS2,OAS3
                            Polymorphism✗OAS2,OAS3
                            Union✗OAS3
                            allOf✗OAS2,OAS3
                            anyOf✗OAS3
                            oneOf✗OAS3
                            not✗OAS3

                            Security Feature​

                            NameSupportedDefined By
                            BasicAuth✓OAS2,OAS3
                            ApiKey✓OAS2,OAS3
                            OpenIDConnect✗OAS3
                            BearerToken✗OAS3
                            OAuth2_Implicit✗OAS2,OAS3
                            OAuth2_Password✗OAS2,OAS3
                            OAuth2_ClientCredentials✗OAS2,OAS3
                            OAuth2_AuthorizationCode✗OAS2,OAS3
                            SignatureAuth✗OAS3
                            AWSV4Signature✗ToolingExtension

                            Wire Format Feature​

                            NameSupportedDefined By
                            JSON✓OAS2,OAS3
                            XML✗OAS2,OAS3
                            PROTOBUF✗ToolingExtension
                            Custom✗OAS2,OAS3
                            - + \ No newline at end of file diff --git a/docs/generators/erlang-server-deprecated/index.html b/docs/generators/erlang-server-deprecated/index.html index e4779dc1903..0dbb0cb963e 100644 --- a/docs/generators/erlang-server-deprecated/index.html +++ b/docs/generators/erlang-server-deprecated/index.html @@ -15,13 +15,13 @@ - +

                            Documentation for the erlang-server-deprecated Generator

                            METADATA​

                            PropertyValueNotes
                            generator nameerlang-server-deprecatedpass this to the generate command after -g
                            generator stabilityDEPRECATED
                            generator typeSERVER
                            generator languageErlang
                            generator default templating enginemustache
                            helpTxtGenerates an Erlang server library (deprecated) using OpenAPI Generator (https://openapi-generator.tech). By default, it will also generate service classes, which can be disabled with the -Dnoservice environment variable.

                            CONFIG OPTIONS​

                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                            OptionDescriptionValuesDefault
                            openAPISpecNameOpenapi Spec Name.openapi
                            packageNameErlang package name (convention: lowercase).openapi

                            IMPORT MAPPING​

                            Type/AliasImports

                            INSTANTIATION TYPES​

                            Type/AliasInstantiated By

                            LANGUAGE PRIMITIVES​

                              RESERVED WORDS​

                              • after
                              • and
                              • andalso
                              • band
                              • begin
                              • bnot
                              • bor
                              • bsl
                              • bsr
                              • bxor
                              • case
                              • catch
                              • cond
                              • div
                              • end
                              • fun
                              • if
                              • let
                              • not
                              • of
                              • or
                              • orelse
                              • receive
                              • rem
                              • try
                              • when
                              • xor

                              FEATURE SET​

                              Client Modification Feature​

                              NameSupportedDefined By
                              BasePath✗ToolingExtension
                              Authorizations✗ToolingExtension
                              UserAgent✗ToolingExtension
                              MockServer✗ToolingExtension

                              Data Type Feature​

                              NameSupportedDefined By
                              Custom✗OAS2,OAS3
                              Int32✓OAS2,OAS3
                              Int64✓OAS2,OAS3
                              Float✓OAS2,OAS3
                              Double✓OAS2,OAS3
                              Decimal✓ToolingExtension
                              String✓OAS2,OAS3
                              Byte✓OAS2,OAS3
                              Binary✓OAS2,OAS3
                              Boolean✓OAS2,OAS3
                              Date✓OAS2,OAS3
                              DateTime✓OAS2,OAS3
                              Password✓OAS2,OAS3
                              File✓OAS2
                              Uuid✗
                              Array✓OAS2,OAS3
                              Null✗OAS3
                              AnyType✗OAS2,OAS3
                              Object✓OAS2,OAS3
                              Maps✓ToolingExtension
                              CollectionFormat✓OAS2
                              CollectionFormatMulti✓OAS2
                              Enum✓OAS2,OAS3
                              ArrayOfEnum✓ToolingExtension
                              ArrayOfModel✓ToolingExtension
                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                              ArrayOfCollectionOfModel✓ToolingExtension
                              ArrayOfCollectionOfEnum✓ToolingExtension
                              MapOfEnum✓ToolingExtension
                              MapOfModel✓ToolingExtension
                              MapOfCollectionOfPrimitives✓ToolingExtension
                              MapOfCollectionOfModel✓ToolingExtension
                              MapOfCollectionOfEnum✓ToolingExtension

                              Documentation Feature​

                              NameSupportedDefined By
                              Readme✓ToolingExtension
                              Model✓ToolingExtension
                              Api✓ToolingExtension

                              Global Feature​

                              NameSupportedDefined By
                              Host✓OAS2,OAS3
                              BasePath✓OAS2,OAS3
                              Info✓OAS2,OAS3
                              Schemes✗OAS2,OAS3
                              PartialSchemes✓OAS2,OAS3
                              Consumes✓OAS2
                              Produces✓OAS2
                              ExternalDocumentation✓OAS2,OAS3
                              Examples✓OAS2,OAS3
                              XMLStructureDefinitions✗OAS2,OAS3
                              MultiServer✗OAS3
                              ParameterizedServer✗OAS3
                              ParameterStyling✗OAS3
                              Callbacks✗OAS3
                              LinkObjects✗OAS3

                              Parameter Feature​

                              NameSupportedDefined By
                              Path✓OAS2,OAS3
                              Query✓OAS2,OAS3
                              Header✓OAS2,OAS3
                              Body✓OAS2
                              FormUnencoded✓OAS2
                              FormMultipart✓OAS2
                              Cookie✗OAS3

                              Schema Support Feature​

                              NameSupportedDefined By
                              Simple✓OAS2,OAS3
                              Composite✓OAS2,OAS3
                              Polymorphism✗OAS2,OAS3
                              Union✗OAS3
                              allOf✗OAS2,OAS3
                              anyOf✗OAS3
                              oneOf✗OAS3
                              not✗OAS3

                              Security Feature​

                              NameSupportedDefined By
                              BasicAuth✗OAS2,OAS3
                              ApiKey✓OAS2,OAS3
                              OpenIDConnect✗OAS3
                              BearerToken✗OAS3
                              OAuth2_Implicit✓OAS2,OAS3
                              OAuth2_Password✗OAS2,OAS3
                              OAuth2_ClientCredentials✗OAS2,OAS3
                              OAuth2_AuthorizationCode✗OAS2,OAS3
                              SignatureAuth✗OAS3
                              AWSV4Signature✗ToolingExtension

                              Wire Format Feature​

                              NameSupportedDefined By
                              JSON✓OAS2,OAS3
                              XML✗OAS2,OAS3
                              PROTOBUF✗ToolingExtension
                              Custom✗OAS2,OAS3
                              - + \ No newline at end of file diff --git a/docs/generators/erlang-server/index.html b/docs/generators/erlang-server/index.html index 6605a622c63..49a01acbdfe 100644 --- a/docs/generators/erlang-server/index.html +++ b/docs/generators/erlang-server/index.html @@ -15,13 +15,13 @@ - +

                              Documentation for the erlang-server Generator

                              METADATA​

                              PropertyValueNotes
                              generator nameerlang-serverpass this to the generate command after -g
                              generator stabilitySTABLE
                              generator typeSERVER
                              generator languageErlang
                              generator default templating enginemustache
                              helpTxtGenerates an Erlang server library (beta) using OpenAPI Generator (https://openapi-generator.tech). By default, it will also generate service classes, which can be disabled with the -Dnoservice environment variable.

                              CONFIG OPTIONS​

                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                              OptionDescriptionValuesDefault
                              openAPISpecNameOpenapi Spec Name.openapi
                              packageNameErlang package name (convention: lowercase).openapi

                              IMPORT MAPPING​

                              Type/AliasImports

                              INSTANTIATION TYPES​

                              Type/AliasInstantiated By

                              LANGUAGE PRIMITIVES​

                                RESERVED WORDS​

                                • after
                                • and
                                • andalso
                                • band
                                • begin
                                • bnot
                                • bor
                                • bsl
                                • bsr
                                • bxor
                                • case
                                • catch
                                • cond
                                • div
                                • end
                                • fun
                                • if
                                • let
                                • maybe
                                • not
                                • of
                                • or
                                • orelse
                                • receive
                                • rem
                                • try
                                • when
                                • xor

                                FEATURE SET​

                                Client Modification Feature​

                                NameSupportedDefined By
                                BasePath✗ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✗ToolingExtension
                                MockServer✗ToolingExtension

                                Data Type Feature​

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Uuid✗
                                Array✓OAS2,OAS3
                                Null✗OAS3
                                AnyType✗OAS2,OAS3
                                Object✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature​

                                NameSupportedDefined By
                                Readme✓ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature​

                                NameSupportedDefined By
                                Host✓OAS2,OAS3
                                BasePath✓OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✗OAS3
                                ParameterStyling✗OAS3
                                Callbacks✗OAS3
                                LinkObjects✗OAS3

                                Parameter Feature​

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✗OAS3

                                Schema Support Feature​

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✗OAS2,OAS3
                                Union✗OAS3
                                allOf✗OAS2,OAS3
                                anyOf✗OAS3
                                oneOf✗OAS3
                                not✗OAS3

                                Security Feature​

                                NameSupportedDefined By
                                BasicAuth✗OAS2,OAS3
                                ApiKey✓OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✗OAS3
                                OAuth2_Implicit✓OAS2,OAS3
                                OAuth2_Password✗OAS2,OAS3
                                OAuth2_ClientCredentials✗OAS2,OAS3
                                OAuth2_AuthorizationCode✗OAS2,OAS3
                                SignatureAuth✗OAS3
                                AWSV4Signature✗ToolingExtension

                                Wire Format Feature​

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✗OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                - + \ No newline at end of file diff --git a/docs/generators/fsharp-functions/index.html b/docs/generators/fsharp-functions/index.html index 83e3c90e9ef..49fd4d3d341 100644 --- a/docs/generators/fsharp-functions/index.html +++ b/docs/generators/fsharp-functions/index.html @@ -15,13 +15,13 @@ - +

                                Documentation for the fsharp-functions Generator

                                METADATA​

                                PropertyValueNotes
                                generator namefsharp-functionspass this to the generate command after -g
                                generator stabilityBETA
                                generator typeSERVER
                                generator languageF#
                                generator default templating enginemustache
                                helpTxtGenerates a fsharp-functions server (beta).

                                CONFIG OPTIONS​

                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                OptionDescriptionValuesDefault
                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                false
                                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                true
                                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                		true
                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                false
                                No changes to the enum's are made, this is the default option.
                                true
                                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                		false
                                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                true
                                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                false
                                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                		true
                                licenseNameThe name of the licenseNoLicense
                                licenseUrlThe URL of the licensehttp://localhost
                                packageAuthorsSpecifies Authors property in the .NET Core project file.OpenAPI
                                packageCopyrightSpecifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.No Copyright
                                packageGuidThe GUID that will be associated with the C# projectnull
                                packageNameF# module name (convention: Title.Case).OpenAPI
                                packageTitleSpecifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.OpenAPI Library
                                packageVersionF# package version.1.0.0
                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                sourceFoldersource folder for generated codeOpenAPI/src

                                IMPORT MAPPING​

                                Type/AliasImports
                                IDictionarySystem.Collections.Generic

                                INSTANTIATION TYPES​

                                Type/AliasInstantiated By
                                arraylist
                                listlist
                                mapIDictionary

                                LANGUAGE PRIMITIVES​

                                • Collection
                                • DataTimeOffset
                                • DateTime
                                • Dictionary
                                • Double
                                • ICollection
                                • Int32
                                • Int64
                                • List
                                • String
                                • System.IO.Stream
                                • bool
                                • byte[]
                                • char
                                • decimal
                                • dict
                                • double
                                • float
                                • float32
                                • int
                                • int16
                                • int64
                                • list
                                • nativeint
                                • obj
                                • seq
                                • single
                                • string
                                • uint16
                                • uint32
                                • uint64
                                • unativeint

                                RESERVED WORDS​

                                • abstract
                                • and
                                • as
                                • assert
                                • async
                                • await
                                • base
                                • begin
                                • bool
                                • break
                                • byte
                                • case
                                • catch
                                • char
                                • checked
                                • class
                                • const
                                • continue
                                • decimal
                                • default
                                • delegate
                                • do
                                • done
                                • double
                                • downcast
                                • downto
                                • dynamic
                                • elif
                                • else
                                • end
                                • enum
                                • event
                                • exception
                                • explicit
                                • extern
                                • false
                                • finally
                                • fixed
                                • float
                                • for
                                • foreach
                                • fun
                                • function
                                • if
                                • in
                                • inherit
                                • inline
                                • int
                                • interface
                                • internal
                                • is
                                • lazy
                                • let
                                • let!
                                • localVarFileParams
                                • localVarFormParams
                                • localVarHeaderParams
                                • localVarHttpContentType
                                • localVarHttpContentTypes
                                • localVarHttpHeaderAccept
                                • localVarHttpHeaderAccepts
                                • localVarPath
                                • localVarPathParams
                                • localVarPostBody
                                • localVarQueryParams
                                • localVarResponse
                                • localVarStatusCode
                                • lock
                                • match
                                • match!
                                • member
                                • module
                                • mutable
                                • namespace
                                • new
                                • not
                                • null
                                • of
                                • open
                                • option
                                • or
                                • override
                                • params
                                • private
                                • public
                                • raise
                                • rec
                                • return
                                • return!
                                • sealed
                                • select
                                • static
                                • string
                                • struct
                                • then
                                • to
                                • true
                                • try
                                • type
                                • upcast
                                • use
                                • use!
                                • val
                                • void
                                • volatile
                                • when
                                • while
                                • with
                                • yield
                                • yield!

                                FEATURE SET​

                                Client Modification Feature​

                                NameSupportedDefined By
                                BasePath✗ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✗ToolingExtension
                                MockServer✗ToolingExtension

                                Data Type Feature​

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Uuid✗
                                Array✓OAS2,OAS3
                                Null✗OAS3
                                AnyType✗OAS2,OAS3
                                Object✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature​

                                NameSupportedDefined By
                                Readme✗ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature​

                                NameSupportedDefined By
                                Host✗OAS2,OAS3
                                BasePath✗OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✗OAS3
                                ParameterStyling✗OAS3
                                Callbacks✗OAS3
                                LinkObjects✗OAS3

                                Parameter Feature​

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✓OAS3

                                Schema Support Feature​

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✗OAS2,OAS3
                                Union✗OAS3
                                allOf✗OAS2,OAS3
                                anyOf✗OAS3
                                oneOf✗OAS3
                                not✗OAS3

                                Security Feature​

                                NameSupportedDefined By
                                BasicAuth✗OAS2,OAS3
                                ApiKey✗OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✗OAS3
                                OAuth2_Implicit✗OAS2,OAS3
                                OAuth2_Password✗OAS2,OAS3
                                OAuth2_ClientCredentials✗OAS2,OAS3
                                OAuth2_AuthorizationCode✗OAS2,OAS3
                                SignatureAuth✗OAS3
                                AWSV4Signature✗ToolingExtension

                                Wire Format Feature​

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✗OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                - + \ No newline at end of file diff --git a/docs/generators/fsharp-giraffe-server/index.html b/docs/generators/fsharp-giraffe-server/index.html index 6a22258a57c..114d2e1a201 100644 --- a/docs/generators/fsharp-giraffe-server/index.html +++ b/docs/generators/fsharp-giraffe-server/index.html @@ -15,13 +15,13 @@ - +

                                Documentation for the fsharp-giraffe-server Generator

                                METADATA​

                                PropertyValueNotes
                                generator namefsharp-giraffe-serverpass this to the generate command after -g
                                generator stabilityBETA
                                generator typeSERVER
                                generator languageF#
                                generator default templating enginemustache
                                helpTxtGenerates a F# Giraffe server (beta).

                                CONFIG OPTIONS​

                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                OptionDescriptionValuesDefault
                                buildTargetTarget the build for a program or library.program
                                generateBodyGenerates method body.true
                                licenseNameThe name of the licenseNoLicense
                                licenseUrlThe URL of the licensehttp://localhost
                                packageAuthorsSpecifies Authors property in the .NET Core project file.OpenAPI
                                packageCopyrightSpecifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.No Copyright
                                packageGuidThe GUID that will be associated with the C# projectnull
                                packageNameF# module name (convention: Title.Case).OpenAPI
                                packageTitleSpecifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.OpenAPI Library
                                packageVersionF# package version.1.0.0
                                returnICollectionReturn ICollection<T> instead of the concrete type.false
                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                sourceFoldersource folder for generated codeOpenAPI/src
                                useCollectionDeserialize array types to Collection<T> instead of List<T>.false
                                useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
                                useSwashbuckleUses the Swashbuckle.AspNetCore NuGet package for documentation.false

                                IMPORT MAPPING​

                                Type/AliasImports
                                IDictionarySystem.Collections.Generic

                                INSTANTIATION TYPES​

                                Type/AliasInstantiated By
                                arraylist
                                listlist
                                mapIDictionary

                                LANGUAGE PRIMITIVES​

                                • Collection
                                • DataTimeOffset
                                • DateTime
                                • Dictionary
                                • Double
                                • ICollection
                                • Int32
                                • Int64
                                • List
                                • String
                                • System.IO.Stream
                                • bool
                                • byte[]
                                • char
                                • decimal
                                • dict
                                • double
                                • float
                                • float32
                                • int
                                • int16
                                • int64
                                • list
                                • nativeint
                                • obj
                                • seq
                                • single
                                • string
                                • uint16
                                • uint32
                                • uint64
                                • unativeint

                                RESERVED WORDS​

                                • abstract
                                • and
                                • as
                                • assert
                                • async
                                • await
                                • base
                                • begin
                                • bool
                                • break
                                • byte
                                • case
                                • catch
                                • char
                                • checked
                                • class
                                • const
                                • continue
                                • decimal
                                • default
                                • delegate
                                • do
                                • done
                                • double
                                • downcast
                                • downto
                                • dynamic
                                • elif
                                • else
                                • end
                                • enum
                                • event
                                • exception
                                • explicit
                                • extern
                                • false
                                • finally
                                • fixed
                                • float
                                • for
                                • foreach
                                • fun
                                • function
                                • if
                                • in
                                • inherit
                                • inline
                                • int
                                • interface
                                • internal
                                • is
                                • lazy
                                • let
                                • let!
                                • localVarFileParams
                                • localVarFormParams
                                • localVarHeaderParams
                                • localVarHttpContentType
                                • localVarHttpContentTypes
                                • localVarHttpHeaderAccept
                                • localVarHttpHeaderAccepts
                                • localVarPath
                                • localVarPathParams
                                • localVarPostBody
                                • localVarQueryParams
                                • localVarResponse
                                • localVarStatusCode
                                • lock
                                • match
                                • match!
                                • member
                                • module
                                • mutable
                                • namespace
                                • new
                                • not
                                • null
                                • of
                                • open
                                • option
                                • or
                                • override
                                • params
                                • private
                                • public
                                • raise
                                • rec
                                • return
                                • return!
                                • sealed
                                • select
                                • static
                                • string
                                • struct
                                • then
                                • to
                                • true
                                • try
                                • type
                                • upcast
                                • use
                                • use!
                                • val
                                • void
                                • volatile
                                • when
                                • while
                                • with
                                • yield
                                • yield!

                                FEATURE SET​

                                Client Modification Feature​

                                NameSupportedDefined By
                                BasePath✗ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✗ToolingExtension
                                MockServer✗ToolingExtension

                                Data Type Feature​

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Uuid✗
                                Array✓OAS2,OAS3
                                Null✗OAS3
                                AnyType✗OAS2,OAS3
                                Object✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature​

                                NameSupportedDefined By
                                Readme✓ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature​

                                NameSupportedDefined By
                                Host✓OAS2,OAS3
                                BasePath✓OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✗OAS3
                                ParameterStyling✗OAS3
                                Callbacks✓OAS3
                                LinkObjects✗OAS3

                                Parameter Feature​

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✓OAS3

                                Schema Support Feature​

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✓OAS2,OAS3
                                Union✗OAS3
                                allOf✗OAS2,OAS3
                                anyOf✗OAS3
                                oneOf✗OAS3
                                not✗OAS3

                                Security Feature​

                                NameSupportedDefined By
                                BasicAuth✓OAS2,OAS3
                                ApiKey✓OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✓OAS3
                                OAuth2_Implicit✓OAS2,OAS3
                                OAuth2_Password✓OAS2,OAS3
                                OAuth2_ClientCredentials✓OAS2,OAS3
                                OAuth2_AuthorizationCode✓OAS2,OAS3
                                SignatureAuth✗OAS3
                                AWSV4Signature✗ToolingExtension

                                Wire Format Feature​

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✓OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                - + \ No newline at end of file diff --git a/docs/generators/go-echo-server/index.html b/docs/generators/go-echo-server/index.html index 43bf6f0e004..adea69e7e2b 100644 --- a/docs/generators/go-echo-server/index.html +++ b/docs/generators/go-echo-server/index.html @@ -15,13 +15,13 @@ - +

                                Documentation for the go-echo-server Generator

                                METADATA​

                                PropertyValueNotes
                                generator namego-echo-serverpass this to the generate command after -g
                                generator stabilityBETA
                                generator typeSERVER
                                generator languageGo
                                generator default templating enginemustache
                                helpTxtGenerates a go-echo server. (Beta)

                                CONFIG OPTIONS​

                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                OptionDescriptionValuesDefault
                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                packageNameGo package name (convention: lowercase).openapi
                                packageVersionGo package version.1.0.0
                                serverPortThe network port the generated server binds to8080

                                IMPORT MAPPING​

                                Type/AliasImports

                                INSTANTIATION TYPES​

                                Type/AliasInstantiated By

                                LANGUAGE PRIMITIVES​

                                • bool
                                • byte
                                • complex128
                                • complex64
                                • float32
                                • float64
                                • int
                                • int32
                                • int64
                                • interface
                                • map[string]interface
                                • rune
                                • string
                                • uint
                                • uint32
                                • uint64

                                RESERVED WORDS​

                                • bool
                                • break
                                • byte
                                • case
                                • chan
                                • complex128
                                • complex64
                                • const
                                • continue
                                • default
                                • defer
                                • else
                                • error
                                • fallthrough
                                • float32
                                • float64
                                • for
                                • func
                                • go
                                • goto
                                • if
                                • import
                                • int
                                • int16
                                • int32
                                • int64
                                • int8
                                • interface
                                • map
                                • nil
                                • package
                                • range
                                • return
                                • rune
                                • select
                                • string
                                • struct
                                • switch
                                • type
                                • uint
                                • uint16
                                • uint32
                                • uint64
                                • uint8
                                • uintptr
                                • var

                                FEATURE SET​

                                Client Modification Feature​

                                NameSupportedDefined By
                                BasePath✗ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✗ToolingExtension
                                MockServer✗ToolingExtension

                                Data Type Feature​

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Uuid✗
                                Array✓OAS2,OAS3
                                Null✗OAS3
                                AnyType✗OAS2,OAS3
                                Object✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature​

                                NameSupportedDefined By
                                Readme✓ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature​

                                NameSupportedDefined By
                                Host✓OAS2,OAS3
                                BasePath✓OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✗OAS3
                                ParameterStyling✗OAS3
                                Callbacks✗OAS3
                                LinkObjects✗OAS3

                                Parameter Feature​

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✗OAS3

                                Schema Support Feature​

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✗OAS2,OAS3
                                Union✗OAS3
                                allOf✗OAS2,OAS3
                                anyOf✗OAS3
                                oneOf✗OAS3
                                not✗OAS3

                                Security Feature​

                                NameSupportedDefined By
                                BasicAuth✗OAS2,OAS3
                                ApiKey✗OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✗OAS3
                                OAuth2_Implicit✗OAS2,OAS3
                                OAuth2_Password✗OAS2,OAS3
                                OAuth2_ClientCredentials✗OAS2,OAS3
                                OAuth2_AuthorizationCode✗OAS2,OAS3
                                SignatureAuth✗OAS3
                                AWSV4Signature✗ToolingExtension

                                Wire Format Feature​

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✓OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                - + \ No newline at end of file diff --git a/docs/generators/go-gin-server/index.html b/docs/generators/go-gin-server/index.html index 67c5f3abc09..9397f7829d0 100644 --- a/docs/generators/go-gin-server/index.html +++ b/docs/generators/go-gin-server/index.html @@ -15,13 +15,13 @@ - +

                                Documentation for the go-gin-server Generator

                                METADATA​

                                PropertyValueNotes
                                generator namego-gin-serverpass this to the generate command after -g
                                generator stabilitySTABLE
                                generator typeSERVER
                                generator languageGo
                                generator default templating enginemustache
                                helpTxtGenerates a Go server library with the gin framework using OpenAPI-Generator.By default, it will also generate service classes.

                                CONFIG OPTIONS​

                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                OptionDescriptionValuesDefault
                                apiPathName of the folder that contains the Go source codego
                                enumClassPrefixPrefix enum with class namefalse
                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                interfaceOnlyWhether to generate only API interface stubs without the implementation files.false
                                packageNameGo package name (convention: lowercase).openapi
                                packageVersionGo package version.1.0.0
                                serverPortThe network port the generated server binds to8080

                                IMPORT MAPPING​

                                Type/AliasImports

                                INSTANTIATION TYPES​

                                Type/AliasInstantiated By

                                LANGUAGE PRIMITIVES​

                                • bool
                                • byte
                                • complex128
                                • complex64
                                • float32
                                • float64
                                • int
                                • int32
                                • int64
                                • interface
                                • map[string]interface
                                • rune
                                • string
                                • uint
                                • uint32
                                • uint64

                                RESERVED WORDS​

                                • bool
                                • break
                                • byte
                                • case
                                • chan
                                • complex128
                                • complex64
                                • const
                                • continue
                                • default
                                • defer
                                • else
                                • error
                                • fallthrough
                                • float32
                                • float64
                                • for
                                • func
                                • go
                                • goto
                                • if
                                • import
                                • int
                                • int16
                                • int32
                                • int64
                                • int8
                                • interface
                                • map
                                • nil
                                • package
                                • range
                                • return
                                • rune
                                • select
                                • string
                                • struct
                                • switch
                                • type
                                • uint
                                • uint16
                                • uint32
                                • uint64
                                • uint8
                                • uintptr
                                • var

                                FEATURE SET​

                                Client Modification Feature​

                                NameSupportedDefined By
                                BasePath✗ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✗ToolingExtension
                                MockServer✗ToolingExtension

                                Data Type Feature​

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Uuid✗
                                Array✓OAS2,OAS3
                                Null✗OAS3
                                AnyType✗OAS2,OAS3
                                Object✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature​

                                NameSupportedDefined By
                                Readme✓ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature​

                                NameSupportedDefined By
                                Host✓OAS2,OAS3
                                BasePath✓OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✗OAS3
                                ParameterStyling✗OAS3
                                Callbacks✗OAS3
                                LinkObjects✗OAS3

                                Parameter Feature​

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✗OAS3

                                Schema Support Feature​

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✗OAS2,OAS3
                                Union✗OAS3
                                allOf✗OAS2,OAS3
                                anyOf✗OAS3
                                oneOf✗OAS3
                                not✗OAS3

                                Security Feature​

                                NameSupportedDefined By
                                BasicAuth✗OAS2,OAS3
                                ApiKey✗OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✗OAS3
                                OAuth2_Implicit✗OAS2,OAS3
                                OAuth2_Password✗OAS2,OAS3
                                OAuth2_ClientCredentials✗OAS2,OAS3
                                OAuth2_AuthorizationCode✗OAS2,OAS3
                                SignatureAuth✗OAS3
                                AWSV4Signature✗ToolingExtension

                                Wire Format Feature​

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✓OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                - + \ No newline at end of file diff --git a/docs/generators/go-server/index.html b/docs/generators/go-server/index.html index 9ab3c17a86f..da52199f65a 100644 --- a/docs/generators/go-server/index.html +++ b/docs/generators/go-server/index.html @@ -15,13 +15,13 @@ - +

                                Documentation for the go-server Generator

                                METADATA​

                                PropertyValueNotes
                                generator namego-serverpass this to the generate command after -g
                                generator stabilitySTABLE
                                generator typeSERVER
                                generator languageGo
                                generator default templating enginemustache
                                helpTxtGenerates a Go server library using OpenAPI-Generator. By default, it will also generate service classes -- which you can disable with the -Dnoservice environment variable.

                                CONFIG OPTIONS​

                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                OptionDescriptionValuesDefault
                                addResponseHeadersTo include response headers in ImplResponsefalse
                                enumClassPrefixPrefix enum with class namefalse
                                featureCORSEnable Cross-Origin Resource Sharing middlewarefalse
                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                onlyInterfacesExclude default service creators from output; only generate interfacesfalse
                                outputAsLibraryExclude main.go, go.mod, and Dockerfile from outputfalse
                                packageNameGo package name (convention: lowercase).openapi
                                packageVersionGo package version.1.0.0
                                routerSpecify the router which should be used.
                                mux
                                mux
                                chi
                                chi
                                		mux
                                serverPortThe network port the generated server binds to8080
                                sourceFoldersource folder for generated codego

                                IMPORT MAPPING​

                                Type/AliasImports

                                INSTANTIATION TYPES​

                                Type/AliasInstantiated By

                                LANGUAGE PRIMITIVES​

                                • bool
                                • byte
                                • complex128
                                • complex64
                                • float32
                                • float64
                                • int
                                • int32
                                • int64
                                • interface
                                • map[string]interface
                                • rune
                                • string
                                • uint
                                • uint32
                                • uint64

                                RESERVED WORDS​

                                • bool
                                • break
                                • byte
                                • case
                                • chan
                                • complex128
                                • complex64
                                • const
                                • continue
                                • default
                                • defer
                                • else
                                • error
                                • fallthrough
                                • float32
                                • float64
                                • for
                                • func
                                • go
                                • goto
                                • if
                                • import
                                • int
                                • int16
                                • int32
                                • int64
                                • int8
                                • interface
                                • map
                                • nil
                                • package
                                • range
                                • return
                                • rune
                                • select
                                • string
                                • struct
                                • switch
                                • type
                                • uint
                                • uint16
                                • uint32
                                • uint64
                                • uint8
                                • uintptr
                                • var

                                FEATURE SET​

                                Client Modification Feature​

                                NameSupportedDefined By
                                BasePath✗ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✗ToolingExtension
                                MockServer✗ToolingExtension

                                Data Type Feature​

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Uuid✗
                                Array✓OAS2,OAS3
                                Null✗OAS3
                                AnyType✗OAS2,OAS3
                                Object✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature​

                                NameSupportedDefined By
                                Readme✓ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature​

                                NameSupportedDefined By
                                Host✓OAS2,OAS3
                                BasePath✓OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✗OAS3
                                ParameterStyling✗OAS3
                                Callbacks✗OAS3
                                LinkObjects✗OAS3

                                Parameter Feature​

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✗OAS3

                                Schema Support Feature​

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✗OAS2,OAS3
                                Union✗OAS3
                                allOf✗OAS2,OAS3
                                anyOf✗OAS3
                                oneOf✗OAS3
                                not✗OAS3

                                Security Feature​

                                NameSupportedDefined By
                                BasicAuth✗OAS2,OAS3
                                ApiKey✗OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✗OAS3
                                OAuth2_Implicit✗OAS2,OAS3
                                OAuth2_Password✗OAS2,OAS3
                                OAuth2_ClientCredentials✗OAS2,OAS3
                                OAuth2_AuthorizationCode✗OAS2,OAS3
                                SignatureAuth✗OAS3
                                AWSV4Signature✗ToolingExtension

                                Wire Format Feature​

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✓OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                - + \ No newline at end of file diff --git a/docs/generators/go/index.html b/docs/generators/go/index.html index 63c7a4e88f2..3f83ddb0fe4 100644 --- a/docs/generators/go/index.html +++ b/docs/generators/go/index.html @@ -15,13 +15,13 @@ - +

                                Documentation for the go Generator

                                METADATA​

                                PropertyValueNotes
                                generator namegopass this to the generate command after -g
                                generator stabilitySTABLE
                                generator typeCLIENT
                                generator languageGo
                                generator default templating enginemustache
                                helpTxtGenerates a Go client library.

                                CONFIG OPTIONS​

                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                OptionDescriptionValuesDefault
                                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                false
                                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                true
                                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                		true
                                enumClassPrefixPrefix enum with class namefalse
                                generateInterfacesGenerate interfaces for api classesfalse
                                generateMarshalJSONGenerate MarshalJSON methodtrue
                                generateUnmarshalJSONGenerate UnmarshalJSON methodtrue
                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                isGoSubmodulewhether the generated Go module is a submodulefalse
                                packageNameGo package name (convention: lowercase).openapi
                                packageVersionGo package version.1.0.0
                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                structPrefixwhether to prefix struct with the class name. e.g. DeletePetOpts => PetApiDeletePetOptsfalse
                                useDefaultValuesForRequiredVarsUse default values for required variables when availablefalse
                                useOneOfDiscriminatorLookupUse the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped.false
                                withAWSV4Signaturewhether to include AWS v4 signature supportfalse
                                withGoModGenerate go.mod and go.sumtrue
                                withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                IMPORT MAPPING​

                                Type/AliasImports

                                INSTANTIATION TYPES​

                                Type/AliasInstantiated By

                                LANGUAGE PRIMITIVES​

                                • bool
                                • byte
                                • complex128
                                • complex64
                                • float32
                                • float64
                                • int
                                • int32
                                • int64
                                • interface
                                • map[string]interface
                                • rune
                                • string
                                • uint
                                • uint32
                                • uint64

                                RESERVED WORDS​

                                • bool
                                • break
                                • byte
                                • case
                                • chan
                                • complex128
                                • complex64
                                • const
                                • continue
                                • default
                                • defer
                                • else
                                • error
                                • fallthrough
                                • float32
                                • float64
                                • for
                                • func
                                • go
                                • goto
                                • if
                                • import
                                • int
                                • int16
                                • int32
                                • int64
                                • int8
                                • interface
                                • map
                                • nil
                                • package
                                • range
                                • return
                                • rune
                                • select
                                • string
                                • struct
                                • switch
                                • type
                                • uint
                                • uint16
                                • uint32
                                • uint64
                                • uint8
                                • uintptr
                                • var

                                FEATURE SET​

                                Client Modification Feature​

                                NameSupportedDefined By
                                BasePath✓ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✓ToolingExtension
                                MockServer✗ToolingExtension

                                Data Type Feature​

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Uuid✗
                                Array✓OAS2,OAS3
                                Null✗OAS3
                                AnyType✓OAS2,OAS3
                                Object✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature​

                                NameSupportedDefined By
                                Readme✓ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature​

                                NameSupportedDefined By
                                Host✓OAS2,OAS3
                                BasePath✓OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✓OAS3
                                ParameterStyling✗OAS3
                                Callbacks✗OAS3
                                LinkObjects✗OAS3

                                Parameter Feature​

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✓OAS3

                                Schema Support Feature​

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✗OAS2,OAS3
                                Union✗OAS3
                                allOf✓OAS2,OAS3
                                anyOf✓OAS3
                                oneOf✓OAS3
                                not✗OAS3

                                Security Feature​

                                NameSupportedDefined By
                                BasicAuth✓OAS2,OAS3
                                ApiKey✓OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✓OAS3
                                OAuth2_Implicit✓OAS2,OAS3
                                OAuth2_Password✗OAS2,OAS3
                                OAuth2_ClientCredentials✗OAS2,OAS3
                                OAuth2_AuthorizationCode✗OAS2,OAS3
                                SignatureAuth✓OAS3
                                AWSV4Signature✓ToolingExtension

                                Wire Format Feature​

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✓OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                - + \ No newline at end of file diff --git a/docs/generators/graphql-nodejs-express-server/index.html b/docs/generators/graphql-nodejs-express-server/index.html index 39dce1c3005..35de2ffc617 100644 --- a/docs/generators/graphql-nodejs-express-server/index.html +++ b/docs/generators/graphql-nodejs-express-server/index.html @@ -15,13 +15,13 @@ - +

                                Documentation for the graphql-nodejs-express-server Generator

                                METADATA​

                                PropertyValueNotes
                                generator namegraphql-nodejs-express-serverpass this to the generate command after -g
                                generator stabilitySTABLE
                                generator typeSERVER
                                generator languageJavascript
                                generator default templating enginemustache
                                helpTxtGenerates a GraphQL Node.js Express server (beta) including it's types, queries, mutations, (resolvers)

                                CONFIG OPTIONS​

                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                OptionDescriptionValuesDefault
                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                packageNameGraphQL Node.js Express server package name (convention: lowercase).openapi3graphql-server
                                packageVersionGraphQL Node.js Express server package version.1.0.0

                                IMPORT MAPPING​

                                Type/AliasImports

                                INSTANTIATION TYPES​

                                Type/AliasInstantiated By

                                LANGUAGE PRIMITIVES​

                                • Boolean
                                • Float
                                • ID
                                • Int
                                • String
                                • null

                                RESERVED WORDS​

                                • boolean
                                • float
                                • id
                                • implements
                                • int
                                • interface
                                • null
                                • query
                                • string
                                • type
                                • union

                                FEATURE SET​

                                Client Modification Feature​

                                NameSupportedDefined By
                                BasePath✗ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✗ToolingExtension
                                MockServer✗ToolingExtension

                                Data Type Feature​

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Uuid✗
                                Array✓OAS2,OAS3
                                Null✗OAS3
                                AnyType✗OAS2,OAS3
                                Object✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature​

                                NameSupportedDefined By
                                Readme✓ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature​

                                NameSupportedDefined By
                                Host✓OAS2,OAS3
                                BasePath✓OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✗OAS3
                                ParameterStyling✗OAS3
                                Callbacks✗OAS3
                                LinkObjects✗OAS3

                                Parameter Feature​

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✗OAS3

                                Schema Support Feature​

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✗OAS2,OAS3
                                Union✗OAS3
                                allOf✗OAS2,OAS3
                                anyOf✗OAS3
                                oneOf✗OAS3
                                not✗OAS3

                                Security Feature​

                                NameSupportedDefined By
                                BasicAuth✗OAS2,OAS3
                                ApiKey✗OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✗OAS3
                                OAuth2_Implicit✗OAS2,OAS3
                                OAuth2_Password✗OAS2,OAS3
                                OAuth2_ClientCredentials✗OAS2,OAS3
                                OAuth2_AuthorizationCode✗OAS2,OAS3
                                SignatureAuth✗OAS3
                                AWSV4Signature✗ToolingExtension

                                Wire Format Feature​

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✗OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                - + \ No newline at end of file diff --git a/docs/generators/graphql-schema/index.html b/docs/generators/graphql-schema/index.html index 2428bccd47c..c419b27a907 100644 --- a/docs/generators/graphql-schema/index.html +++ b/docs/generators/graphql-schema/index.html @@ -15,13 +15,13 @@ - +

                                Documentation for the graphql-schema Generator

                                METADATA​

                                PropertyValueNotes
                                generator namegraphql-schemapass this to the generate command after -g
                                generator stabilitySTABLE
                                generator typeSCHEMA
                                generator languageGraphQL
                                generator default templating enginemustache
                                helpTxtGenerates GraphQL schema files (beta)

                                CONFIG OPTIONS​

                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                OptionDescriptionValuesDefault
                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                packageNameGraphQL package name (convention: lowercase).openapi2graphql
                                packageVersionGraphQL package version.1.0.0

                                IMPORT MAPPING​

                                Type/AliasImports

                                INSTANTIATION TYPES​

                                Type/AliasInstantiated By

                                LANGUAGE PRIMITIVES​

                                • Boolean
                                • Float
                                • ID
                                • Int
                                • String
                                • null

                                RESERVED WORDS​

                                • boolean
                                • float
                                • id
                                • implements
                                • int
                                • interface
                                • null
                                • query
                                • string
                                • type
                                • union

                                FEATURE SET​

                                Client Modification Feature​

                                NameSupportedDefined By
                                BasePath✗ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✗ToolingExtension
                                MockServer✗ToolingExtension

                                Data Type Feature​

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Uuid✗
                                Array✓OAS2,OAS3
                                Null✗OAS3
                                AnyType✗OAS2,OAS3
                                Object✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature​

                                NameSupportedDefined By
                                Readme✗ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature​

                                NameSupportedDefined By
                                Host✓OAS2,OAS3
                                BasePath✓OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✗OAS3
                                ParameterStyling✗OAS3
                                Callbacks✗OAS3
                                LinkObjects✗OAS3

                                Parameter Feature​

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✓OAS3

                                Schema Support Feature​

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✗OAS2,OAS3
                                Union✗OAS3
                                allOf✗OAS2,OAS3
                                anyOf✗OAS3
                                oneOf✗OAS3
                                not✗OAS3

                                Security Feature​

                                NameSupportedDefined By
                                BasicAuth✗OAS2,OAS3
                                ApiKey✗OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✗OAS3
                                OAuth2_Implicit✗OAS2,OAS3
                                OAuth2_Password✗OAS2,OAS3
                                OAuth2_ClientCredentials✗OAS2,OAS3
                                OAuth2_AuthorizationCode✗OAS2,OAS3
                                SignatureAuth✗OAS3
                                AWSV4Signature✗ToolingExtension

                                Wire Format Feature​

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✗OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                - + \ No newline at end of file diff --git a/docs/generators/groovy/index.html b/docs/generators/groovy/index.html index c1327eb5547..8a0021c46c1 100644 --- a/docs/generators/groovy/index.html +++ b/docs/generators/groovy/index.html @@ -15,13 +15,13 @@ - +

                                Documentation for the groovy Generator

                                METADATA​

                                PropertyValueNotes
                                generator namegroovypass this to the generate command after -g
                                generator stabilitySTABLE
                                generator typeCLIENT
                                generator languageGroovy
                                generator default templating enginemustache
                                helpTxtGenerates a Groovy API client.

                                CONFIG OPTIONS​

                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                OptionDescriptionValuesDefault
                                additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                apiPackagepackage for generated api classesorg.openapitools.api
                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-groovy
                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                booleanGetterPrefixSet booleanGetterPrefixget
                                camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                dateLibraryOption. Date library to use
                                joda
                                Joda (for legacy app only)
                                legacy
                                Legacy java.util.Date
                                java8-localdatetime
                                Java 8 using LocalDateTime (for legacy app only)
                                java8
                                Java 8 native JSR310 (preferred for jdk 1.8+)
                                		legacy
                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                false
                                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                true
                                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                		true
                                discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                false
                                No changes to the enum's are made, this is the default option.
                                true
                                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                		false
                                generateBuildersWhether to generate builders for modelsfalse
                                generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                groupIdgroupId in generated pom.xmlorg.openapitools
                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                invokerPackageroot package for generated codeorg.openapitools.api
                                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                true
                                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                false
                                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                		true
                                licenseNameThe name of the licenseUnlicense
                                licenseUrlThe URL of the licensehttp://unlicense.org
                                modelPackagepackage for generated modelsorg.openapitools.model
                                openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                snapshotVersionUses a SNAPSHOT version.
                                true
                                Use a SnapShot Version
                                false
                                Use a Release Version
                                		null
                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                sourceFoldersource folder for generated codesrc/main/groovy
                                testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                SUPPORTED VENDOR EXTENSIONS​

                                Extension nameDescriptionApplicable forDefault value
                                x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                IMPORT MAPPING​

                                Type/AliasImports
                                Arrayjava.util.List
                                ArrayListjava.util.ArrayList
                                BigDecimaljava.math.BigDecimal
                                Datejava.util.Date
                                DateTimeorg.joda.time.*
                                Filejava.io.File
                                HashMapjava.util.HashMap
                                LinkedHashSetjava.util.LinkedHashSet
                                Listjava.util.*
                                LocalDateorg.joda.time.*
                                LocalDateTimeorg.joda.time.*
                                LocalTimeorg.joda.time.*
                                Mapjava.util.Map
                                Setjava.util.*
                                Timestampjava.sql.Timestamp
                                URIjava.net.URI
                                UUIDjava.util.UUID

                                INSTANTIATION TYPES​

                                Type/AliasInstantiated By
                                arrayArrayList
                                mapHashMap
                                setLinkedHashSet

                                LANGUAGE PRIMITIVES​

                                • ArrayList
                                • Boolean
                                • Date
                                • Double
                                • File
                                • Float
                                • Integer
                                • List
                                • Long
                                • Map
                                • Object
                                • String
                                • boolean
                                • byte[]

                                RESERVED WORDS​

                                • _
                                • abstract
                                • apiclient
                                • apiexception
                                • apiresponse
                                • assert
                                • boolean
                                • break
                                • byte
                                • case
                                • catch
                                • char
                                • class
                                • configuration
                                • const
                                • continue
                                • default
                                • do
                                • double
                                • else
                                • enum
                                • extends
                                • file
                                • final
                                • finally
                                • float
                                • for
                                • goto
                                • if
                                • implements
                                • import
                                • instanceof
                                • int
                                • interface
                                • list
                                • localdate
                                • localreturntype
                                • localtime
                                • localvaraccept
                                • localvaraccepts
                                • localvarauthnames
                                • localvarcollectionqueryparams
                                • localvarcontenttype
                                • localvarcontenttypes
                                • localvarcookieparams
                                • localvarformparams
                                • localvarheaderparams
                                • localvarpath
                                • localvarpostbody
                                • localvarqueryparams
                                • long
                                • native
                                • new
                                • null
                                • object
                                • offsetdatetime
                                • package
                                • private
                                • protected
                                • public
                                • return
                                • short
                                • static
                                • strictfp
                                • stringutil
                                • super
                                • switch
                                • synchronized
                                • this
                                • throw
                                • throws
                                • transient
                                • try
                                • void
                                • volatile
                                • while

                                FEATURE SET​

                                Client Modification Feature​

                                NameSupportedDefined By
                                BasePath✓ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✗ToolingExtension
                                MockServer✗ToolingExtension

                                Data Type Feature​

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Uuid✗
                                Array✓OAS2,OAS3
                                Null✗OAS3
                                AnyType✗OAS2,OAS3
                                Object✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature​

                                NameSupportedDefined By
                                Readme✓ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature​

                                NameSupportedDefined By
                                Host✓OAS2,OAS3
                                BasePath✓OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✗OAS3
                                ParameterStyling✗OAS3
                                Callbacks✗OAS3
                                LinkObjects✗OAS3

                                Parameter Feature​

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✗OAS3

                                Schema Support Feature​

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✗OAS2,OAS3
                                Union✗OAS3
                                allOf✗OAS2,OAS3
                                anyOf✗OAS3
                                oneOf✗OAS3
                                not✗OAS3

                                Security Feature​

                                NameSupportedDefined By
                                BasicAuth✗OAS2,OAS3
                                ApiKey✗OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✗OAS3
                                OAuth2_Implicit✗OAS2,OAS3
                                OAuth2_Password✗OAS2,OAS3
                                OAuth2_ClientCredentials✗OAS2,OAS3
                                OAuth2_AuthorizationCode✗OAS2,OAS3
                                SignatureAuth✗OAS3
                                AWSV4Signature✗ToolingExtension

                                Wire Format Feature​

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✗OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                Edit this page
                                Last updated on by Rodrigo de Almeida - RMA3
                                - + \ No newline at end of file diff --git a/docs/generators/haskell-http-client/index.html b/docs/generators/haskell-http-client/index.html index 8e2ef8e92e8..9b89f63700d 100644 --- a/docs/generators/haskell-http-client/index.html +++ b/docs/generators/haskell-http-client/index.html @@ -15,13 +15,13 @@ - +

                                Documentation for the haskell-http-client Generator

                                METADATA​

                                PropertyValueNotes
                                generator namehaskell-http-clientpass this to the generate command after -g
                                generator stabilitySTABLE
                                generator typeCLIENT
                                generator languageHaskell
                                generator default templating enginemustache
                                helpTxtGenerates a Haskell http-client library.

                                CONFIG OPTIONS​

                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                OptionDescriptionValuesDefault
                                allowFromJsonNullsallow JSON Null during model decoding from JSONtrue
                                allowNonUniqueOperationIdsallow different API modules to contain the same operationId. Each API must be imported qualifiedfalse
                                allowToJsonNullsallow emitting JSON Null during model encoding to JSONfalse
                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                baseModuleSet the base module namespacenull
                                cabalPackageSet the cabal package name, which consists of one or more alphanumeric words separated by hyphensnull
                                cabalVersionSet the cabal version number, consisting of a sequence of one or more integers separated by dotsnull
                                configTypeSet the name of the type used for configurationnull
                                customTestInstanceModuletest module used to provide typeclass instances for types not known by the generatornull
                                dateFormatformat string used to parse/render a date%Y-%m-%d
                                dateTimeFormatformat string used to parse/render a datetimenull
                                dateTimeParseFormatoverrides the format string used to parse a datetimenull
                                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                false
                                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                true
                                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                		true
                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                false
                                No changes to the enum's are made, this is the default option.
                                true
                                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                		false
                                generateEnumsGenerate specific datatypes for OpenAPI enumstrue
                                generateFormUrlEncodedInstancesGenerate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencodedtrue
                                generateLensesGenerate Lens optics for Modelstrue
                                generateModelConstructorsGenerate smart constructors (only supply required fields) for modelstrue
                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                inlineMimeTypesInline (hardcode) the content-type and accept parameters on operations, when there is only 1 optiontrue
                                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                true
                                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                false
                                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                		true
                                modelDerivingAdditional classes to include in the deriving() clause of Modelsnull
                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                queryExtraUnreservedConfigures additional querystring characters which must not be URI encoded, e.g. '+' or ':'null
                                requestTypeSet the name of the type used to generate requestsnull
                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                strictFieldsAdd strictness annotations to all model fieldstrue
                                useKatipSets the default value for the UseKatip cabal flag. If true, the katip package provides logging instead of monad-loggertrue

                                IMPORT MAPPING​

                                Type/AliasImports

                                INSTANTIATION TYPES​

                                Type/AliasInstantiated By

                                LANGUAGE PRIMITIVES​

                                • Bool
                                • Char
                                • Double
                                • FilePath
                                • Float
                                • Int
                                • Integer
                                • List
                                • String
                                • Text

                                RESERVED WORDS​

                                • accept
                                • as
                                • case
                                • class
                                • contenttype
                                • data
                                • default
                                • deriving
                                • do
                                • else
                                • family
                                • forall
                                • foreign
                                • hiding
                                • if
                                • import
                                • in
                                • infix
                                • infixl
                                • infixr
                                • instance
                                • let
                                • mdo
                                • module
                                • newtype
                                • of
                                • proc
                                • pure
                                • qualified
                                • rec
                                • return
                                • then
                                • type
                                • where

                                FEATURE SET​

                                Client Modification Feature​

                                NameSupportedDefined By
                                BasePath✓ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✓ToolingExtension
                                MockServer✗ToolingExtension

                                Data Type Feature​

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Uuid✗
                                Array✓OAS2,OAS3
                                Null✗OAS3
                                AnyType✗OAS2,OAS3
                                Object✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature​

                                NameSupportedDefined By
                                Readme✓ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature​

                                NameSupportedDefined By
                                Host✓OAS2,OAS3
                                BasePath✓OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✗OAS3
                                ParameterStyling✗OAS3
                                Callbacks✗OAS3
                                LinkObjects✗OAS3

                                Parameter Feature​

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✗OAS3

                                Schema Support Feature​

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✗OAS2,OAS3
                                Union✗OAS3
                                allOf✗OAS2,OAS3
                                anyOf✗OAS3
                                oneOf✗OAS3
                                not✗OAS3

                                Security Feature​

                                NameSupportedDefined By
                                BasicAuth✓OAS2,OAS3
                                ApiKey✓OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✗OAS3
                                OAuth2_Implicit✓OAS2,OAS3
                                OAuth2_Password✗OAS2,OAS3
                                OAuth2_ClientCredentials✗OAS2,OAS3
                                OAuth2_AuthorizationCode✗OAS2,OAS3
                                SignatureAuth✗OAS3
                                AWSV4Signature✗ToolingExtension

                                Wire Format Feature​

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✓OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                - + \ No newline at end of file diff --git a/docs/generators/haskell-yesod/index.html b/docs/generators/haskell-yesod/index.html index d0695e9a643..8c18b276c6a 100644 --- a/docs/generators/haskell-yesod/index.html +++ b/docs/generators/haskell-yesod/index.html @@ -15,13 +15,13 @@ - +

                                Documentation for the haskell-yesod Generator

                                METADATA​

                                PropertyValueNotes
                                generator namehaskell-yesodpass this to the generate command after -g
                                generator stabilityBETA
                                generator typeSERVER
                                generator languageHaskell
                                generator default templating enginemustache
                                helpTxtGenerates a haskell-yesod server.

                                CONFIG OPTIONS​

                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                OptionDescriptionValuesDefault
                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                apiModuleNamename of the API module (Default: generated from info.title or "API")null
                                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                false
                                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                true
                                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                		true
                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                false
                                No changes to the enum's are made, this is the default option.
                                true
                                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                		false
                                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                true
                                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                false
                                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                		true
                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                projectNamename of the project (Default: generated from info.title or "openapi-haskell-yesod-server")null
                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                IMPORT MAPPING​

                                Type/AliasImports

                                INSTANTIATION TYPES​

                                Type/AliasInstantiated By

                                LANGUAGE PRIMITIVES​

                                • Bool
                                • Day
                                • Double
                                • Float
                                • Int
                                • Int64
                                • Text
                                • UTCTime

                                RESERVED WORDS​

                                • as
                                • case
                                • class
                                • data
                                • default
                                • deriving
                                • do
                                • else
                                • family
                                • forall
                                • foreign
                                • hiding
                                • if
                                • import
                                • in
                                • infix
                                • infixl
                                • infixr
                                • instance
                                • let
                                • mdo
                                • module
                                • newtype
                                • of
                                • proc
                                • qualified
                                • rec
                                • then
                                • type
                                • where

                                FEATURE SET​

                                Client Modification Feature​

                                NameSupportedDefined By
                                BasePath✗ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✗ToolingExtension
                                MockServer✗ToolingExtension

                                Data Type Feature​

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Uuid✗
                                Array✓OAS2,OAS3
                                Null✗OAS3
                                AnyType✗OAS2,OAS3
                                Object✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature​

                                NameSupportedDefined By
                                Readme✓ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature​

                                NameSupportedDefined By
                                Host✓OAS2,OAS3
                                BasePath✓OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✗OAS3
                                ParameterStyling✗OAS3
                                Callbacks✗OAS3
                                LinkObjects✗OAS3

                                Parameter Feature​

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✓OAS3

                                Schema Support Feature​

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✗OAS2,OAS3
                                Union✗OAS3
                                allOf✗OAS2,OAS3
                                anyOf✗OAS3
                                oneOf✗OAS3
                                not✗OAS3

                                Security Feature​

                                NameSupportedDefined By
                                BasicAuth✓OAS2,OAS3
                                ApiKey✓OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✗OAS3
                                OAuth2_Implicit✓OAS2,OAS3
                                OAuth2_Password✗OAS2,OAS3
                                OAuth2_ClientCredentials✗OAS2,OAS3
                                OAuth2_AuthorizationCode✗OAS2,OAS3
                                SignatureAuth✗OAS3
                                AWSV4Signature✗ToolingExtension

                                Wire Format Feature​

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✗OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                - + \ No newline at end of file diff --git a/docs/generators/haskell/index.html b/docs/generators/haskell/index.html index 51467eafaf6..5785003be4a 100644 --- a/docs/generators/haskell/index.html +++ b/docs/generators/haskell/index.html @@ -15,13 +15,13 @@ - +

                                Documentation for the haskell Generator

                                METADATA​

                                PropertyValueNotes
                                generator namehaskellpass this to the generate command after -g
                                generator stabilitySTABLE
                                generator typeSERVER
                                generator languageHaskell
                                generator default templating enginemustache
                                helpTxtGenerates a Haskell server and client library.

                                CONFIG OPTIONS​

                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                OptionDescriptionValuesDefault
                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                apiPackagepackage for generated api classesnull
                                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                false
                                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                true
                                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                		true
                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                false
                                No changes to the enum's are made, this is the default option.
                                true
                                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                		false
                                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                true
                                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                false
                                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                		true
                                modelPackagepackage for generated modelsnull
                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                serveStaticserve will serve files from the directory 'static'.true
                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                useCustomMonaduse a custom monad instead of the default Handlerfalse

                                IMPORT MAPPING​

                                Type/AliasImports
                                Mapqualified Data.Map as Map

                                INSTANTIATION TYPES​

                                Type/AliasInstantiated By

                                LANGUAGE PRIMITIVES​

                                • Bool
                                • Char
                                • Double
                                • FilePath
                                • Float
                                • Int
                                • Integer
                                • List
                                • String

                                RESERVED WORDS​

                                • as
                                • case
                                • class
                                • data
                                • default
                                • deriving
                                • do
                                • else
                                • family
                                • forall
                                • foreign
                                • hiding
                                • if
                                • import
                                • in
                                • infix
                                • infixl
                                • infixr
                                • instance
                                • let
                                • mdo
                                • module
                                • newtype
                                • of
                                • proc
                                • qualified
                                • rec
                                • then
                                • type
                                • where

                                FEATURE SET​

                                Client Modification Feature​

                                NameSupportedDefined By
                                BasePath✗ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✗ToolingExtension
                                MockServer✗ToolingExtension

                                Data Type Feature​

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Uuid✗
                                Array✓OAS2,OAS3
                                Null✗OAS3
                                AnyType✗OAS2,OAS3
                                Object✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature​

                                NameSupportedDefined By
                                Readme✓ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature​

                                NameSupportedDefined By
                                Host✓OAS2,OAS3
                                BasePath✓OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✗OAS3
                                ParameterStyling✗OAS3
                                Callbacks✗OAS3
                                LinkObjects✗OAS3

                                Parameter Feature​

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✓OAS3

                                Schema Support Feature​

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✗OAS2,OAS3
                                Union✗OAS3
                                allOf✗OAS2,OAS3
                                anyOf✗OAS3
                                oneOf✗OAS3
                                not✗OAS3

                                Security Feature​

                                NameSupportedDefined By
                                BasicAuth✓OAS2,OAS3
                                ApiKey✓OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✓OAS3
                                OAuth2_Implicit✓OAS2,OAS3
                                OAuth2_Password✗OAS2,OAS3
                                OAuth2_ClientCredentials✗OAS2,OAS3
                                OAuth2_AuthorizationCode✗OAS2,OAS3
                                SignatureAuth✗OAS3
                                AWSV4Signature✗ToolingExtension

                                Wire Format Feature​

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✓OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                - + \ No newline at end of file diff --git a/docs/generators/html/index.html b/docs/generators/html/index.html index d37a2f0d019..df07f7656c0 100644 --- a/docs/generators/html/index.html +++ b/docs/generators/html/index.html @@ -15,13 +15,13 @@ - +

                                Documentation for the html Generator

                                METADATA​

                                PropertyValueNotes
                                generator namehtmlpass this to the generate command after -g
                                generator stabilitySTABLE
                                generator typeDOCUMENTATION
                                generator default templating enginemustache
                                helpTxtGenerates a static HTML file.

                                CONFIG OPTIONS​

                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                OptionDescriptionValuesDefault
                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                appDescriptiondescription of the applicationnull
                                appNameshort name of the applicationnull
                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.null
                                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                false
                                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                true
                                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                		true
                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                false
                                No changes to the enum's are made, this is the default option.
                                true
                                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                		false
                                groupIdgroupId in generated pom.xmlnull
                                infoEmailan email address to contact for inquiries about the applicationnull
                                infoUrla URL where users can get more information about the applicationnull
                                invokerPackageroot package for generated codenull
                                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                true
                                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                false
                                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                		true
                                licenseInfoa short description of the licensenull
                                licenseUrla URL pointing to the full licensenull
                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                IMPORT MAPPING​

                                Type/AliasImports

                                INSTANTIATION TYPES​

                                Type/AliasInstantiated By

                                LANGUAGE PRIMITIVES​

                                  RESERVED WORDS​

                                    FEATURE SET​

                                    Client Modification Feature​

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension
                                    MockServer✗ToolingExtension

                                    Data Type Feature​

                                    NameSupportedDefined By
                                    Custom✓OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Uuid✓
                                    Array✓OAS2,OAS3
                                    Null✓OAS3
                                    AnyType✓OAS2,OAS3
                                    Object✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature​

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature​

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✓OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✓OAS2,OAS3
                                    MultiServer✓OAS3
                                    ParameterizedServer✓OAS3
                                    ParameterStyling✓OAS3
                                    Callbacks✓OAS3
                                    LinkObjects✓OAS3

                                    Parameter Feature​

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✓OAS3

                                    Schema Support Feature​

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✓OAS3
                                    allOf✓OAS2,OAS3
                                    anyOf✓OAS3
                                    oneOf✓OAS3
                                    not✓OAS3

                                    Security Feature​

                                    NameSupportedDefined By
                                    BasicAuth✓OAS2,OAS3
                                    ApiKey✓OAS2,OAS3
                                    OpenIDConnect✓OAS3
                                    BearerToken✓OAS3
                                    OAuth2_Implicit✓OAS2,OAS3
                                    OAuth2_Password✓OAS2,OAS3
                                    OAuth2_ClientCredentials✓OAS2,OAS3
                                    OAuth2_AuthorizationCode✓OAS2,OAS3
                                    SignatureAuth✓OAS3
                                    AWSV4Signature✓ToolingExtension

                                    Wire Format Feature​

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✓ToolingExtension
                                    Custom✓OAS2,OAS3
                                    - + \ No newline at end of file diff --git a/docs/generators/html2/index.html b/docs/generators/html2/index.html index 47c3ae84277..169c016630e 100644 --- a/docs/generators/html2/index.html +++ b/docs/generators/html2/index.html @@ -15,13 +15,13 @@ - +

                                    Documentation for the html2 Generator

                                    METADATA​

                                    PropertyValueNotes
                                    generator namehtml2pass this to the generate command after -g
                                    generator stabilitySTABLE
                                    generator typeDOCUMENTATION
                                    generator default templating enginemustache
                                    helpTxtGenerates a static HTML file.

                                    CONFIG OPTIONS​

                                    These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                    OptionDescriptionValuesDefault
                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                    appDescriptiondescription of the applicationnull
                                    appNameshort name of the applicationnull
                                    artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                                    artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.null
                                    disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                    false
                                    The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                    true
                                    Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                    		true
                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                    enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                    false
                                    No changes to the enum's are made, this is the default option.
                                    true
                                    With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                    		false
                                    groupIdgroupId in generated pom.xmlnull
                                    infoEmailan email address to contact for inquiries about the applicationnull
                                    infoUrla URL where users can get more information about the applicationnull
                                    invokerPackageroot package for generated codenull
                                    legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                    true
                                    The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                    false
                                    The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                    		true
                                    licenseInfoa short description of the licensenull
                                    licenseUrla URL pointing to the full licensenull
                                    packageNameC# package namenull
                                    perlModuleNameroot module name for generated perl codenull
                                    phpInvokerPackageroot package for generated php codenull
                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                    pythonPackageNamepackage name for generated python codenull
                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                    IMPORT MAPPING​

                                    Type/AliasImports

                                    INSTANTIATION TYPES​

                                    Type/AliasInstantiated By

                                    LANGUAGE PRIMITIVES​

                                      RESERVED WORDS​

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✗ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✓OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✓
                                        Array✓OAS2,OAS3
                                        Null✓OAS3
                                        AnyType✓OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✓OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✓OAS2,OAS3
                                        MultiServer✓OAS3
                                        ParameterizedServer✓OAS3
                                        ParameterStyling✓OAS3
                                        Callbacks✓OAS3
                                        LinkObjects✓OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✓OAS2,OAS3
                                        Union✓OAS3
                                        allOf✓OAS2,OAS3
                                        anyOf✓OAS3
                                        oneOf✓OAS3
                                        not✓OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✓OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✓OAS2,OAS3
                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                        OAuth2_AuthorizationCode✓OAS2,OAS3
                                        SignatureAuth✓OAS3
                                        AWSV4Signature✓ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✓ToolingExtension
                                        Custom✓OAS2,OAS3
                                        - + \ No newline at end of file diff --git a/docs/generators/index.html b/docs/generators/index.html index cb11a9dca6d..40f5b1b9672 100644 --- a/docs/generators/index.html +++ b/docs/generators/index.html @@ -3,7 +3,7 @@ -Generators List | OpenAPI Generator +Generators List | OpenAPI Generator @@ -15,13 +15,13 @@ - +

                                        Generators List

                                        The following generators are available:

                                        CLIENT generators​

                                        SERVER generators​

                                        DOCUMENTATION generators​

                                        SCHEMA generators​

                                        CONFIG generators​

                                        - + \ No newline at end of file diff --git a/docs/generators/java-camel/index.html b/docs/generators/java-camel/index.html index 34405e87d39..f4bdd62157d 100644 --- a/docs/generators/java-camel/index.html +++ b/docs/generators/java-camel/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-camel Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-camelpass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java Camel server (beta).

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        annotationLibrarySelect the complementary documentation annotation library.
                                        none
                                        Do not annotate Model and Api with complementary annotations.
                                        swagger1
                                        Annotate Model and Api using the Swagger Annotations 1.x library.
                                        swagger2
                                        Annotate Model and Api using the Swagger Annotations 2.x library.
                                        		swagger2
                                        apiFirstGenerate the API from the OAI spec at server compile time (API first approach)false
                                        apiPackagepackage for generated api classesorg.openapitools.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-spring
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        asyncuse async Callable controllersfalse
                                        basePackagebase package (invokerPackage) for generated codeorg.openapitools
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        camelDataformatPropertieslist of dataformat properties separated by comma (propertyName1=propertyValue2,...
                                        camelRestBindingModebinding mode to be used by the REST consumerauto
                                        camelRestClientRequestValidationenable validation of the client request to check whether the Content-Type and Accept headers from the client is supported by the Rest-DSL configurationfalse
                                        camelRestComponentname of the Camel component to use as the REST consumerservlet
                                        camelSecurityDefinitionsgenerate camel security definitionstrue
                                        camelUseDefaultValidationErrorProcessorgenerate default validation error processortrue
                                        camelValidationErrorProcessorvalidation error processor bean namevalidationErrorProcessor
                                        configPackageconfiguration package for generated codeorg.openapitools.configuration
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		java8
                                        delegatePatternWhether to generate the server files using the delegate patternfalse
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        documentationProviderSelect the OpenAPI documentation provider.
                                        none
                                        Do not publish an OpenAPI specification.
                                        source
                                        Publish the original input OpenAPI specification.
                                        springfox
                                        Generate an OpenAPI 2 (fka Swagger RESTful API Documentation Specification) specification using SpringFox 2.x. Deprecated (for removal); use springdoc instead.
                                        springdoc
                                        Generate an OpenAPI 3 specification using SpringDoc.
                                        		springdoc
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        generatedConstructorWithRequiredArgsWhether to generate constructors with required args for modelstrue
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hateoasUse Spring HATEOAS library to allow adding HATEOAS linksfalse
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        interfaceOnlyWhether to generate only API interface stubs without the server files.false
                                        invokerPackageroot package for generated codeorg.openapitools.api
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        librarylibrary template (sub-template)
                                        spring-boot
                                        Spring-boot Server application.
                                        spring-cloud
                                        Spring-Cloud-Feign client with Spring-Boot auto-configured settings.
                                        spring-http-interface
                                        Spring 6 HTTP interfaces (testing)
                                        		spring-boot
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        performBeanValidationUse Bean Validation Impl. to perform BeanValidationfalse
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        reactivewrap responses in Mono/Flux Reactor types (spring-boot only)false
                                        requestMappingModeWhere to generate the class level @RequestMapping annotation.
                                        api_interface
                                        Generate the @RequestMapping annotation on the generated Api Interface.
                                        controller
                                        Generate the @RequestMapping annotation on the generated Api Controller Implementation.
                                        none
                                        Do not add a class level @RequestMapping annotation.
                                        		controller
                                        resourceFolderresource folder for generated resourcessrc/main/resources
                                        responseWrapperwrap the responses in given type (Future, Callable, CompletableFuture,ListenableFuture, DeferredResult, RxObservable, RxSingle or fully qualified type)null
                                        returnSuccessCodeGenerated server returns 2xx codefalse
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        singleContentTypesWhether to select only one produces/consumes content-type by operation.false
                                        skipDefaultInterfaceWhether to skip generation of default implementations for java8 interfacesfalse
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/main/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        titleserver title name or client service nameOpenAPI Spring
                                        unhandledExceptionDeclare operation methods to throw a generic exception and allow unhandled exceptions (useful for Spring @ControllerAdvice directives).false
                                        useBeanValidationUse BeanValidation API annotationstrue
                                        useEnumCaseInsensitiveUse equalsIgnoreCase when String for enum comparisonfalse
                                        useFeignClientUrlWhether to generate Feign client with url parameter.true
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        useOptionalUse Optional container for optional parametersfalse
                                        useResponseEntityUse the ResponseEntity type to wrap return values of generated API methods. If disabled, method are annotated using a @ResponseStatus annotation, which has the status of the first response declared in the Api definitiontrue
                                        useSpringBoot3Generate code and provide dependencies for use with Spring Boot 3.x. (Use jakarta instead of javax in imports). Enabling this option will also enable useJakartaEe.false
                                        useSpringControllerAnnotate the generated API as a Spring Controllerfalse
                                        useSwaggerUIOpen the OpenApi specification in swagger-ui. Will also import and configure needed dependenciestrue
                                        useTagsuse tags for creating interface and controller classnamesfalse
                                        virtualServiceGenerates the virtual service. For more details refer - https://github.com/virtualansoftware/virtualan/wikifalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull
                                        x-operation-extra-annotationList of custom annotations to be added to operationOPERATIONnull
                                        x-spring-paginatedAdd org.springframework.data.domain.Pageable to controller method. Can be used to handle page & size query parametersOPERATIONfalse
                                        x-version-paramMarker property that tells that this parameter would be used for endpoint versioning. Applicable for headers & query params. true/falseOPERATION_PARAMETERnull
                                        x-pattern-messageAdd this property whenever you need to customize the invalidation error message for the regex pattern of a variableFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✓OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✗OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✓OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✗OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✓OAS2,OAS3
                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                        OAuth2_AuthorizationCode✓OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✓OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/java-helidon-client/index.html b/docs/generators/java-helidon-client/index.html index 8711ba4a6c8..ff5a8368497 100644 --- a/docs/generators/java-helidon-client/index.html +++ b/docs/generators/java-helidon-client/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-helidon-client Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-helidon-clientpass this to the generate command after -g
                                        generator stabilityBETA
                                        generator typeCLIENT
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Helidon MP or SE client

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.client.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-client
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        configKeyConfig key in @RegisterRestClient. Default to none.null
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		java8
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        fullProjectIf set to true, it will generate all files; if set to false, it will only generate API files. If unspecified, the behavior depends on whether a project exists or not: if it does not, same as true; if it does, same as false. Note that test files are never overwritten.
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        helidonVersionHelidon complete version identifier or major version number. The specified exact Helidon release or, if specified as a major version the latest release of that major version, is used in the generated code.Highest released version.
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.client
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        librarylibrary template (sub-template) to use
                                        mp
                                        Helidon MP Client
                                        se
                                        Helidon SE Client
                                        		mp
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.client.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        rootJavaEEPackageRoot package name for Java EEHelidon 2.x and earlier: javax; Helidon 3.x and later: jakarta
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serializationLibrarySerialization library, defaults to Jackson
                                        jsonb
                                        Use JSON-B as serialization library
                                        jackson
                                        Use Jackson as serialization library
                                        		null
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/main/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false
                                        x-helidon-groupBySelects how to group operations into APIs
                                        tags
                                        Use the 'tags' settings on each operation
                                        first-path-segment
                                        Use the first segment of the path
                                        		tags
                                        x-helidon-useOptionalWrap optional parameters in an Optional (Helidon 4 and later)true

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull
                                        x-webclient-blockingSpecifies if method for specific operation should be blocking or non-blocking(ex: return Mono<T>/Flux<T> or return T/List<T>/Set<T> & execute .block() inside generated method)OPERATIONfalse

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✓OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        - + \ No newline at end of file diff --git a/docs/generators/java-helidon-server/index.html b/docs/generators/java-helidon-server/index.html index 4fcd9e47e66..11ca64e54dc 100644 --- a/docs/generators/java-helidon-server/index.html +++ b/docs/generators/java-helidon-server/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-helidon-server Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-helidon-serverpass this to the generate command after -g
                                        generator stabilityBETA
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java Helidon Server application.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.server.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-server
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		java8
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        fullProjectIf set to true, it will generate all files; if set to false, it will only generate API files. If unspecified, the behavior depends on whether a project exists or not: if it does not, same as true; if it does, same as false. Note that test files are never overwritten.
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        gradleProjectWhether to generate gradle project instead of maven.false
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        helidonVersionHelidon complete version identifier or major version number. The specified exact Helidon release or, if specified as a major version the latest release of that major version, is used in the generated code.Highest released version.
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.server
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        librarylibrary template (sub-template) to use
                                        mp
                                        Helidon MP Server
                                        se
                                        Helidon SE Server
                                        		se
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.server.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        performBeanValidationPerform BeanValidationfalse
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        rootJavaEEPackageRoot package name for Java EEHelidon 2.x and earlier: javax; Helidon 3.x and later: jakarta
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serializationLibrarySerialization library, defaults to Jackson
                                        jsonb
                                        Use JSON-B as serialization library
                                        jackson
                                        Use Jackson as serialization library
                                        		null
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/main/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        useAbstractClassWhether to generate abstract classes for REST API instead of interfaces.false
                                        useBeanValidationUse Bean Validationfalse
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false
                                        x-helidon-groupBySelects how to group operations into APIs
                                        tags
                                        Use the 'tags' settings on each operation
                                        first-path-segment
                                        Use the first segment of the path
                                        		tags
                                        x-helidon-useOptionalWrap optional parameters in an Optional (Helidon 4 and later)true

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        - + \ No newline at end of file diff --git a/docs/generators/java-inflector/index.html b/docs/generators/java-inflector/index.html index 653923efa28..4ae7ab5301e 100644 --- a/docs/generators/java-inflector/index.html +++ b/docs/generators/java-inflector/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-inflector Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-inflectorpass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java Inflector Server application.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.controllers
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-inflector-server
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		legacy
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.controllers
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/gen/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/java-micronaut-client/index.html b/docs/generators/java-micronaut-client/index.html index 37065781477..a59324a6025 100644 --- a/docs/generators/java-micronaut-client/index.html +++ b/docs/generators/java-micronaut-client/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-micronaut-client Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-micronaut-clientpass this to the generate command after -g
                                        generator stabilityBETA
                                        generator typeCLIENT
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java Micronaut Client.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalClientTypeAnnotationsAdditional annotations for client type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.api
                                        applicationNameMicronaut application name (Defaults to the artifactId value)openapi-micronaut-client
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-micronaut-client
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        authorizationFilterPatternConfigure the authorization filter pattern for the client. Generally defined when generating clients from multiple specification filesnull
                                        basePathSeparatorConfigure the separator to use between the application name and base path when referencing the property-
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        buildSpecify for which build tool to generate files
                                        gradle
                                        Gradle configuration is generated for the project
                                        all
                                        Both Gradle and Maven configurations are generated
                                        maven
                                        Maven configuration is generated for the project
                                        		all
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        clientIdConfigure the service ID for the Clientnull
                                        configureAuthConfigure all the authorization methods as specified in the filefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateFormatSpecify the format pattern of date as a stringnull
                                        dateLibraryOption. Date library to use
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		java8
                                        datetimeFormatSpecify the format pattern of date-time as a stringnull
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        generateOperationOnlyForFirstTagWhen false, the operation method will be duplicated in each of the tags if multiple tags are assigned to this operation. If true, each operation will be generated only once in the first assigned tag.false
                                        generateSwaggerAnnotationsSpecify if you want to generate swagger annotations and which version
                                        swagger2
                                        Use io.swagger.core.v3:swagger-annotations for annotating operations and schemas
                                        true
                                        Equivalent to "swagger2"
                                        false
                                        Do not generate swagger annotations
                                        swagger1
                                        Use io.swagger:swagger-annotations for annotating operations and schemas
                                        		false
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        micronautVersionMicronaut version, only >=3.0.0 versions are supported3.4.3
                                        modelPackagepackage for generated modelsorg.openapitools.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        reactiveMake the responses use Reactor Mono as wrappertrue
                                        requiredPropertiesInConstructorAllow only to create models with all the required properties provided in constructortrue
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serializationLibrarySerialization library for model
                                        jackson
                                        Jackson as serialization library
                                        micronaut_serde_jackson
                                        Use micronaut-serialization with Jackson annotations
                                        		jackson
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/main/java
                                        testSpecify which test tool to generate files for
                                        junit
                                        Use JUnit as test tool
                                        spock
                                        Use Spock as test tool
                                        		junit
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        titleClient service namenull
                                        useBeanValidationUse BeanValidation API annotationstrue
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        useOptionalUse Optional container for optional parametersfalse
                                        visitableGenerate visitor for subtypes with a discriminatorfalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false
                                        wrapInHttpResponseWrap the response in HttpResponse objectfalse

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • application
                                        • assert
                                        • authorization
                                        • body
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • client
                                        • configuration
                                        • const
                                        • continue
                                        • cookie
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • format
                                        • goto
                                        • header
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • pathvariable
                                        • private
                                        • protected
                                        • public
                                        • queryparam
                                        • queryvalue
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✓OAS3
                                        BearerToken✗OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✓OAS2,OAS3
                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                        OAuth2_AuthorizationCode✓OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/java-micronaut-server/index.html b/docs/generators/java-micronaut-server/index.html index 2da3c0194bf..2b8defc0452 100644 --- a/docs/generators/java-micronaut-server/index.html +++ b/docs/generators/java-micronaut-server/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-micronaut-server Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-micronaut-serverpass this to the generate command after -g
                                        generator stabilityBETA
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java Micronaut Server.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        applicationNameMicronaut application name (Defaults to the artifactId value)openapi-micronaut
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-micronaut
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        buildSpecify for which build tool to generate files
                                        gradle
                                        Gradle configuration is generated for the project
                                        all
                                        Both Gradle and Maven configurations are generated
                                        maven
                                        Maven configuration is generated for the project
                                        		all
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        controllerPackageThe package in which controllers will be generatedorg.openapitools.api
                                        dateFormatSpecify the format pattern of date as a stringnull
                                        dateLibraryOption. Date library to use
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		java8
                                        datetimeFormatSpecify the format pattern of date-time as a stringnull
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        generateControllerAsAbstractGenerate an abstract class for controller to be extended. (apiPackage is then used for the abstract class, and controllerPackage is used for implementation that extends it.)false
                                        generateControllerFromExamplesGenerate the implementation of controller and tests from parameter and return examples that will verify that the api works as desired (for testing)false
                                        generateOperationOnlyForFirstTagWhen false, the operation method will be duplicated in each of the tags if multiple tags are assigned to this operation. If true, each operation will be generated only once in the first assigned tag.true
                                        generateOperationsToReturnNotImplementedReturn HTTP 501 Not Implemented instead of an empty response in the generated controller methods.true
                                        generateSwaggerAnnotationsSpecify if you want to generate swagger annotations and which version
                                        swagger2
                                        Use io.swagger.core.v3:swagger-annotations for annotating operations and schemas
                                        true
                                        Equivalent to "swagger2"
                                        false
                                        Do not generate swagger annotations
                                        swagger1
                                        Use io.swagger:swagger-annotations for annotating operations and schemas
                                        		swagger2
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        micronautVersionMicronaut version, only >=3.0.0 versions are supported3.4.3
                                        modelPackagepackage for generated modelsorg.openapitools.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        reactiveMake the responses use Reactor Mono as wrappertrue
                                        requiredPropertiesInConstructorAllow only to create models with all the required properties provided in constructortrue
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serializationLibrarySerialization library for model
                                        jackson
                                        Jackson as serialization library
                                        micronaut_serde_jackson
                                        Use micronaut-serialization with Jackson annotations
                                        		jackson
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/main/java
                                        testSpecify which test tool to generate files for
                                        junit
                                        Use JUnit as test tool
                                        spock
                                        Use Spock as test tool
                                        		junit
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        titleClient service namenull
                                        useAuthWhether to import authorization and to annotate controller methods accordinglytrue
                                        useBeanValidationUse BeanValidation API annotationstrue
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        useOptionalUse Optional container for optional parametersfalse
                                        visitableGenerate visitor for subtypes with a discriminatorfalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false
                                        wrapInHttpResponseWrap the response in HttpResponse objectfalse

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        CompletedFileUploadio.micronaut.http.multipart.CompletedFileUpload
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • application
                                        • assert
                                        • authorization
                                        • body
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • client
                                        • configuration
                                        • const
                                        • continue
                                        • cookie
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • format
                                        • goto
                                        • header
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • pathvariable
                                        • private
                                        • protected
                                        • public
                                        • queryparam
                                        • queryvalue
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✓OAS3
                                        BearerToken✗OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✓OAS2,OAS3
                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                        OAuth2_AuthorizationCode✓OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/java-microprofile/index.html b/docs/generators/java-microprofile/index.html index 56d72a6dec0..6093e1b8fd8 100644 --- a/docs/generators/java-microprofile/index.html +++ b/docs/generators/java-microprofile/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-microprofile Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-microprofilepass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a microprofile server.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        annotationLibrarySelect the complementary documentation annotation library.
                                        none
                                        Do not annotate Model and Api with complementary annotations.
                                        swagger1
                                        Annotate Model and Api using the Swagger Annotations 1.x library.
                                        swagger2
                                        Annotate Model and Api using the Swagger Annotations 2.x library.
                                        		none
                                        apiPackagepackage for generated api classesorg.openapitools.client.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-client
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        asyncNativeIf true, async handlers will be used, instead of the sync versionfalse
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        caseInsensitiveResponseHeadersMake API response's headers case-insensitive. Available on okhttp-gson, jersey2 librariesfalse
                                        configKeyConfig key in @RegisterRestClient. Default to none. Only microprofile supports this option.null
                                        configKeyFromClassNameIf true, set tag as key in @RegisterRestClient. Default to false. Only microprofile supports this option.null
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		java8
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        documentationProviderSelect the OpenAPI documentation provider.
                                        none
                                        Do not publish an OpenAPI specification.
                                        source
                                        Publish the original input OpenAPI specification.
                                        		source
                                        dynamicOperationsGenerate operations dynamically at runtime from an OASfalse
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        errorObjectTypeError Object type. (This option is for okhttp-gson only)null
                                        failOnUnknownPropertiesFail Jackson de-serialization on unknown propertiesfalse
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateClientAsBeanFor resttemplate, configure whether to create ApiClient.java and Apis clients as bean (with @Component annotation).false
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        gradlePropertiesAppend additional Gradle properties to the gradle.properties filenull
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.client
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        librarylibrary template (sub-template) to use
                                        jersey2
                                        HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.17.1
                                        jersey3
                                        HTTP client: Jersey client 3.1.1. JSON processing: Jackson 2.17.1
                                        feign
                                        HTTP client: OpenFeign 13.2.1. JSON processing: Jackson 2.17.1 or Gson 2.10.1
                                        okhttp-gson
                                        [DEFAULT] HTTP client: OkHttp 4.11.0. JSON processing: Gson 2.10.1. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
                                        retrofit2
                                        HTTP client: OkHttp 4.11.0. JSON processing: Gson 2.10.1 (Retrofit 2.5.0) or Jackson 2.17.1. Enable the RxJava adapter using '-DuseRxJava[2/3]=true'. (RxJava 1.x or 2.x or 3.x)
                                        resttemplate
                                        HTTP client: Spring RestTemplate 5.3.33 (6.1.5 if useJakartaEe=true). JSON processing: Jackson 2.17.1
                                        webclient
                                        HTTP client: Spring WebClient 5.1.18. JSON processing: Jackson 2.17.1
                                        restclient
                                        HTTP client: Spring RestClient 6.1.6. JSON processing: Jackson 2.17.1
                                        resteasy
                                        HTTP client: Resteasy client 4.7.6. JSON processing: Jackson 2.17.1
                                        vertx
                                        HTTP client: VertX client 3.5.2. JSON processing: Jackson 2.17.1
                                        google-api-client
                                        HTTP client: Google API client 2.2.0. JSON processing: Jackson 2.17.1
                                        rest-assured
                                        HTTP client: rest-assured 5.3.2. JSON processing: Gson 2.10.1 or Jackson 2.17.1. Only for Java 8
                                        native
                                        HTTP client: Java native HttpClient. JSON processing: Jackson 2.17.1. Only for Java11+
                                        microprofile
                                        HTTP client: Microprofile client 2.0 (default, set desired version via microprofileRestClientVersion=x.x.x). JSON processing: JSON-B 1.0.2 or Jackson 2.17.1
                                        apache-httpclient
                                        HTTP client: Apache httpclient 5.2.1. JSON processing: Jackson 2.17.1
                                        		okhttp-gson
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        microprofileFrameworkFramework for microprofile. Possible values "kumuluzee"null
                                        microprofileMutinyWhether to use async types for microprofile (currently only Smallrye Mutiny is supported).null
                                        microprofileRestClientVersionVersion of MicroProfile Rest Client API.null
                                        modelPackagepackage for generated modelsorg.openapitools.client.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parcelableModelWhether to generate models for Android that implement Parcelable with the okhttp-gson library.false
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        performBeanValidationPerform BeanValidationfalse
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serializationLibrarySerialization library, default depends on value of the option library
                                        jsonb
                                        Use JSON-B as serialization library
                                        jackson
                                        Use Jackson as serialization library
                                        gson
                                        Use Gson as serialization library
                                        		null
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/main/java
                                        supportStreamingSupport streaming endpoint (beta)false
                                        supportUrlQueryGenerate toUrlQueryString in POJO (default to true). Available on native, apache-httpclient libraries.false
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        useAbstractionForFilesUse alternative types instead of java.io.File to allow passing bytes without a file on disk. Available on resttemplate, webclient, restclient, librariesfalse
                                        useBeanValidationUse BeanValidation API annotationsfalse
                                        useEnumCaseInsensitiveUse equalsIgnoreCase when String for enum comparisonfalse
                                        useGzipFeatureSend gzip-encoded requestsfalse
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfDiscriminatorLookupUse the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped. Only jersey2, jersey3, native, okhttp-gson support this option.false
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        usePlayWSUse Play! Async HTTP client (Play WS API)false
                                        useReflectionEqualsHashCodeUse org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.false
                                        useRuntimeExceptionUse RuntimeException instead of Exception. Only jersey2, jersey3, okhttp-gson, vertx, microprofile support this option.false
                                        useRxJava2Whether to use the RxJava2 adapter with the retrofit2 library. IMPORTANT: This option has been deprecated.false
                                        useRxJava3Whether to use the RxJava3 adapter with the retrofit2 library. IMPORTANT: This option has been deprecated.false
                                        useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter. ONLY jersey2, jersey3, okhttp-gson, microprofile, Spring RestClient support this option.false
                                        webclientBlockingOperationsMaking all WebClient operations blocking(sync). Note that if on operation 'x-webclient-blocking: false' then such operation won't be syncfalse
                                        withAWSV4Signaturewhether to include AWS v4 signature support (only available for okhttp-gson library)false
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull
                                        x-webclient-blockingSpecifies if method for specific operation should be blocking or non-blocking(ex: return Mono<T>/Flux<T> or return T/List<T>/Set<T> & execute .block() inside generated method)OPERATIONfalse

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✓OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✓OAS2,OAS3
                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                        OAuth2_AuthorizationCode✓OAS2,OAS3
                                        SignatureAuth✓OAS3
                                        AWSV4Signature✓ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        - + \ No newline at end of file diff --git a/docs/generators/java-msf4j/index.html b/docs/generators/java-msf4j/index.html index bc8e3caace0..132e96af762 100644 --- a/docs/generators/java-msf4j/index.html +++ b/docs/generators/java-msf4j/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-msf4j Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-msf4jpass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java Micro Service based on WSO2 Microservices Framework for Java (MSF4J)

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-server
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		legacy
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implFolderfolder for generated implementation codesrc/main/java
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.api
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        librarylibrary template (sub-template)
                                        jersey2
                                        Jersey core 2.x
                                        		jersey2
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serverPortThe port on which the server should be started8080
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/gen/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        titlea title describing the applicationOpenAPI Server
                                        useBeanValidationUse BeanValidation API annotationstrue
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        useTagsuse tags for creating interface and controller classnamesfalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/java-pkmst/index.html b/docs/generators/java-pkmst/index.html index 1dd0108a59f..0816861efd0 100644 --- a/docs/generators/java-pkmst/index.html +++ b/docs/generators/java-pkmst/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-pkmst Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-pkmstpass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a PKMST SpringBoot Server application using the SpringFox integration. Also enables EurekaServerClient / Zipkin / Spring-Boot admin

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classescom.prokarma.pkmst.controller
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamepkmst-microservice
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        basePackagebase package for java source codenull
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		java8
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        eurekaUriEureka URInull
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        groupIdgroupId in generated pom.xmlcom.prokarma
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codecom.prokarma.pkmst.controller
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelscom.prokarma.pkmst.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        pkmstInterceptorPKMST Interceptornull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serviceNameService Namenull
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/main/java
                                        springBootAdminUriSpring-Boot URInull
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        titleserver title name or client service namenull
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false
                                        zipkinUriZipkin URInull

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/java-play-framework/index.html b/docs/generators/java-play-framework/index.html index 0ce68fc0e8f..256331596d9 100644 --- a/docs/generators/java-play-framework/index.html +++ b/docs/generators/java-play-framework/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-play-framework Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-play-frameworkpass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java Play Framework Server application.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classescontrollers
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-playframework
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        basePackagebase package for generated codeorg.openapitools
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        configPackageconfiguration package for generated codeorg.openapitools.configuration
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        controllerOnlyWhether to generate only API interface stubs without the server files.false
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		java8
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        handleExceptionsAdd a 'throw exception' to each controller function. Add also a custom error handler where you can put your custom logictrue
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.api
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsapimodels
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated code/app
                                        supportAsyncSupport Async operationsfalse
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        titleserver title name or client service nameopenapi-java-playframework
                                        useBeanValidationUse BeanValidation API annotationstrue
                                        useInterfacesMakes the controllerImp implements an interface to facilitate automatic completion when updating from version x to y of your spectrue
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        useSwaggerUIAdd a route to /api which show your documentation in swagger-ui. Will also import needed dependenciestrue
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false
                                        wrapCallsAdd a wrapper to each controller function to handle things like metrics, response modification, etc..true

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/java-undertow-server/index.html b/docs/generators/java-undertow-server/index.html index a14e0d2a258..4794e6cfa37 100644 --- a/docs/generators/java-undertow-server/index.html +++ b/docs/generators/java-undertow-server/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-undertow-server Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-undertow-serverpass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java Undertow Server application (beta).

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesnull
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-undertow-server
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		legacy
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.handler
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsnull
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/main/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/java-vertx-web/index.html b/docs/generators/java-vertx-web/index.html index 9255e2802ce..c7403696799 100644 --- a/docs/generators/java-vertx-web/index.html +++ b/docs/generators/java-vertx-web/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-vertx-web Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-vertx-webpass this to the generate command after -g
                                        generator stabilityBETA
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java Vert.x-Web Server (beta).

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.vertxweb.server.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-vertx-web-server
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0-SNAPSHOT
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		java8
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.vertxweb.server
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.vertxweb.server.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/main/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/java-vertx/index.html b/docs/generators/java-vertx/index.html index 9b98baff850..2633f1d6cd6 100644 --- a/docs/generators/java-vertx/index.html +++ b/docs/generators/java-vertx/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-vertx Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-vertxpass this to the generate command after -g
                                        generator stabilityDEPRECATED
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a java-Vert.X Server library.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.server.api.verticle
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-vertx-server
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0-SNAPSHOT
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		java8
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.server.api.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        rxInterfaceWhen specified, API interfaces are generated with RX and methods return Single<> and Comparable.false
                                        rxVersion2When specified in combination with rxInterface, API interfaces are generated with RxJava2.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/main/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        vertxSwaggerRouterVersionSpecify the version of the swagger router librarynull
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/java-wiremock/index.html b/docs/generators/java-wiremock/index.html index 1403ce464b2..29809113530 100644 --- a/docs/generators/java-wiremock/index.html +++ b/docs/generators/java-wiremock/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java-wiremock Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejava-wiremockpass this to the generate command after -g
                                        generator stabilityBETA
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates Java WireMock stubs, requests and responses samples.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesnull
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		java8
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsnull
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/main/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/java/index.html b/docs/generators/java/index.html index 8a247ce015e..68916a4ba97 100644 --- a/docs/generators/java/index.html +++ b/docs/generators/java/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the java Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejavapass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeCLIENT
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java client library (HTTP lib: Jersey (1.x, 2.x), Retrofit (2.x), OpenFeign (10.x) and more.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        annotationLibrarySelect the complementary documentation annotation library.
                                        none
                                        Do not annotate Model and Api with complementary annotations.
                                        swagger1
                                        Annotate Model and Api using the Swagger Annotations 1.x library.
                                        swagger2
                                        Annotate Model and Api using the Swagger Annotations 2.x library.
                                        		none
                                        apiPackagepackage for generated api classesorg.openapitools.client.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-client
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        asyncNativeIf true, async handlers will be used, instead of the sync versionfalse
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        caseInsensitiveResponseHeadersMake API response's headers case-insensitive. Available on okhttp-gson, jersey2 librariesfalse
                                        configKeyConfig key in @RegisterRestClient. Default to none. Only microprofile supports this option.null
                                        configKeyFromClassNameIf true, set tag as key in @RegisterRestClient. Default to false. Only microprofile supports this option.null
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		java8
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        documentationProviderSelect the OpenAPI documentation provider.
                                        none
                                        Do not publish an OpenAPI specification.
                                        source
                                        Publish the original input OpenAPI specification.
                                        		source
                                        dynamicOperationsGenerate operations dynamically at runtime from an OASfalse
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        errorObjectTypeError Object type. (This option is for okhttp-gson only)null
                                        failOnUnknownPropertiesFail Jackson de-serialization on unknown propertiesfalse
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateClientAsBeanFor resttemplate, configure whether to create ApiClient.java and Apis clients as bean (with @Component annotation).false
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        gradlePropertiesAppend additional Gradle properties to the gradle.properties filenull
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.client
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        librarylibrary template (sub-template) to use
                                        jersey2
                                        HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.17.1
                                        jersey3
                                        HTTP client: Jersey client 3.1.1. JSON processing: Jackson 2.17.1
                                        feign
                                        HTTP client: OpenFeign 13.2.1. JSON processing: Jackson 2.17.1 or Gson 2.10.1
                                        okhttp-gson
                                        [DEFAULT] HTTP client: OkHttp 4.11.0. JSON processing: Gson 2.10.1. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
                                        retrofit2
                                        HTTP client: OkHttp 4.11.0. JSON processing: Gson 2.10.1 (Retrofit 2.5.0) or Jackson 2.17.1. Enable the RxJava adapter using '-DuseRxJava[2/3]=true'. (RxJava 1.x or 2.x or 3.x)
                                        resttemplate
                                        HTTP client: Spring RestTemplate 5.3.33 (6.1.5 if useJakartaEe=true). JSON processing: Jackson 2.17.1
                                        webclient
                                        HTTP client: Spring WebClient 5.1.18. JSON processing: Jackson 2.17.1
                                        restclient
                                        HTTP client: Spring RestClient 6.1.6. JSON processing: Jackson 2.17.1
                                        resteasy
                                        HTTP client: Resteasy client 4.7.6. JSON processing: Jackson 2.17.1
                                        vertx
                                        HTTP client: VertX client 3.5.2. JSON processing: Jackson 2.17.1
                                        google-api-client
                                        HTTP client: Google API client 2.2.0. JSON processing: Jackson 2.17.1
                                        rest-assured
                                        HTTP client: rest-assured 5.3.2. JSON processing: Gson 2.10.1 or Jackson 2.17.1. Only for Java 8
                                        native
                                        HTTP client: Java native HttpClient. JSON processing: Jackson 2.17.1. Only for Java11+
                                        microprofile
                                        HTTP client: Microprofile client 2.0 (default, set desired version via microprofileRestClientVersion=x.x.x). JSON processing: JSON-B 1.0.2 or Jackson 2.17.1
                                        apache-httpclient
                                        HTTP client: Apache httpclient 5.2.1. JSON processing: Jackson 2.17.1
                                        		okhttp-gson
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        microprofileFrameworkFramework for microprofile. Possible values "kumuluzee"null
                                        microprofileMutinyWhether to use async types for microprofile (currently only Smallrye Mutiny is supported).null
                                        microprofileRestClientVersionVersion of MicroProfile Rest Client API.null
                                        modelPackagepackage for generated modelsorg.openapitools.client.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parcelableModelWhether to generate models for Android that implement Parcelable with the okhttp-gson library.false
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        performBeanValidationPerform BeanValidationfalse
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serializationLibrarySerialization library, default depends on value of the option library
                                        jsonb
                                        Use JSON-B as serialization library
                                        jackson
                                        Use Jackson as serialization library
                                        gson
                                        Use Gson as serialization library
                                        		null
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/main/java
                                        supportStreamingSupport streaming endpoint (beta)false
                                        supportUrlQueryGenerate toUrlQueryString in POJO (default to true). Available on native, apache-httpclient libraries.false
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        useAbstractionForFilesUse alternative types instead of java.io.File to allow passing bytes without a file on disk. Available on resttemplate, webclient, restclient, librariesfalse
                                        useBeanValidationUse BeanValidation API annotationsfalse
                                        useEnumCaseInsensitiveUse equalsIgnoreCase when String for enum comparisonfalse
                                        useGzipFeatureSend gzip-encoded requestsfalse
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfDiscriminatorLookupUse the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped. Only jersey2, jersey3, native, okhttp-gson support this option.false
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        usePlayWSUse Play! Async HTTP client (Play WS API)false
                                        useReflectionEqualsHashCodeUse org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.false
                                        useRuntimeExceptionUse RuntimeException instead of Exception. Only jersey2, jersey3, okhttp-gson, vertx, microprofile support this option.false
                                        useRxJava2Whether to use the RxJava2 adapter with the retrofit2 library. IMPORTANT: This option has been deprecated.false
                                        useRxJava3Whether to use the RxJava3 adapter with the retrofit2 library. IMPORTANT: This option has been deprecated.false
                                        useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter. ONLY jersey2, jersey3, okhttp-gson, microprofile, Spring RestClient support this option.false
                                        webclientBlockingOperationsMaking all WebClient operations blocking(sync). Note that if on operation 'x-webclient-blocking: false' then such operation won't be syncfalse
                                        withAWSV4Signaturewhether to include AWS v4 signature support (only available for okhttp-gson library)false
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull
                                        x-webclient-blockingSpecifies if method for specific operation should be blocking or non-blocking(ex: return Mono<T>/Flux<T> or return T/List<T>/Set<T> & execute .block() inside generated method)OPERATIONfalse

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✓OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✓OAS2,OAS3
                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                        OAuth2_AuthorizationCode✓OAS2,OAS3
                                        SignatureAuth✓OAS3
                                        AWSV4Signature✓ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        - + \ No newline at end of file diff --git a/docs/generators/javascript-apollo-deprecated/index.html b/docs/generators/javascript-apollo-deprecated/index.html index b8b8f9a03fd..3c3db6004c5 100644 --- a/docs/generators/javascript-apollo-deprecated/index.html +++ b/docs/generators/javascript-apollo-deprecated/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the javascript-apollo-deprecated Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejavascript-apollo-deprecatedpass this to the generate command after -g
                                        generator stabilityDEPRECATED
                                        generator typeCLIENT
                                        generator languageJavascript
                                        generator default templating enginemustache
                                        helpTxtGenerates a JavaScript client library (beta) using Apollo RESTDatasource.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesnull
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        emitJSDocgenerate JSDoc commentstrue
                                        emitModelMethodsgenerate getters and setters for model propertiesfalse
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                        invokerPackageroot package for generated codenull
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNamename of the license the project uses (Default: using info.license.name)null
                                        modelPackagepackage for generated modelsnull
                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                        moduleNamemodule name for AMD, Node or globals (Default: generated from <projectName>)null
                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        projectDescriptiondescription of the project (Default: using info.description or "Client library of <projectName>")null
                                        projectNamename of the project (Default: generated from info.title or "openapi-js-client")null
                                        projectVersionversion of the project (Default: using info.version or "1.0.0")null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc
                                        useInheritanceuse JavaScript prototype chains & delegation for inheritancetrue
                                        usePromisesuse Promises as return values from the client API, instead of superagent callbacksfalse

                                        IMPORT MAPPING​

                                        Type/AliasImports

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArray
                                        listArray
                                        mapObject
                                        setArray

                                        LANGUAGE PRIMITIVES​

                                        • Array
                                        • Blob
                                        • Boolean
                                        • Date
                                        • File
                                        • Number
                                        • Object
                                        • String

                                        RESERVED WORDS​

                                        • Array
                                        • Date
                                        • Infinity
                                        • Math
                                        • NaN
                                        • Number
                                        • Object
                                        • String
                                        • abstract
                                        • arguments
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • const
                                        • continue
                                        • debugger
                                        • default
                                        • delete
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • eval
                                        • export
                                        • extends
                                        • false
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • function
                                        • goto
                                        • hasOwnProperty
                                        • if
                                        • implements
                                        • import
                                        • in
                                        • instanceof
                                        • int
                                        • interface
                                        • isFinite
                                        • isNaN
                                        • isPrototypeOf
                                        • let
                                        • long
                                        • native
                                        • new
                                        • null
                                        • package
                                        • private
                                        • protected
                                        • prototype
                                        • public
                                        • return
                                        • short
                                        • static
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • toString
                                        • transient
                                        • true
                                        • try
                                        • typeof
                                        • undefined
                                        • valueOf
                                        • var
                                        • void
                                        • volatile
                                        • while
                                        • with
                                        • yield

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✗ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✓OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✓OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✓OAS2,OAS3
                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                        OAuth2_AuthorizationCode✓OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        - + \ No newline at end of file diff --git a/docs/generators/javascript-apollo/index.html b/docs/generators/javascript-apollo/index.html index 1ca2dd5be6a..2a27ac7b31a 100644 --- a/docs/generators/javascript-apollo/index.html +++ b/docs/generators/javascript-apollo/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the javascript-apollo Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejavascript-apollopass this to the generate command after -g
                                        generator stabilityDEPRECATED
                                        generator typeCLIENT
                                        generator languageJavascript
                                        generator default templating enginemustache
                                        helpTxtGenerates a JavaScript client library (beta) using Apollo RESTDatasource.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesnull
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        emitJSDocgenerate JSDoc commentstrue
                                        emitModelMethodsgenerate getters and setters for model propertiesfalse
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                        invokerPackageroot package for generated codenull
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C#have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNamename of the license the project uses (Default: using info.license.name)null
                                        modelPackagepackage for generated modelsnull
                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                        moduleNamemodule name for AMD, Node or globals (Default: generated from <projectName>)null
                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        projectDescriptiondescription of the project (Default: using info.description or "Client library of <projectName>")null
                                        projectNamename of the project (Default: generated from info.title or "openapi-js-client")null
                                        projectVersionversion of the project (Default: using info.version or "1.0.0")null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc
                                        useInheritanceuse JavaScript prototype chains & delegation for inheritancetrue
                                        usePromisesuse Promises as return values from the client API, instead of superagent callbacksfalse

                                        IMPORT MAPPING​

                                        Type/AliasImports

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArray
                                        listArray
                                        mapObject
                                        setArray

                                        LANGUAGE PRIMITIVES​

                                        • Array
                                        • Blob
                                        • Boolean
                                        • Date
                                        • File
                                        • Number
                                        • Object
                                        • String

                                        RESERVED WORDS​

                                        • Array
                                        • Date
                                        • Infinity
                                        • Math
                                        • NaN
                                        • Number
                                        • Object
                                        • String
                                        • abstract
                                        • arguments
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • const
                                        • continue
                                        • debugger
                                        • default
                                        • delete
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • eval
                                        • export
                                        • extends
                                        • false
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • function
                                        • goto
                                        • hasOwnProperty
                                        • if
                                        • implements
                                        • import
                                        • in
                                        • instanceof
                                        • int
                                        • interface
                                        • isFinite
                                        • isNaN
                                        • isPrototypeOf
                                        • let
                                        • long
                                        • native
                                        • new
                                        • null
                                        • package
                                        • private
                                        • protected
                                        • prototype
                                        • public
                                        • return
                                        • short
                                        • static
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • toString
                                        • transient
                                        • true
                                        • try
                                        • typeof
                                        • undefined
                                        • valueOf
                                        • var
                                        • void
                                        • volatile
                                        • while
                                        • with
                                        • yield

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✗ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✓OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✓OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✓OAS2,OAS3
                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                        OAuth2_AuthorizationCode✓OAS2,OAS3
                                        SignatureAuth✗OAS3

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        - + \ No newline at end of file diff --git a/docs/generators/javascript-closure-angular/index.html b/docs/generators/javascript-closure-angular/index.html index e6217e9793b..d009bd84215 100644 --- a/docs/generators/javascript-closure-angular/index.html +++ b/docs/generators/javascript-closure-angular/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the javascript-closure-angular Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejavascript-closure-angularpass this to the generate command after -g
                                        generator stabilityBETA
                                        generator typeCLIENT
                                        generator languageJavascript
                                        generator default templating enginemustache
                                        helpTxtGenerates a Javascript AngularJS client library annotated with Google Closure Compiler annotations(https://developers.google.com/closure/compiler/docs/js-for-compiler?hl=en)

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        useEs6use ES6 templatesfalse

                                        IMPORT MAPPING​

                                        Type/AliasImports

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArray

                                        LANGUAGE PRIMITIVES​

                                        • Blob
                                        • Date
                                        • Object
                                        • boolean
                                        • number
                                        • string

                                        RESERVED WORDS​

                                        • abstract
                                        • assert
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • final
                                        • finally
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • new
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✗ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✗ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✓OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✓OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✓OAS2,OAS3
                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                        OAuth2_AuthorizationCode✓OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✗OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        - + \ No newline at end of file diff --git a/docs/generators/javascript-flowtyped/index.html b/docs/generators/javascript-flowtyped/index.html index c8d467b7671..394a22bfb62 100644 --- a/docs/generators/javascript-flowtyped/index.html +++ b/docs/generators/javascript-flowtyped/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the javascript-flowtyped Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejavascript-flowtypedpass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeCLIENT
                                        generator languageJavascript
                                        generator default templating enginemustache
                                        helpTxtGenerates a Javascript client library (beta) using Flow types and Fetch API.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumNameSuffixSuffix that will be appended to all enum names.Enum
                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                        enumPropertyNamingReplaceSpecialCharSet to true to replace '-' and '+' symbols with 'minus' and 'plus' in enum of type stringfalse
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name. Only change it if you provide your own run-time code for (de-)serialization of modelsoriginal
                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                        paramNamingNaming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        supportsES6Generate code that conforms to ES6.false

                                        IMPORT MAPPING​

                                        Type/AliasImports

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArray
                                        listArray
                                        mapObject

                                        LANGUAGE PRIMITIVES​

                                        • Array
                                        • Blob
                                        • Date
                                        • File
                                        • Object
                                        • boolean
                                        • number
                                        • string

                                        RESERVED WORDS​

                                        • abstract
                                        • arguments
                                        • array
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • const
                                        • continue
                                        • date
                                        • debugger
                                        • default
                                        • delete
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • eval
                                        • export
                                        • extends
                                        • false
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • formparams
                                        • function
                                        • goto
                                        • hasownproperty
                                        • headerparams
                                        • if
                                        • implements
                                        • import
                                        • in
                                        • infinity
                                        • instanceof
                                        • int
                                        • interface
                                        • isfinite
                                        • isnan
                                        • isprototypeof
                                        • let
                                        • long
                                        • math
                                        • nan
                                        • native
                                        • new
                                        • null
                                        • number
                                        • object
                                        • package
                                        • private
                                        • protected
                                        • prototype
                                        • public
                                        • queryparameters
                                        • requestoptions
                                        • return
                                        • short
                                        • static
                                        • string
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • tostring
                                        • transient
                                        • true
                                        • try
                                        • typeof
                                        • undefined
                                        • useformdata
                                        • valueof
                                        • var
                                        • varlocaldeferred
                                        • varlocalpath
                                        • void
                                        • volatile
                                        • while
                                        • with
                                        • yield

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✓OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✗OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by David Riddervold Marconis
                                        - + \ No newline at end of file diff --git a/docs/generators/javascript/index.html b/docs/generators/javascript/index.html index 3761e42dbb7..114527e4b50 100644 --- a/docs/generators/javascript/index.html +++ b/docs/generators/javascript/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the javascript Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejavascriptpass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeCLIENT
                                        generator languageJavascript
                                        generator default templating enginemustache
                                        helpTxtGenerates a JavaScript client library.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesnull
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        emitJSDocgenerate JSDoc commentstrue
                                        emitModelMethodsgenerate getters and setters for model propertiesfalse
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                        invokerPackageroot package for generated codenull
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        librarylibrary template (sub-template)
                                        javascript
                                        JavaScript client library
                                        apollo
                                        Apollo REST DataSource
                                        		javascript
                                        licenseNamename of the license the project uses (Default: using info.license.name)null
                                        modelPackagepackage for generated modelsnull
                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                        moduleNamemodule name for AMD, Node or globals (Default: generated from <projectName>)null
                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        projectDescriptiondescription of the project (Default: using info.description or "Client library of <projectName>")null
                                        projectNamename of the project (Default: generated from info.title or "openapi-js-client")null
                                        projectVersionversion of the project (Default: using info.version or "1.0.0")null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc
                                        useInheritanceuse JavaScript prototype chains & delegation for inheritancetrue
                                        usePromisesuse Promises as return values from the client API, instead of superagent callbacksfalse
                                        useURLSearchParamsuse JS build-in UrlSearchParams, instead of deprecated npm lib 'querystring'true

                                        IMPORT MAPPING​

                                        Type/AliasImports

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArray
                                        listArray
                                        mapObject
                                        setArray

                                        LANGUAGE PRIMITIVES​

                                        • Array
                                        • Blob
                                        • Boolean
                                        • Date
                                        • File
                                        • Number
                                        • Object
                                        • String

                                        RESERVED WORDS​

                                        • Array
                                        • Date
                                        • Infinity
                                        • Math
                                        • NaN
                                        • Number
                                        • Object
                                        • String
                                        • abstract
                                        • arguments
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • const
                                        • continue
                                        • debugger
                                        • default
                                        • delete
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • eval
                                        • export
                                        • extends
                                        • false
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • function
                                        • goto
                                        • hasOwnProperty
                                        • if
                                        • implements
                                        • import
                                        • in
                                        • instanceof
                                        • int
                                        • interface
                                        • isFinite
                                        • isNaN
                                        • isPrototypeOf
                                        • let
                                        • long
                                        • native
                                        • new
                                        • null
                                        • package
                                        • private
                                        • protected
                                        • prototype
                                        • public
                                        • return
                                        • short
                                        • static
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • toString
                                        • transient
                                        • true
                                        • try
                                        • typeof
                                        • undefined
                                        • valueOf
                                        • var
                                        • void
                                        • volatile
                                        • while
                                        • with
                                        • yield

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✗ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✓OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✓OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✓OAS2,OAS3
                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                        OAuth2_AuthorizationCode✓OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        - + \ No newline at end of file diff --git a/docs/generators/jaxrs-cxf-cdi/index.html b/docs/generators/jaxrs-cxf-cdi/index.html index 705f0f9834c..d7c5f19d2a5 100644 --- a/docs/generators/jaxrs-cxf-cdi/index.html +++ b/docs/generators/jaxrs-cxf-cdi/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the jaxrs-cxf-cdi Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejaxrs-cxf-cdipass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java JAXRS Server according to JAXRS 2.0 specification, assuming an Apache CXF runtime and a Java EE runtime with CDI enabled.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-cxf-cdi-server
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		legacy
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        generatePomWhether to generate pom.xml if the file does not already exist.true
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implFolderfolder for generated implementation codesrc/main/java
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        interfaceOnlyWhether to generate only API interface stubs without the server files.false
                                        invokerPackageroot package for generated codeorg.openapitools.api
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        librarylibrary template (sub-template)
                                        <default>
                                        JAXRS spec only, to be deployed in an app server (TomEE, JBoss, WLS, ...)
                                        quarkus
                                        Server using Quarkus
                                        thorntail
                                        Server using Thorntail
                                        openliberty
                                        Server using Open Liberty
                                        helidon
                                        Server using Helidon
                                        kumuluzee
                                        Server using KumuluzEE
                                        		<default>
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        openApiSpecFileLocationLocation where the file containing the spec will be generated in the output folder. No file generated when set to null or empty string.null
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        returnResponseWhether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serverPortThe port on which the server should be started8080
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/gen/java
                                        supportAsyncWrap responses in CompletionStage type, allowing asynchronous computation (requires JAX-RS 2.1).false
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        titlea title describing the applicationOpenAPI Server
                                        useBeanValidationUse BeanValidation API annotationstrue
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useMicroProfileOpenAPIAnnotationsWhether to generate Microprofile OpenAPI annotations. Only valid when library is set to quarkus.false
                                        useMutinyWhether to use Smallrye Mutiny instead of CompletionStage for asynchronous computation. Only valid when library is set to quarkus.false
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        useSwaggerAnnotationsWhether to generate Swagger annotations.true
                                        useTagsuse tags for creating interface and controller classnamesfalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.LocalDate
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✓OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✓OAS2,OAS3
                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                        OAuth2_AuthorizationCode✓OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/jaxrs-cxf-client/index.html b/docs/generators/jaxrs-cxf-client/index.html index 3a66d75c691..682358120d9 100644 --- a/docs/generators/jaxrs-cxf-client/index.html +++ b/docs/generators/jaxrs-cxf-client/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the jaxrs-cxf-client Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejaxrs-cxf-clientpass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeCLIENT
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java JAXRS Client based on Apache CXF framework.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-client
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		legacy
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.api
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/gen/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        useAbstractionForFilesUse alternative types instead of java.io.File to allow passing bytes without a file on disk.false
                                        useBeanValidationUse BeanValidation API annotationsfalse
                                        useGenericResponseUse generic responsefalse
                                        useGzipFeatureForTestsUse Gzip Feature for testsfalse
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useLoggingFeatureForTestsUse Logging Feature for testsfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.LocalDate
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/jaxrs-cxf-extended/index.html b/docs/generators/jaxrs-cxf-extended/index.html index 37e3dc4313e..2269d603ec7 100644 --- a/docs/generators/jaxrs-cxf-extended/index.html +++ b/docs/generators/jaxrs-cxf-extended/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the jaxrs-cxf-extended Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejaxrs-cxf-extendedpass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtExtends jaxrs-cxf with options to generate a functional mock server.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        addConsumesProducesJsonAdd @Consumes/@Produces Json to API interfacefalse
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-cxf-server
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		legacy
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptorfalse
                                        generateNonSpringApplicationGenerate non-Spring applicationfalse
                                        generateOperationBodyGenerate fully functional operation bodiesfalse
                                        generateSpringApplicationGenerate Spring applicationfalse
                                        generateSpringBootApplicationGenerate Spring Boot applicationfalse
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implFolderfolder for generated implementation codesrc/main/java
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.api
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        loadTestDataFromFileLoad test data from a generated JSON filefalse
                                        modelPackagepackage for generated modelsorg.openapitools.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serverPortThe port on which the server should be started8080
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/gen/java
                                        supportMultipleSpringServicesSupport generation of Spring services from multiple specificationsfalse
                                        testDataControlFileJSON file to control test data generationnull
                                        testDataFileJSON file to contain generated test datanull
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        titlea title describing the applicationOpenAPI Server
                                        useAbstractionForFilesUse alternative types instead of java.io.File to allow passing bytes without a file on disk.false
                                        useAnnotatedBasePathUse @Path annotations for basePathfalse
                                        useBeanValidationUse BeanValidation API annotationstrue
                                        useBeanValidationFeatureUse BeanValidation Featurefalse
                                        useGenericResponseUse generic responsefalse
                                        useGzipFeatureUse Gzip Featurefalse
                                        useGzipFeatureForTestsUse Gzip Feature for testsfalse
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useLoggingFeatureUse Logging Featurefalse
                                        useLoggingFeatureForTestsUse Logging Feature for testsfalse
                                        useMultipartFeatureUse Multipart Featurefalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        useSpringAnnotationConfigUse Spring Annotation Configfalse
                                        useSwaggerFeatureUse Swagger Featurefalse
                                        useSwaggerUIUse Swagger UIfalse
                                        useTagsuse tags for creating interface and controller classnamestrue
                                        useWadlFeatureUse WADL Featurefalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.LocalDate
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/jaxrs-cxf/index.html b/docs/generators/jaxrs-cxf/index.html index 91760209229..51cb14ca497 100644 --- a/docs/generators/jaxrs-cxf/index.html +++ b/docs/generators/jaxrs-cxf/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the jaxrs-cxf Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejaxrs-cxfpass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java JAXRS Server application based on Apache CXF framework.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        addConsumesProducesJsonAdd @Consumes/@Produces Json to API interfacefalse
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-cxf-server
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		legacy
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptorfalse
                                        generateNonSpringApplicationGenerate non-Spring applicationfalse
                                        generateSpringApplicationGenerate Spring applicationfalse
                                        generateSpringBootApplicationGenerate Spring Boot applicationfalse
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implFolderfolder for generated implementation codesrc/main/java
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.api
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serverPortThe port on which the server should be started8080
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/gen/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        titlea title describing the applicationOpenAPI Server
                                        useAbstractionForFilesUse alternative types instead of java.io.File to allow passing bytes without a file on disk.false
                                        useAnnotatedBasePathUse @Path annotations for basePathfalse
                                        useBeanValidationUse BeanValidation API annotationstrue
                                        useBeanValidationFeatureUse BeanValidation Featurefalse
                                        useGenericResponseUse generic responsefalse
                                        useGzipFeatureUse Gzip Featurefalse
                                        useGzipFeatureForTestsUse Gzip Feature for testsfalse
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useLoggingFeatureUse Logging Featurefalse
                                        useLoggingFeatureForTestsUse Logging Feature for testsfalse
                                        useMultipartFeatureUse Multipart Featurefalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        useSpringAnnotationConfigUse Spring Annotation Configfalse
                                        useSwaggerFeatureUse Swagger Featurefalse
                                        useSwaggerUIUse Swagger UIfalse
                                        useTagsuse tags for creating interface and controller classnamestrue
                                        useWadlFeatureUse WADL Featurefalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.LocalDate
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/jaxrs-jersey/index.html b/docs/generators/jaxrs-jersey/index.html index d03af79730e..222cf0fa117 100644 --- a/docs/generators/jaxrs-jersey/index.html +++ b/docs/generators/jaxrs-jersey/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the jaxrs-jersey Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejaxrs-jerseypass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java JAXRS Server application based on Jersey framework.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-server
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		legacy
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implFolderfolder for generated implementation codesrc/main/java
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.api
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        librarylibrary template (sub-template)
                                        jersey2
                                        Jersey core 2.x
                                        jersey3
                                        Jersey core 3.x
                                        		jersey2
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serverPortThe port on which the server should be started8080
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/gen/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        titlea title describing the applicationOpenAPI Server
                                        useBeanValidationUse BeanValidation API annotationstrue
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        useTagsuse tags for creating interface and controller classnamesfalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/jaxrs-resteasy-eap/index.html b/docs/generators/jaxrs-resteasy-eap/index.html index ec16ae0c2f5..820b9488875 100644 --- a/docs/generators/jaxrs-resteasy-eap/index.html +++ b/docs/generators/jaxrs-resteasy-eap/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the jaxrs-resteasy-eap Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejaxrs-resteasy-eappass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java JAXRS-Resteasy Server application.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-resteasy-eap-server
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		legacy
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptortrue
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implFolderfolder for generated implementation codesrc/main/java
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.api
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serverPortThe port on which the server should be started8080
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/gen/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        titlea title describing the applicationOpenAPI Server
                                        useBeanValidationUse BeanValidation API annotationstrue
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        useSwaggerFeatureUse dynamic Swagger generatorfalse
                                        useTagsuse tags for creating interface and controller classnamesfalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/jaxrs-resteasy/index.html b/docs/generators/jaxrs-resteasy/index.html index 69695b4b773..c2d44cf08e7 100644 --- a/docs/generators/jaxrs-resteasy/index.html +++ b/docs/generators/jaxrs-resteasy/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the jaxrs-resteasy Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejaxrs-resteasypass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java JAXRS-Resteasy Server application.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-resteasy-server
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		legacy
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptorfalse
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implFolderfolder for generated implementation codesrc/main/java
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        invokerPackageroot package for generated codeorg.openapitools.api
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serverPortThe port on which the server should be started8080
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/gen/java
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        titlea title describing the applicationOpenAPI Server
                                        useBeanValidationUse BeanValidation API annotationstrue
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        useTagsuse tags for creating interface and controller classnamesfalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.*
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/jaxrs-spec/index.html b/docs/generators/jaxrs-spec/index.html index 1c91125f349..6e726789b79 100644 --- a/docs/generators/jaxrs-spec/index.html +++ b/docs/generators/jaxrs-spec/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the jaxrs-spec Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejaxrs-specpass this to the generate command after -g
                                        generator stabilitySTABLE
                                        generator typeSERVER
                                        generator languageJava
                                        generator default templating enginemustache
                                        helpTxtGenerates a Java JAXRS Server according to JAXRS 2.0 specification.

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        apiPackagepackage for generated api classesorg.openapitools.api
                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-server
                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                        booleanGetterPrefixSet booleanGetterPrefixget
                                        camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                        containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                        dateLibraryOption. Date library to use
                                        joda
                                        Joda (for legacy app only)
                                        legacy
                                        Legacy java.util.Date
                                        java8-localdatetime
                                        Java 8 using LocalDateTime (for legacy app only)
                                        java8
                                        Java 8 native JSR310 (preferred for jdk 1.8+)
                                        		legacy
                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                        disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        false
                                        The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                        true
                                        Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                        		true
                                        discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                        false
                                        No changes to the enum's are made, this is the default option.
                                        true
                                        With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                        		false
                                        generateBuildersWhether to generate builders for modelsfalse
                                        generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                        generatePomWhether to generate pom.xml if the file does not already exist.true
                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                        ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                        implFolderfolder for generated implementation codesrc/main/java
                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                        implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                        interfaceOnlyWhether to generate only API interface stubs without the server files.false
                                        invokerPackageroot package for generated codeorg.openapitools.api
                                        legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                        true
                                        The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                        false
                                        The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                        		true
                                        librarylibrary template (sub-template)
                                        <default>
                                        JAXRS spec only, to be deployed in an app server (TomEE, JBoss, WLS, ...)
                                        quarkus
                                        Server using Quarkus
                                        thorntail
                                        Server using Thorntail
                                        openliberty
                                        Server using Open Liberty
                                        helidon
                                        Server using Helidon
                                        kumuluzee
                                        Server using KumuluzEE
                                        		<default>
                                        licenseNameThe name of the licenseUnlicense
                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                        modelPackagepackage for generated modelsorg.openapitools.model
                                        openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                        openApiSpecFileLocationLocation where the file containing the spec will be generated in the output folder. No file generated when set to null or empty string.null
                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        returnResponseWhether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.false
                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                        serverPortThe port on which the server should be started8080
                                        snapshotVersionUses a SNAPSHOT version.
                                        true
                                        Use a SnapShot Version
                                        false
                                        Use a Release Version
                                        		null
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                        sourceFoldersource folder for generated codesrc/gen/java
                                        supportAsyncWrap responses in CompletionStage type, allowing asynchronous computation (requires JAX-RS 2.1).false
                                        testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                        titlea title describing the applicationOpenAPI Server
                                        useBeanValidationUse BeanValidation API annotationstrue
                                        useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                        useMicroProfileOpenAPIAnnotationsWhether to generate Microprofile OpenAPI annotations. Only valid when library is set to quarkus.false
                                        useMutinyWhether to use Smallrye Mutiny instead of CompletionStage for asynchronous computation. Only valid when library is set to quarkus.false
                                        useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                        useSwaggerAnnotationsWhether to generate Swagger annotations.true
                                        useTagsuse tags for creating interface and controller classnamesfalse
                                        withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                        SUPPORTED VENDOR EXTENSIONS​

                                        Extension nameDescriptionApplicable forDefault value
                                        x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                        x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                        x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                        x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                        x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                        x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                        x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                        x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                        IMPORT MAPPING​

                                        Type/AliasImports
                                        Arrayjava.util.List
                                        ArrayListjava.util.ArrayList
                                        BigDecimaljava.math.BigDecimal
                                        Datejava.util.Date
                                        DateTimeorg.joda.time.*
                                        Filejava.io.File
                                        HashMapjava.util.HashMap
                                        LinkedHashSetjava.util.LinkedHashSet
                                        Listjava.util.*
                                        LocalDateorg.joda.time.LocalDate
                                        LocalDateTimeorg.joda.time.*
                                        LocalTimeorg.joda.time.*
                                        Mapjava.util.Map
                                        Setjava.util.*
                                        Timestampjava.sql.Timestamp
                                        URIjava.net.URI
                                        UUIDjava.util.UUID

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By
                                        arrayArrayList
                                        mapHashMap
                                        setLinkedHashSet

                                        LANGUAGE PRIMITIVES​

                                        • Boolean
                                        • Double
                                        • Float
                                        • Integer
                                        • Long
                                        • Object
                                        • String
                                        • boolean
                                        • byte[]

                                        RESERVED WORDS​

                                        • _
                                        • abstract
                                        • apiclient
                                        • apiexception
                                        • apiresponse
                                        • assert
                                        • boolean
                                        • break
                                        • byte
                                        • case
                                        • catch
                                        • char
                                        • class
                                        • configuration
                                        • const
                                        • continue
                                        • default
                                        • do
                                        • double
                                        • else
                                        • enum
                                        • extends
                                        • file
                                        • final
                                        • finally
                                        • float
                                        • for
                                        • goto
                                        • if
                                        • implements
                                        • import
                                        • instanceof
                                        • int
                                        • interface
                                        • list
                                        • localdate
                                        • localreturntype
                                        • localtime
                                        • localvaraccept
                                        • localvaraccepts
                                        • localvarauthnames
                                        • localvarcollectionqueryparams
                                        • localvarcontenttype
                                        • localvarcontenttypes
                                        • localvarcookieparams
                                        • localvarformparams
                                        • localvarheaderparams
                                        • localvarpath
                                        • localvarpostbody
                                        • localvarqueryparams
                                        • long
                                        • native
                                        • new
                                        • null
                                        • object
                                        • offsetdatetime
                                        • package
                                        • private
                                        • protected
                                        • public
                                        • return
                                        • short
                                        • static
                                        • strictfp
                                        • stringutil
                                        • super
                                        • switch
                                        • synchronized
                                        • this
                                        • throw
                                        • throws
                                        • transient
                                        • try
                                        • void
                                        • volatile
                                        • while

                                        FEATURE SET​

                                        Client Modification Feature​

                                        NameSupportedDefined By
                                        BasePath✓ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension
                                        MockServer✗ToolingExtension

                                        Data Type Feature​

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Uuid✗
                                        Array✓OAS2,OAS3
                                        Null✗OAS3
                                        AnyType✗OAS2,OAS3
                                        Object✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature​

                                        NameSupportedDefined By
                                        Readme✓ToolingExtension
                                        Model✓ToolingExtension
                                        Api✓ToolingExtension

                                        Global Feature​

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✗OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature​

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✓OAS3

                                        Schema Support Feature​

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3
                                        allOf✗OAS2,OAS3
                                        anyOf✗OAS3
                                        oneOf✗OAS3
                                        not✗OAS3

                                        Security Feature​

                                        NameSupportedDefined By
                                        BasicAuth✓OAS2,OAS3
                                        ApiKey✓OAS2,OAS3
                                        OpenIDConnect✓OAS3
                                        BearerToken✓OAS3
                                        OAuth2_Implicit✓OAS2,OAS3
                                        OAuth2_Password✓OAS2,OAS3
                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                        OAuth2_AuthorizationCode✓OAS2,OAS3
                                        SignatureAuth✗OAS3
                                        AWSV4Signature✗ToolingExtension

                                        Wire Format Feature​

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✗OAS2,OAS3
                                        Edit this page
                                        Last updated on by Rodrigo de Almeida - RMA3
                                        - + \ No newline at end of file diff --git a/docs/generators/jetbrains-http-client/index.html b/docs/generators/jetbrains-http-client/index.html index 3ca487704b2..8ce5ac8a9d4 100644 --- a/docs/generators/jetbrains-http-client/index.html +++ b/docs/generators/jetbrains-http-client/index.html @@ -15,13 +15,13 @@ - +

                                        Documentation for the jetbrains-http-client Generator

                                        METADATA​

                                        PropertyValueNotes
                                        generator namejetbrains-http-clientpass this to the generate command after -g
                                        generator stabilityEXPERIMENTAL
                                        generator typeCLIENT
                                        generator languageJetbrains HTTP Client (HTTP/REST)
                                        generator default templating enginemustache
                                        helpTxtGenerates a jetbrains-http client. See https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html

                                        CONFIG OPTIONS​

                                        These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                        OptionDescriptionValuesDefault
                                        bodyVariableswhether to convert body placeholders (i.e. VAR_1) into variables (i.e. {{VAR_1}})null
                                        customHeaderscustom headers that can be set for each request. Can be used for unsupported features, for example auth methods like oauth.null

                                        IMPORT MAPPING​

                                        Type/AliasImports

                                        INSTANTIATION TYPES​

                                        Type/AliasInstantiated By

                                        LANGUAGE PRIMITIVES​

                                          RESERVED WORDS​

                                            FEATURE SET​

                                            Client Modification Feature​

                                            NameSupportedDefined By
                                            BasePath✗ToolingExtension
                                            Authorizations✗ToolingExtension
                                            UserAgent✗ToolingExtension
                                            MockServer✗ToolingExtension

                                            Data Type Feature​

                                            NameSupportedDefined By
                                            Custom✗OAS2,OAS3
                                            Int32✓OAS2,OAS3
                                            Int64✓OAS2,OAS3
                                            Float✓OAS2,OAS3
                                            Double✓OAS2,OAS3
                                            Decimal✓ToolingExtension
                                            String✓OAS2,OAS3
                                            Byte✓OAS2,OAS3
                                            Binary✓OAS2,OAS3
                                            Boolean✓OAS2,OAS3
                                            Date✓OAS2,OAS3
                                            DateTime✓OAS2,OAS3
                                            Password✓OAS2,OAS3
                                            File✓OAS2
                                            Uuid✗
                                            Array✓OAS2,OAS3
                                            Null✗OAS3
                                            AnyType✗OAS2,OAS3
                                            Object✓OAS2,OAS3
                                            Maps✓ToolingExtension
                                            CollectionFormat✓OAS2
                                            CollectionFormatMulti✓OAS2
                                            Enum✓OAS2,OAS3
                                            ArrayOfEnum✓ToolingExtension
                                            ArrayOfModel✓ToolingExtension
                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                            ArrayOfCollectionOfModel✓ToolingExtension
                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                            MapOfEnum✓ToolingExtension
                                            MapOfModel✓ToolingExtension
                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                            MapOfCollectionOfModel✓ToolingExtension
                                            MapOfCollectionOfEnum✓ToolingExtension

                                            Documentation Feature​

                                            NameSupportedDefined By
                                            Readme✗ToolingExtension
                                            Model✓ToolingExtension
                                            Api✓ToolingExtension

                                            Global Feature​

                                            NameSupportedDefined By
                                            Host✓OAS2,OAS3
                                            BasePath✓OAS2,OAS3
                                            Info✓OAS2,OAS3
                                            Schemes✗OAS2,OAS3
                                            PartialSchemes✓OAS2,OAS3
                                            Consumes✓OAS2
                                            Produces✓OAS2
                                            ExternalDocumentation✓OAS2,OAS3
                                            Examples✓OAS2,OAS3
                                            XMLStructureDefinitions✗OAS2,OAS3
                                            MultiServer✗OAS3
                                            ParameterizedServer✗OAS3
                                            ParameterStyling✗OAS3
                                            Callbacks✓OAS3
                                            LinkObjects✗OAS3

                                            Parameter Feature​

                                            NameSupportedDefined By
                                            Path✓OAS2,OAS3
                                            Query✓OAS2,OAS3
                                            Header✓OAS2,OAS3
                                            Body✓OAS2
                                            FormUnencoded✓OAS2
                                            FormMultipart✓OAS2
                                            Cookie✓OAS3

                                            Schema Support Feature​

                                            NameSupportedDefined By
                                            Simple✓OAS2,OAS3
                                            Composite✓OAS2,OAS3
                                            Polymorphism✓OAS2,OAS3
                                            Union✗OAS3
                                            allOf✗OAS2,OAS3
                                            anyOf✗OAS3
                                            oneOf✗OAS3
                                            not✗OAS3

                                            Security Feature​

                                            NameSupportedDefined By
                                            BasicAuth✓OAS2,OAS3
                                            ApiKey✓OAS2,OAS3
                                            OpenIDConnect✗OAS3
                                            BearerToken✓OAS3
                                            OAuth2_Implicit✓OAS2,OAS3
                                            OAuth2_Password✓OAS2,OAS3
                                            OAuth2_ClientCredentials✓OAS2,OAS3
                                            OAuth2_AuthorizationCode✓OAS2,OAS3
                                            SignatureAuth✗OAS3
                                            AWSV4Signature✗ToolingExtension

                                            Wire Format Feature​

                                            NameSupportedDefined By
                                            JSON✓OAS2,OAS3
                                            XML✓OAS2,OAS3
                                            PROTOBUF✗ToolingExtension
                                            Custom✗OAS2,OAS3
                                            - + \ No newline at end of file diff --git a/docs/generators/jmeter/index.html b/docs/generators/jmeter/index.html index 90f09049061..85a30b47010 100644 --- a/docs/generators/jmeter/index.html +++ b/docs/generators/jmeter/index.html @@ -15,13 +15,13 @@ - +

                                            Documentation for the jmeter Generator

                                            METADATA​

                                            PropertyValueNotes
                                            generator namejmeterpass this to the generate command after -g
                                            generator stabilitySTABLE
                                            generator typeCLIENT
                                            generator languageJava
                                            generator default templating enginemustache
                                            helpTxtGenerates a JMeter .jmx file.

                                            CONFIG OPTIONS​

                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                            OptionDescriptionValuesDefault
                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                            false
                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                            true
                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                            		true
                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                            false
                                            No changes to the enum's are made, this is the default option.
                                            true
                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                            		false
                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                            true
                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                            false
                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                            		true
                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                            IMPORT MAPPING​

                                            Type/AliasImports

                                            INSTANTIATION TYPES​

                                            Type/AliasInstantiated By

                                            LANGUAGE PRIMITIVES​

                                              RESERVED WORDS​

                                              • sample1
                                              • sample2

                                              FEATURE SET​

                                              Client Modification Feature​

                                              NameSupportedDefined By
                                              BasePath✓ToolingExtension
                                              Authorizations✗ToolingExtension
                                              UserAgent✗ToolingExtension
                                              MockServer✗ToolingExtension

                                              Data Type Feature​

                                              NameSupportedDefined By
                                              Custom✗OAS2,OAS3
                                              Int32✓OAS2,OAS3
                                              Int64✓OAS2,OAS3
                                              Float✓OAS2,OAS3
                                              Double✓OAS2,OAS3
                                              Decimal✓ToolingExtension
                                              String✓OAS2,OAS3
                                              Byte✓OAS2,OAS3
                                              Binary✓OAS2,OAS3
                                              Boolean✓OAS2,OAS3
                                              Date✓OAS2,OAS3
                                              DateTime✓OAS2,OAS3
                                              Password✓OAS2,OAS3
                                              File✓OAS2
                                              Uuid✗
                                              Array✓OAS2,OAS3
                                              Null✗OAS3
                                              AnyType✗OAS2,OAS3
                                              Object✓OAS2,OAS3
                                              Maps✓ToolingExtension
                                              CollectionFormat✓OAS2
                                              CollectionFormatMulti✓OAS2
                                              Enum✓OAS2,OAS3
                                              ArrayOfEnum✓ToolingExtension
                                              ArrayOfModel✓ToolingExtension
                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                              ArrayOfCollectionOfModel✓ToolingExtension
                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                              MapOfEnum✓ToolingExtension
                                              MapOfModel✓ToolingExtension
                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                              MapOfCollectionOfModel✓ToolingExtension
                                              MapOfCollectionOfEnum✓ToolingExtension

                                              Documentation Feature​

                                              NameSupportedDefined By
                                              Readme✗ToolingExtension
                                              Model✓ToolingExtension
                                              Api✓ToolingExtension

                                              Global Feature​

                                              NameSupportedDefined By
                                              Host✓OAS2,OAS3
                                              BasePath✓OAS2,OAS3
                                              Info✓OAS2,OAS3
                                              Schemes✗OAS2,OAS3
                                              PartialSchemes✓OAS2,OAS3
                                              Consumes✓OAS2
                                              Produces✓OAS2
                                              ExternalDocumentation✓OAS2,OAS3
                                              Examples✓OAS2,OAS3
                                              XMLStructureDefinitions✗OAS2,OAS3
                                              MultiServer✗OAS3
                                              ParameterizedServer✗OAS3
                                              ParameterStyling✗OAS3
                                              Callbacks✗OAS3
                                              LinkObjects✗OAS3

                                              Parameter Feature​

                                              NameSupportedDefined By
                                              Path✓OAS2,OAS3
                                              Query✓OAS2,OAS3
                                              Header✓OAS2,OAS3
                                              Body✓OAS2
                                              FormUnencoded✓OAS2
                                              FormMultipart✓OAS2
                                              Cookie✓OAS3

                                              Schema Support Feature​

                                              NameSupportedDefined By
                                              Simple✓OAS2,OAS3
                                              Composite✓OAS2,OAS3
                                              Polymorphism✗OAS2,OAS3
                                              Union✗OAS3
                                              allOf✗OAS2,OAS3
                                              anyOf✗OAS3
                                              oneOf✗OAS3
                                              not✗OAS3

                                              Security Feature​

                                              NameSupportedDefined By
                                              BasicAuth✓OAS2,OAS3
                                              ApiKey✓OAS2,OAS3
                                              OpenIDConnect✗OAS3
                                              BearerToken✗OAS3
                                              OAuth2_Implicit✓OAS2,OAS3
                                              OAuth2_Password✗OAS2,OAS3
                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                              OAuth2_AuthorizationCode✗OAS2,OAS3
                                              SignatureAuth✗OAS3
                                              AWSV4Signature✗ToolingExtension

                                              Wire Format Feature​

                                              NameSupportedDefined By
                                              JSON✓OAS2,OAS3
                                              XML✓OAS2,OAS3
                                              PROTOBUF✗ToolingExtension
                                              Custom✗OAS2,OAS3
                                              - + \ No newline at end of file diff --git a/docs/generators/julia-client/index.html b/docs/generators/julia-client/index.html index 4c0615fcec0..0e7cde8d334 100644 --- a/docs/generators/julia-client/index.html +++ b/docs/generators/julia-client/index.html @@ -15,13 +15,13 @@ - +

                                              Documentation for the julia-client Generator

                                              METADATA​

                                              PropertyValueNotes
                                              generator namejulia-clientpass this to the generate command after -g
                                              generator stabilityBETA
                                              generator typeCLIENT
                                              generator languageJulia
                                              generator default templating enginemustache
                                              helpTxtGenerates a julia client.

                                              CONFIG OPTIONS​

                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                              OptionDescriptionValuesDefault
                                              exportModelsWhether to generate code to export model names.false
                                              exportOperationsWhether to generate code to export operation names.false
                                              packageNameJulia client package name.APIClient

                                              IMPORT MAPPING​

                                              Type/AliasImports

                                              INSTANTIATION TYPES​

                                              Type/AliasInstantiated By

                                              LANGUAGE PRIMITIVES​

                                              • Any
                                              • Bool
                                              • Char
                                              • Date
                                              • DateTime
                                              • Dict
                                              • Float16
                                              • Float32
                                              • Float64
                                              • Int128
                                              • Int16
                                              • Int32
                                              • Int64
                                              • Int8
                                              • Integer
                                              • Nothing
                                              • String
                                              • UInt128
                                              • UInt16
                                              • UInt32
                                              • UInt64
                                              • UInt8
                                              • Vector
                                              • ZonedDateTime

                                              RESERVED WORDS​

                                              • Any
                                              • Base
                                              • DataType
                                              • Enum
                                              • Type
                                              • baremodule
                                              • begin
                                              • break
                                              • catch
                                              • ccall
                                              • const
                                              • continue
                                              • do
                                              • else
                                              • elseif
                                              • end
                                              • export
                                              • finally
                                              • for
                                              • function
                                              • global
                                              • if
                                              • import
                                              • let
                                              • local
                                              • macro
                                              • module
                                              • quote
                                              • return
                                              • try
                                              • using
                                              • while

                                              FEATURE SET​

                                              Client Modification Feature​

                                              NameSupportedDefined By
                                              BasePath✓ToolingExtension
                                              Authorizations✗ToolingExtension
                                              UserAgent✓ToolingExtension
                                              MockServer✗ToolingExtension

                                              Data Type Feature​

                                              NameSupportedDefined By
                                              Custom✗OAS2,OAS3
                                              Int32✓OAS2,OAS3
                                              Int64✓OAS2,OAS3
                                              Float✓OAS2,OAS3
                                              Double✓OAS2,OAS3
                                              Decimal✓ToolingExtension
                                              String✓OAS2,OAS3
                                              Byte✓OAS2,OAS3
                                              Binary✓OAS2,OAS3
                                              Boolean✓OAS2,OAS3
                                              Date✓OAS2,OAS3
                                              DateTime✓OAS2,OAS3
                                              Password✓OAS2,OAS3
                                              File✓OAS2
                                              Uuid✗
                                              Array✓OAS2,OAS3
                                              Null✗OAS3
                                              AnyType✗OAS2,OAS3
                                              Object✓OAS2,OAS3
                                              Maps✓ToolingExtension
                                              CollectionFormat✓OAS2
                                              CollectionFormatMulti✓OAS2
                                              Enum✓OAS2,OAS3
                                              ArrayOfEnum✓ToolingExtension
                                              ArrayOfModel✓ToolingExtension
                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                              ArrayOfCollectionOfModel✓ToolingExtension
                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                              MapOfEnum✓ToolingExtension
                                              MapOfModel✓ToolingExtension
                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                              MapOfCollectionOfModel✓ToolingExtension
                                              MapOfCollectionOfEnum✓ToolingExtension

                                              Documentation Feature​

                                              NameSupportedDefined By
                                              Readme✓ToolingExtension
                                              Model✓ToolingExtension
                                              Api✓ToolingExtension

                                              Global Feature​

                                              NameSupportedDefined By
                                              Host✓OAS2,OAS3
                                              BasePath✓OAS2,OAS3
                                              Info✓OAS2,OAS3
                                              Schemes✗OAS2,OAS3
                                              PartialSchemes✓OAS2,OAS3
                                              Consumes✗OAS2
                                              Produces✗OAS2
                                              ExternalDocumentation✓OAS2,OAS3
                                              Examples✗OAS2,OAS3
                                              XMLStructureDefinitions✗OAS2,OAS3
                                              MultiServer✗OAS3
                                              ParameterizedServer✗OAS3
                                              ParameterStyling✗OAS3
                                              Callbacks✗OAS3
                                              LinkObjects✗OAS3

                                              Parameter Feature​

                                              NameSupportedDefined By
                                              Path✓OAS2,OAS3
                                              Query✓OAS2,OAS3
                                              Header✓OAS2,OAS3
                                              Body✓OAS2
                                              FormUnencoded✓OAS2
                                              FormMultipart✓OAS2
                                              Cookie✗OAS3

                                              Schema Support Feature​

                                              NameSupportedDefined By
                                              Simple✓OAS2,OAS3
                                              Composite✓OAS2,OAS3
                                              Polymorphism✓OAS2,OAS3
                                              Union✓OAS3
                                              allOf✓OAS2,OAS3
                                              anyOf✓OAS3
                                              oneOf✓OAS3
                                              not✗OAS3

                                              Security Feature​

                                              NameSupportedDefined By
                                              BasicAuth✓OAS2,OAS3
                                              ApiKey✓OAS2,OAS3
                                              OpenIDConnect✗OAS3
                                              BearerToken✓OAS3
                                              OAuth2_Implicit✗OAS2,OAS3
                                              OAuth2_Password✗OAS2,OAS3
                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                              OAuth2_AuthorizationCode✗OAS2,OAS3
                                              SignatureAuth✗OAS3
                                              AWSV4Signature✗ToolingExtension

                                              Wire Format Feature​

                                              NameSupportedDefined By
                                              JSON✓OAS2,OAS3
                                              XML✗OAS2,OAS3
                                              PROTOBUF✗ToolingExtension
                                              Custom✗OAS2,OAS3
                                              - + \ No newline at end of file diff --git a/docs/generators/julia-server/index.html b/docs/generators/julia-server/index.html index cbcf0ca8f86..eb7923a2e68 100644 --- a/docs/generators/julia-server/index.html +++ b/docs/generators/julia-server/index.html @@ -15,13 +15,13 @@ - +

                                              Documentation for the julia-server Generator

                                              METADATA​

                                              PropertyValueNotes
                                              generator namejulia-serverpass this to the generate command after -g
                                              generator stabilityBETA
                                              generator typeSERVER
                                              generator languageJulia
                                              generator default templating enginemustache
                                              helpTxtGenerates a julia server.

                                              CONFIG OPTIONS​

                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                              OptionDescriptionValuesDefault
                                              exportModelsWhether to generate code to export model names.false
                                              packageNameJulia server package name.APIServer

                                              IMPORT MAPPING​

                                              Type/AliasImports

                                              INSTANTIATION TYPES​

                                              Type/AliasInstantiated By

                                              LANGUAGE PRIMITIVES​

                                              • Any
                                              • Bool
                                              • Char
                                              • Date
                                              • DateTime
                                              • Dict
                                              • Float16
                                              • Float32
                                              • Float64
                                              • Int128
                                              • Int16
                                              • Int32
                                              • Int64
                                              • Int8
                                              • Integer
                                              • Nothing
                                              • String
                                              • UInt128
                                              • UInt16
                                              • UInt32
                                              • UInt64
                                              • UInt8
                                              • Vector
                                              • ZonedDateTime

                                              RESERVED WORDS​

                                              • Any
                                              • Base
                                              • DataType
                                              • Enum
                                              • Type
                                              • baremodule
                                              • begin
                                              • break
                                              • catch
                                              • ccall
                                              • const
                                              • continue
                                              • do
                                              • else
                                              • elseif
                                              • end
                                              • export
                                              • finally
                                              • for
                                              • function
                                              • global
                                              • if
                                              • import
                                              • let
                                              • local
                                              • macro
                                              • module
                                              • quote
                                              • return
                                              • try
                                              • using
                                              • while

                                              FEATURE SET​

                                              Client Modification Feature​

                                              NameSupportedDefined By
                                              BasePath✓ToolingExtension
                                              Authorizations✗ToolingExtension
                                              UserAgent✓ToolingExtension
                                              MockServer✗ToolingExtension

                                              Data Type Feature​

                                              NameSupportedDefined By
                                              Custom✗OAS2,OAS3
                                              Int32✓OAS2,OAS3
                                              Int64✓OAS2,OAS3
                                              Float✓OAS2,OAS3
                                              Double✓OAS2,OAS3
                                              Decimal✓ToolingExtension
                                              String✓OAS2,OAS3
                                              Byte✓OAS2,OAS3
                                              Binary✓OAS2,OAS3
                                              Boolean✓OAS2,OAS3
                                              Date✓OAS2,OAS3
                                              DateTime✓OAS2,OAS3
                                              Password✓OAS2,OAS3
                                              File✓OAS2
                                              Uuid✗
                                              Array✓OAS2,OAS3
                                              Null✗OAS3
                                              AnyType✗OAS2,OAS3
                                              Object✓OAS2,OAS3
                                              Maps✓ToolingExtension
                                              CollectionFormat✓OAS2
                                              CollectionFormatMulti✓OAS2
                                              Enum✓OAS2,OAS3
                                              ArrayOfEnum✓ToolingExtension
                                              ArrayOfModel✓ToolingExtension
                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                              ArrayOfCollectionOfModel✓ToolingExtension
                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                              MapOfEnum✓ToolingExtension
                                              MapOfModel✓ToolingExtension
                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                              MapOfCollectionOfModel✓ToolingExtension
                                              MapOfCollectionOfEnum✓ToolingExtension

                                              Documentation Feature​

                                              NameSupportedDefined By
                                              Readme✓ToolingExtension
                                              Model✓ToolingExtension
                                              Api✓ToolingExtension

                                              Global Feature​

                                              NameSupportedDefined By
                                              Host✓OAS2,OAS3
                                              BasePath✓OAS2,OAS3
                                              Info✓OAS2,OAS3
                                              Schemes✗OAS2,OAS3
                                              PartialSchemes✓OAS2,OAS3
                                              Consumes✗OAS2
                                              Produces✗OAS2
                                              ExternalDocumentation✓OAS2,OAS3
                                              Examples✗OAS2,OAS3
                                              XMLStructureDefinitions✗OAS2,OAS3
                                              MultiServer✗OAS3
                                              ParameterizedServer✗OAS3
                                              ParameterStyling✗OAS3
                                              Callbacks✗OAS3
                                              LinkObjects✗OAS3

                                              Parameter Feature​

                                              NameSupportedDefined By
                                              Path✓OAS2,OAS3
                                              Query✓OAS2,OAS3
                                              Header✓OAS2,OAS3
                                              Body✓OAS2
                                              FormUnencoded✓OAS2
                                              FormMultipart✓OAS2
                                              Cookie✗OAS3

                                              Schema Support Feature​

                                              NameSupportedDefined By
                                              Simple✓OAS2,OAS3
                                              Composite✓OAS2,OAS3
                                              Polymorphism✓OAS2,OAS3
                                              Union✓OAS3
                                              allOf✓OAS2,OAS3
                                              anyOf✓OAS3
                                              oneOf✓OAS3
                                              not✗OAS3

                                              Security Feature​

                                              NameSupportedDefined By
                                              BasicAuth✓OAS2,OAS3
                                              ApiKey✓OAS2,OAS3
                                              OpenIDConnect✗OAS3
                                              BearerToken✓OAS3
                                              OAuth2_Implicit✗OAS2,OAS3
                                              OAuth2_Password✗OAS2,OAS3
                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                              OAuth2_AuthorizationCode✗OAS2,OAS3
                                              SignatureAuth✗OAS3
                                              AWSV4Signature✗ToolingExtension

                                              Wire Format Feature​

                                              NameSupportedDefined By
                                              JSON✓OAS2,OAS3
                                              XML✗OAS2,OAS3
                                              PROTOBUF✗ToolingExtension
                                              Custom✗OAS2,OAS3
                                              - + \ No newline at end of file diff --git a/docs/generators/julia/index.html b/docs/generators/julia/index.html index c8aa284fb3b..4fc2d232ba2 100644 --- a/docs/generators/julia/index.html +++ b/docs/generators/julia/index.html @@ -15,13 +15,13 @@ - +

                                              Documentation for the julia Generator

                                              METADATA​

                                              PropertyValueNotes
                                              generator namejuliapass this to the generate command after -g
                                              generator stabilitySTABLE
                                              generator typeCLIENT
                                              generator languageJava
                                              generator default templating enginemustache
                                              helpTxtGenerates a julia client.

                                              CONFIG OPTIONS​

                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                              OptionDescriptionValuesDefault
                                              packageNameJulia package name.APIClient

                                              IMPORT MAPPING​

                                              Type/AliasImports

                                              INSTANTIATION TYPES​

                                              Type/AliasInstantiated By

                                              LANGUAGE PRIMITIVES​

                                              • Array
                                              • Bool
                                              • Char
                                              • Float16
                                              • Float32
                                              • Float64
                                              • Int128
                                              • Int16
                                              • Int32
                                              • Int64
                                              • Int8
                                              • Integer
                                              • Nothing
                                              • String
                                              • UInt128
                                              • UInt16
                                              • UInt32
                                              • UInt64
                                              • UInt8
                                              • Vector

                                              RESERVED WORDS​

                                              • Any
                                              • Base
                                              • DataType
                                              • Enum
                                              • Type
                                              • baremodule
                                              • begin
                                              • break
                                              • catch
                                              • ccall
                                              • const
                                              • continue
                                              • do
                                              • else
                                              • elseif
                                              • end
                                              • export
                                              • finally
                                              • for
                                              • function
                                              • global
                                              • if
                                              • import
                                              • let
                                              • local
                                              • macro
                                              • module
                                              • quote
                                              • return
                                              • try
                                              • using
                                              • while

                                              FEATURE SET​

                                              Client Modification Feature​

                                              NameSupportedDefined By
                                              BasePath✗ToolingExtension
                                              Authorizations✗ToolingExtension
                                              UserAgent✗ToolingExtension
                                              MockServer✗ToolingExtension

                                              Data Type Feature​

                                              NameSupportedDefined By
                                              Custom✗OAS2,OAS3
                                              Int32✓OAS2,OAS3
                                              Int64✓OAS2,OAS3
                                              Float✓OAS2,OAS3
                                              Double✓OAS2,OAS3
                                              Decimal✓ToolingExtension
                                              String✓OAS2,OAS3
                                              Byte✓OAS2,OAS3
                                              Binary✓OAS2,OAS3
                                              Boolean✓OAS2,OAS3
                                              Date✓OAS2,OAS3
                                              DateTime✓OAS2,OAS3
                                              Password✓OAS2,OAS3
                                              File✓OAS2
                                              Uuid✗
                                              Array✓OAS2,OAS3
                                              Null✗OAS3
                                              AnyType✗OAS2,OAS3
                                              Object✓OAS2,OAS3
                                              Maps✓ToolingExtension
                                              CollectionFormat✓OAS2
                                              CollectionFormatMulti✓OAS2
                                              Enum✓OAS2,OAS3
                                              ArrayOfEnum✓ToolingExtension
                                              ArrayOfModel✓ToolingExtension
                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                              ArrayOfCollectionOfModel✓ToolingExtension
                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                              MapOfEnum✓ToolingExtension
                                              MapOfModel✓ToolingExtension
                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                              MapOfCollectionOfModel✓ToolingExtension
                                              MapOfCollectionOfEnum✓ToolingExtension

                                              Documentation Feature​

                                              NameSupportedDefined By
                                              Readme✗ToolingExtension
                                              Model✓ToolingExtension
                                              Api✓ToolingExtension

                                              Global Feature​

                                              NameSupportedDefined By
                                              Host✓OAS2,OAS3
                                              BasePath✓OAS2,OAS3
                                              Info✓OAS2,OAS3
                                              Schemes✗OAS2,OAS3
                                              PartialSchemes✓OAS2,OAS3
                                              Consumes✓OAS2
                                              Produces✓OAS2
                                              ExternalDocumentation✓OAS2,OAS3
                                              Examples✓OAS2,OAS3
                                              XMLStructureDefinitions✗OAS2,OAS3
                                              MultiServer✗OAS3
                                              ParameterizedServer✗OAS3
                                              ParameterStyling✗OAS3
                                              Callbacks✓OAS3
                                              LinkObjects✗OAS3

                                              Parameter Feature​

                                              NameSupportedDefined By
                                              Path✓OAS2,OAS3
                                              Query✓OAS2,OAS3
                                              Header✓OAS2,OAS3
                                              Body✓OAS2
                                              FormUnencoded✓OAS2
                                              FormMultipart✓OAS2
                                              Cookie✓OAS3

                                              Schema Support Feature​

                                              NameSupportedDefined By
                                              Simple✓OAS2,OAS3
                                              Composite✓OAS2,OAS3
                                              Polymorphism✓OAS2,OAS3
                                              Union✗OAS3
                                              allOf✗OAS2,OAS3
                                              anyOf✗OAS3
                                              oneOf✗OAS3
                                              not✗OAS3

                                              Security Feature​

                                              NameSupportedDefined By
                                              BasicAuth✓OAS2,OAS3
                                              ApiKey✓OAS2,OAS3
                                              OpenIDConnect✗OAS3
                                              BearerToken✓OAS3
                                              OAuth2_Implicit✓OAS2,OAS3
                                              OAuth2_Password✓OAS2,OAS3
                                              OAuth2_ClientCredentials✓OAS2,OAS3
                                              OAuth2_AuthorizationCode✓OAS2,OAS3
                                              SignatureAuth✗OAS3

                                              Wire Format Feature​

                                              NameSupportedDefined By
                                              JSON✓OAS2,OAS3
                                              XML✓OAS2,OAS3
                                              PROTOBUF✗ToolingExtension
                                              Custom✗OAS2,OAS3
                                              - + \ No newline at end of file diff --git a/docs/generators/k6/index.html b/docs/generators/k6/index.html index 93d10f7c231..00945ccafc1 100644 --- a/docs/generators/k6/index.html +++ b/docs/generators/k6/index.html @@ -15,13 +15,13 @@ - +

                                              Documentation for the k6 Generator

                                              METADATA​

                                              PropertyValueNotes
                                              generator namek6pass this to the generate command after -g
                                              generator stabilityBETA
                                              generator typeCLIENT
                                              generator languagek6
                                              generator default templating enginemustache
                                              helpTxtGenerates a k6 script (beta).

                                              CONFIG OPTIONS​

                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                              OptionDescriptionValuesDefault
                                              allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                              disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                              false
                                              The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                              true
                                              Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                              		true
                                              ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                              enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                              false
                                              No changes to the enum's are made, this is the default option.
                                              true
                                              With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                              		false
                                              legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                              true
                                              The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                              false
                                              The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                              		true
                                              prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                              sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                              sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                              IMPORT MAPPING​

                                              Type/AliasImports

                                              INSTANTIATION TYPES​

                                              Type/AliasInstantiated By

                                              LANGUAGE PRIMITIVES​

                                                RESERVED WORDS​

                                                  FEATURE SET​

                                                  Client Modification Feature​

                                                  NameSupportedDefined By
                                                  BasePath✗ToolingExtension
                                                  Authorizations✗ToolingExtension
                                                  UserAgent✗ToolingExtension
                                                  MockServer✗ToolingExtension

                                                  Data Type Feature​

                                                  NameSupportedDefined By
                                                  Custom✗OAS2,OAS3
                                                  Int32✓OAS2,OAS3
                                                  Int64✓OAS2,OAS3
                                                  Float✓OAS2,OAS3
                                                  Double✓OAS2,OAS3
                                                  Decimal✓ToolingExtension
                                                  String✓OAS2,OAS3
                                                  Byte✓OAS2,OAS3
                                                  Binary✓OAS2,OAS3
                                                  Boolean✓OAS2,OAS3
                                                  Date✓OAS2,OAS3
                                                  DateTime✓OAS2,OAS3
                                                  Password✓OAS2,OAS3
                                                  File✓OAS2
                                                  Uuid✗
                                                  Array✓OAS2,OAS3
                                                  Null✗OAS3
                                                  AnyType✗OAS2,OAS3
                                                  Object✓OAS2,OAS3
                                                  Maps✓ToolingExtension
                                                  CollectionFormat✓OAS2
                                                  CollectionFormatMulti✓OAS2
                                                  Enum✓OAS2,OAS3
                                                  ArrayOfEnum✓ToolingExtension
                                                  ArrayOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                  ArrayOfCollectionOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfEnum✓ToolingExtension
                                                  MapOfEnum✓ToolingExtension
                                                  MapOfModel✓ToolingExtension
                                                  MapOfCollectionOfPrimitives✓ToolingExtension
                                                  MapOfCollectionOfModel✓ToolingExtension
                                                  MapOfCollectionOfEnum✓ToolingExtension

                                                  Documentation Feature​

                                                  NameSupportedDefined By
                                                  Readme✗ToolingExtension
                                                  Model✓ToolingExtension
                                                  Api✓ToolingExtension

                                                  Global Feature​

                                                  NameSupportedDefined By
                                                  Host✓OAS2,OAS3
                                                  BasePath✓OAS2,OAS3
                                                  Info✓OAS2,OAS3
                                                  Schemes✗OAS2,OAS3
                                                  PartialSchemes✓OAS2,OAS3
                                                  Consumes✓OAS2
                                                  Produces✓OAS2
                                                  ExternalDocumentation✓OAS2,OAS3
                                                  Examples✓OAS2,OAS3
                                                  XMLStructureDefinitions✗OAS2,OAS3
                                                  MultiServer✗OAS3
                                                  ParameterizedServer✗OAS3
                                                  ParameterStyling✗OAS3
                                                  Callbacks✓OAS3
                                                  LinkObjects✗OAS3

                                                  Parameter Feature​

                                                  NameSupportedDefined By
                                                  Path✓OAS2,OAS3
                                                  Query✓OAS2,OAS3
                                                  Header✓OAS2,OAS3
                                                  Body✓OAS2
                                                  FormUnencoded✓OAS2
                                                  FormMultipart✓OAS2
                                                  Cookie✓OAS3

                                                  Schema Support Feature​

                                                  NameSupportedDefined By
                                                  Simple✓OAS2,OAS3
                                                  Composite✓OAS2,OAS3
                                                  Polymorphism✓OAS2,OAS3
                                                  Union✗OAS3
                                                  allOf✗OAS2,OAS3
                                                  anyOf✗OAS3
                                                  oneOf✗OAS3
                                                  not✗OAS3

                                                  Security Feature​

                                                  NameSupportedDefined By
                                                  BasicAuth✓OAS2,OAS3
                                                  ApiKey✓OAS2,OAS3
                                                  OpenIDConnect✗OAS3
                                                  BearerToken✓OAS3
                                                  OAuth2_Implicit✓OAS2,OAS3
                                                  OAuth2_Password✓OAS2,OAS3
                                                  OAuth2_ClientCredentials✓OAS2,OAS3
                                                  OAuth2_AuthorizationCode✓OAS2,OAS3
                                                  SignatureAuth✗OAS3
                                                  AWSV4Signature✗ToolingExtension

                                                  Wire Format Feature​

                                                  NameSupportedDefined By
                                                  JSON✓OAS2,OAS3
                                                  XML✓OAS2,OAS3
                                                  PROTOBUF✗ToolingExtension
                                                  Custom✗OAS2,OAS3
                                                  - + \ No newline at end of file diff --git a/docs/generators/kotlin-server/index.html b/docs/generators/kotlin-server/index.html index 861174b7acb..1834f4c7bc8 100644 --- a/docs/generators/kotlin-server/index.html +++ b/docs/generators/kotlin-server/index.html @@ -15,13 +15,13 @@ - +

                                                  Documentation for the kotlin-server Generator

                                                  METADATA​

                                                  PropertyValueNotes
                                                  generator namekotlin-serverpass this to the generate command after -g
                                                  generator stabilitySTABLE
                                                  generator typeSERVER
                                                  generator languageKotlin
                                                  generator default templating enginemustache
                                                  helpTxtGenerates a Kotlin server.

                                                  CONFIG OPTIONS​

                                                  These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                  OptionDescriptionValuesDefault
                                                  additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                                  apiSuffixsuffix for api classesApi
                                                  artifactIdGenerated artifact id (name of jar).kotlin-server
                                                  artifactVersionGenerated artifact's package version.1.0.0
                                                  enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'original
                                                  featureAutoHeadAutomatically provide responses to HEAD requests for existing routes that have the GET verb defined.true
                                                  featureCORSKtor by default provides an interceptor for implementing proper support for Cross-Origin Resource Sharing (CORS). See enable-cors.org.false
                                                  featureCompressionAdds ability to compress outgoing content using gzip, deflate or custom encoder and thus reduce size of the response.true
                                                  featureConditionalHeadersAvoid sending content if client already has same content, by checking ETag or LastModified properties.false
                                                  featureHSTSAvoid sending content if client already has same content, by checking ETag or LastModified properties.true
                                                  featureMetricsEnables metrics feature.true
                                                  featureResourcesGenerates routes in a typed way, for both: constructing URLs and reading the parameters.true
                                                  groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                  interfaceOnlyWhether to generate only API interface stubs without the server files. This option is currently supported only when using jaxrs-spec library.false
                                                  librarylibrary template (sub-template)
                                                  ktor
                                                  ktor framework
                                                  jaxrs-spec
                                                  JAX-RS spec only
                                                  javalin5
                                                  Javalin 5
                                                  javalin6
                                                  Javalin 6
                                                  		ktor
                                                  modelMutableCreate mutable modelsfalse
                                                  omitGradleWrapperWhether to omit Gradle wrapper for creating a sub project.false
                                                  packageNameGenerated artifact package name.org.openapitools.server
                                                  parcelizeModelstoggle "@Parcelize" for generated modelsnull
                                                  returnResponseWhether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true. This option is currently supported only when using jaxrs-spec library.false
                                                  serializableModelboolean - toggle "implements Serializable" for generated modelsnull
                                                  sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                  sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                  sourceFoldersource folder for generated codesrc/main/kotlin
                                                  useBeanValidationUse BeanValidation API annotations. This option is currently supported only when using jaxrs-spec library.false
                                                  useCoroutinesWhether to use the Coroutines. This option is currently supported only when using jaxrs-spec library.false
                                                  useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                                  useMutinyWhether to use Mutiny (should not be used with useCoroutines). This option is currently supported only when using jaxrs-spec library.false

                                                  IMPORT MAPPING​

                                                  Type/AliasImports
                                                  BigDecimaljava.math.BigDecimal
                                                  Datejava.time.LocalDate
                                                  DateTimejava.time.OffsetDateTime
                                                  Filejava.io.File
                                                  LocalDatejava.time.LocalDate
                                                  LocalDateTimejava.time.LocalDateTime
                                                  LocalTimejava.time.LocalTime
                                                  Timestampjava.sql.Timestamp
                                                  URIjava.net.URI
                                                  UUIDjava.util.UUID

                                                  INSTANTIATION TYPES​

                                                  Type/AliasInstantiated By
                                                  arraykotlin.collections.ArrayList
                                                  listkotlin.collections.ArrayList
                                                  mapkotlin.collections.HashMap

                                                  LANGUAGE PRIMITIVES​

                                                  • kotlin.Array
                                                  • kotlin.Boolean
                                                  • kotlin.Byte
                                                  • kotlin.ByteArray
                                                  • kotlin.Char
                                                  • kotlin.Double
                                                  • kotlin.Float
                                                  • kotlin.Int
                                                  • kotlin.Long
                                                  • kotlin.Short
                                                  • kotlin.String
                                                  • kotlin.collections.List
                                                  • kotlin.collections.Map
                                                  • kotlin.collections.MutableList
                                                  • kotlin.collections.MutableMap
                                                  • kotlin.collections.MutableSet
                                                  • kotlin.collections.Set

                                                  RESERVED WORDS​

                                                  • ApiResponse
                                                  • abstract
                                                  • actual
                                                  • annotation
                                                  • as
                                                  • break
                                                  • class
                                                  • companion
                                                  • const
                                                  • constructor
                                                  • continue
                                                  • contract
                                                  • crossinline
                                                  • data
                                                  • delegate
                                                  • do
                                                  • dynamic
                                                  • else
                                                  • enum
                                                  • expect
                                                  • external
                                                  • false
                                                  • field
                                                  • final
                                                  • finally
                                                  • for
                                                  • fun
                                                  • if
                                                  • import
                                                  • in
                                                  • infix
                                                  • init
                                                  • inline
                                                  • inner
                                                  • interface
                                                  • internal
                                                  • is
                                                  • it
                                                  • lateinit
                                                  • noinline
                                                  • null
                                                  • object
                                                  • open
                                                  • operator
                                                  • out
                                                  • override
                                                  • package
                                                  • param
                                                  • private
                                                  • property
                                                  • protected
                                                  • public
                                                  • receiver
                                                  • reified
                                                  • return
                                                  • sealed
                                                  • setparam
                                                  • super
                                                  • suspend
                                                  • tailrec
                                                  • this
                                                  • throw
                                                  • true
                                                  • try
                                                  • typealias
                                                  • typeof
                                                  • val
                                                  • value
                                                  • var
                                                  • vararg
                                                  • when
                                                  • where
                                                  • while

                                                  FEATURE SET​

                                                  Client Modification Feature​

                                                  NameSupportedDefined By
                                                  BasePath✗ToolingExtension
                                                  Authorizations✗ToolingExtension
                                                  UserAgent✗ToolingExtension
                                                  MockServer✗ToolingExtension

                                                  Data Type Feature​

                                                  NameSupportedDefined By
                                                  Custom✗OAS2,OAS3
                                                  Int32✓OAS2,OAS3
                                                  Int64✓OAS2,OAS3
                                                  Float✓OAS2,OAS3
                                                  Double✓OAS2,OAS3
                                                  Decimal✓ToolingExtension
                                                  String✓OAS2,OAS3
                                                  Byte✓OAS2,OAS3
                                                  Binary✓OAS2,OAS3
                                                  Boolean✓OAS2,OAS3
                                                  Date✓OAS2,OAS3
                                                  DateTime✓OAS2,OAS3
                                                  Password✓OAS2,OAS3
                                                  File✓OAS2
                                                  Uuid✗
                                                  Array✓OAS2,OAS3
                                                  Null✗OAS3
                                                  AnyType✗OAS2,OAS3
                                                  Object✓OAS2,OAS3
                                                  Maps✓ToolingExtension
                                                  CollectionFormat✓OAS2
                                                  CollectionFormatMulti✓OAS2
                                                  Enum✓OAS2,OAS3
                                                  ArrayOfEnum✓ToolingExtension
                                                  ArrayOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                  ArrayOfCollectionOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfEnum✓ToolingExtension
                                                  MapOfEnum✓ToolingExtension
                                                  MapOfModel✓ToolingExtension
                                                  MapOfCollectionOfPrimitives✓ToolingExtension
                                                  MapOfCollectionOfModel✓ToolingExtension
                                                  MapOfCollectionOfEnum✓ToolingExtension

                                                  Documentation Feature​

                                                  NameSupportedDefined By
                                                  Readme✓ToolingExtension
                                                  Model✓ToolingExtension
                                                  Api✓ToolingExtension

                                                  Global Feature​

                                                  NameSupportedDefined By
                                                  Host✓OAS2,OAS3
                                                  BasePath✓OAS2,OAS3
                                                  Info✓OAS2,OAS3
                                                  Schemes✗OAS2,OAS3
                                                  PartialSchemes✓OAS2,OAS3
                                                  Consumes✓OAS2
                                                  Produces✓OAS2
                                                  ExternalDocumentation✓OAS2,OAS3
                                                  Examples✓OAS2,OAS3
                                                  XMLStructureDefinitions✗OAS2,OAS3
                                                  MultiServer✗OAS3
                                                  ParameterizedServer✗OAS3
                                                  ParameterStyling✗OAS3
                                                  Callbacks✗OAS3
                                                  LinkObjects✗OAS3

                                                  Parameter Feature​

                                                  NameSupportedDefined By
                                                  Path✓OAS2,OAS3
                                                  Query✓OAS2,OAS3
                                                  Header✓OAS2,OAS3
                                                  Body✓OAS2
                                                  FormUnencoded✓OAS2
                                                  FormMultipart✓OAS2
                                                  Cookie✗OAS3

                                                  Schema Support Feature​

                                                  NameSupportedDefined By
                                                  Simple✓OAS2,OAS3
                                                  Composite✓OAS2,OAS3
                                                  Polymorphism✗OAS2,OAS3
                                                  Union✗OAS3
                                                  allOf✗OAS2,OAS3
                                                  anyOf✗OAS3
                                                  oneOf✗OAS3
                                                  not✗OAS3

                                                  Security Feature​

                                                  NameSupportedDefined By
                                                  BasicAuth✓OAS2,OAS3
                                                  ApiKey✓OAS2,OAS3
                                                  OpenIDConnect✗OAS3
                                                  BearerToken✗OAS3
                                                  OAuth2_Implicit✓OAS2,OAS3
                                                  OAuth2_Password✗OAS2,OAS3
                                                  OAuth2_ClientCredentials✗OAS2,OAS3
                                                  OAuth2_AuthorizationCode✗OAS2,OAS3
                                                  SignatureAuth✗OAS3
                                                  AWSV4Signature✗ToolingExtension

                                                  Wire Format Feature​

                                                  NameSupportedDefined By
                                                  JSON✓OAS2,OAS3
                                                  XML✓OAS2,OAS3
                                                  PROTOBUF✗ToolingExtension
                                                  Custom✗OAS2,OAS3
                                                  - + \ No newline at end of file diff --git a/docs/generators/kotlin-spring/index.html b/docs/generators/kotlin-spring/index.html index 7967cc03a62..102f53aef25 100644 --- a/docs/generators/kotlin-spring/index.html +++ b/docs/generators/kotlin-spring/index.html @@ -15,13 +15,13 @@ - +

                                                  Documentation for the kotlin-spring Generator

                                                  METADATA​

                                                  PropertyValueNotes
                                                  generator namekotlin-springpass this to the generate command after -g
                                                  generator stabilitySTABLE
                                                  generator typeSERVER
                                                  generator languageKotlin
                                                  generator default templating enginemustache
                                                  helpTxtGenerates a Kotlin Spring application.

                                                  CONFIG OPTIONS​

                                                  These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                  OptionDescriptionValuesDefault
                                                  additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                                  annotationLibrarySelect the complementary documentation annotation library.
                                                  none
                                                  Do not annotate Model and Api with complementary annotations.
                                                  swagger1
                                                  Annotate Model and Api using the Swagger Annotations 1.x library.
                                                  swagger2
                                                  Annotate Model and Api using the Swagger Annotations 2.x library.
                                                  		swagger2
                                                  apiPackageapi package for generated codeorg.openapitools.api
                                                  apiSuffixsuffix for api classesApi
                                                  artifactIdGenerated artifact id (name of jar).openapi-spring
                                                  artifactVersionGenerated artifact's package version.1.0.0
                                                  basePackagebase package (invokerPackage) for generated codeorg.openapitools
                                                  beanQualifiersWhether to add fully-qualifier class names as bean qualifiers in @Component and @RestController annotations. May be used to prevent bean names clash if multiple generated libraries (contexts) added to single project.false
                                                  configPackageconfiguration package for generated codeorg.openapitools.configuration
                                                  delegatePatternWhether to generate the server files using the delegate patternfalse
                                                  documentationProviderSelect the OpenAPI documentation provider.
                                                  none
                                                  Do not publish an OpenAPI specification.
                                                  source
                                                  Publish the original input OpenAPI specification.
                                                  springfox
                                                  Generate an OpenAPI 2 (fka Swagger RESTful API Documentation Specification) specification using SpringFox 2.x. Deprecated (for removal); use springdoc instead.
                                                  springdoc
                                                  Generate an OpenAPI 3 specification using SpringDoc.
                                                  		springdoc
                                                  enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'original
                                                  exceptionHandlergenerate default global exception handlers (not compatible with reactive. enabling reactive will disable exceptionHandler )true
                                                  gradleBuildFilegenerate a gradle build file using the Kotlin DSLtrue
                                                  groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                  interfaceOnlyWhether to generate only API interface stubs without the server files.false
                                                  librarylibrary template (sub-template)
                                                  spring-boot
                                                  Spring-boot Server application.
                                                  spring-cloud
                                                  Spring-Cloud-Feign client with Spring-Boot auto-configured settings.
                                                  		spring-boot
                                                  modelMutableCreate mutable modelsfalse
                                                  modelPackagemodel package for generated codeorg.openapitools.model
                                                  packageNameGenerated artifact package name.org.openapitools
                                                  parcelizeModelstoggle "@Parcelize" for generated modelsnull
                                                  reactiveuse coroutines for reactive behaviorfalse
                                                  requestMappingModeWhere to generate the class level @RequestMapping annotation.
                                                  api_interface
                                                  Generate the @RequestMapping annotation on the generated Api Interface.
                                                  controller
                                                  Generate the @RequestMapping annotation on the generated Api Controller Implementation.
                                                  none
                                                  Do not add a class level @RequestMapping annotation.
                                                  		controller
                                                  serializableModelboolean - toggle "implements Serializable" for generated modelsnull
                                                  serverPortconfiguration the port in which the sever is to run on8080
                                                  serviceImplementationgenerate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generatedfalse
                                                  serviceInterfacegenerate service interfaces to go alongside controllers. In most cases this option would be used to update an existing project, so not to override implementations. Useful to help facilitate the generation gap patternfalse
                                                  skipDefaultInterfaceWhether to skip generation of default implementations for interfaces (Api interfaces or Delegate interfaces depending on the delegatePattern option)false
                                                  sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                  sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                  sourceFoldersource folder for generated codesrc/main/kotlin
                                                  titleserver title name or client service nameOpenAPI Kotlin Spring
                                                  useBeanValidationUse BeanValidation API annotations to validate data typestrue
                                                  useFeignClientUrlWhether to generate Feign client with url parameter.true
                                                  useSpringBoot3Generate code and provide dependencies for use with Spring Boot 3.x. (Use jakarta instead of javax in imports). Enabling this option will also enable useJakartaEe.false
                                                  useSwaggerUIOpen the OpenApi specification in swagger-ui. Will also import and configure needed dependenciestrue
                                                  useTagsWhether to use tags for creating interface and controller class namesfalse

                                                  SUPPORTED VENDOR EXTENSIONS​

                                                  Extension nameDescriptionApplicable forDefault value
                                                  x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                                  x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                                  x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                                  x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                                  x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull
                                                  x-pattern-messageAdd this property whenever you need to customize the invalidation error message for the regex pattern of a variableFIELD, OPERATION_PARAMETERnull

                                                  IMPORT MAPPING​

                                                  Type/AliasImports
                                                  BigDecimaljava.math.BigDecimal
                                                  Datejava.time.LocalDate
                                                  DateTimejava.time.OffsetDateTime
                                                  Filejava.io.File
                                                  LocalDatejava.time.LocalDate
                                                  LocalDateTimejava.time.LocalDateTime
                                                  LocalTimejava.time.LocalTime
                                                  Timestampjava.sql.Timestamp
                                                  URIjava.net.URI
                                                  UUIDjava.util.UUID

                                                  INSTANTIATION TYPES​

                                                  Type/AliasInstantiated By
                                                  arraykotlin.collections.ArrayList
                                                  listkotlin.collections.ArrayList
                                                  mapkotlin.collections.HashMap

                                                  LANGUAGE PRIMITIVES​

                                                  • kotlin.Array
                                                  • kotlin.Boolean
                                                  • kotlin.Byte
                                                  • kotlin.ByteArray
                                                  • kotlin.Char
                                                  • kotlin.Double
                                                  • kotlin.Float
                                                  • kotlin.Int
                                                  • kotlin.Long
                                                  • kotlin.Short
                                                  • kotlin.String
                                                  • kotlin.collections.List
                                                  • kotlin.collections.Map
                                                  • kotlin.collections.MutableList
                                                  • kotlin.collections.MutableMap
                                                  • kotlin.collections.MutableSet
                                                  • kotlin.collections.Set

                                                  RESERVED WORDS​

                                                  • ApiClient
                                                  • ApiException
                                                  • ApiResponse
                                                  • abstract
                                                  • actual
                                                  • annotation
                                                  • as
                                                  • break
                                                  • class
                                                  • companion
                                                  • const
                                                  • constructor
                                                  • continue
                                                  • contract
                                                  • crossinline
                                                  • data
                                                  • delegate
                                                  • do
                                                  • dynamic
                                                  • else
                                                  • enum
                                                  • expect
                                                  • external
                                                  • false
                                                  • field
                                                  • final
                                                  • finally
                                                  • for
                                                  • fun
                                                  • if
                                                  • import
                                                  • in
                                                  • infix
                                                  • init
                                                  • inline
                                                  • inner
                                                  • interface
                                                  • internal
                                                  • is
                                                  • it
                                                  • lateinit
                                                  • noinline
                                                  • null
                                                  • object
                                                  • open
                                                  • operator
                                                  • out
                                                  • override
                                                  • package
                                                  • param
                                                  • private
                                                  • property
                                                  • protected
                                                  • public
                                                  • receiver
                                                  • reified
                                                  • return
                                                  • sealed
                                                  • setparam
                                                  • super
                                                  • suspend
                                                  • tailrec
                                                  • this
                                                  • throw
                                                  • true
                                                  • try
                                                  • typealias
                                                  • typeof
                                                  • val
                                                  • value
                                                  • var
                                                  • vararg
                                                  • when
                                                  • where
                                                  • while

                                                  FEATURE SET​

                                                  Client Modification Feature​

                                                  NameSupportedDefined By
                                                  BasePath✗ToolingExtension
                                                  Authorizations✗ToolingExtension
                                                  UserAgent✗ToolingExtension
                                                  MockServer✗ToolingExtension

                                                  Data Type Feature​

                                                  NameSupportedDefined By
                                                  Custom✗OAS2,OAS3
                                                  Int32✓OAS2,OAS3
                                                  Int64✓OAS2,OAS3
                                                  Float✓OAS2,OAS3
                                                  Double✓OAS2,OAS3
                                                  Decimal✓ToolingExtension
                                                  String✓OAS2,OAS3
                                                  Byte✓OAS2,OAS3
                                                  Binary✓OAS2,OAS3
                                                  Boolean✓OAS2,OAS3
                                                  Date✓OAS2,OAS3
                                                  DateTime✓OAS2,OAS3
                                                  Password✓OAS2,OAS3
                                                  File✓OAS2
                                                  Uuid✗
                                                  Array✓OAS2,OAS3
                                                  Null✗OAS3
                                                  AnyType✗OAS2,OAS3
                                                  Object✓OAS2,OAS3
                                                  Maps✓ToolingExtension
                                                  CollectionFormat✓OAS2
                                                  CollectionFormatMulti✓OAS2
                                                  Enum✓OAS2,OAS3
                                                  ArrayOfEnum✓ToolingExtension
                                                  ArrayOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                  ArrayOfCollectionOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfEnum✓ToolingExtension
                                                  MapOfEnum✓ToolingExtension
                                                  MapOfModel✓ToolingExtension
                                                  MapOfCollectionOfPrimitives✓ToolingExtension
                                                  MapOfCollectionOfModel✓ToolingExtension
                                                  MapOfCollectionOfEnum✓ToolingExtension

                                                  Documentation Feature​

                                                  NameSupportedDefined By
                                                  Readme✓ToolingExtension
                                                  Model✓ToolingExtension
                                                  Api✓ToolingExtension

                                                  Global Feature​

                                                  NameSupportedDefined By
                                                  Host✓OAS2,OAS3
                                                  BasePath✓OAS2,OAS3
                                                  Info✓OAS2,OAS3
                                                  Schemes✗OAS2,OAS3
                                                  PartialSchemes✓OAS2,OAS3
                                                  Consumes✓OAS2
                                                  Produces✓OAS2
                                                  ExternalDocumentation✓OAS2,OAS3
                                                  Examples✓OAS2,OAS3
                                                  XMLStructureDefinitions✗OAS2,OAS3
                                                  MultiServer✗OAS3
                                                  ParameterizedServer✗OAS3
                                                  ParameterStyling✗OAS3
                                                  Callbacks✗OAS3
                                                  LinkObjects✗OAS3

                                                  Parameter Feature​

                                                  NameSupportedDefined By
                                                  Path✓OAS2,OAS3
                                                  Query✓OAS2,OAS3
                                                  Header✓OAS2,OAS3
                                                  Body✓OAS2
                                                  FormUnencoded✓OAS2
                                                  FormMultipart✓OAS2
                                                  Cookie✓OAS3

                                                  Schema Support Feature​

                                                  NameSupportedDefined By
                                                  Simple✓OAS2,OAS3
                                                  Composite✓OAS2,OAS3
                                                  Polymorphism✓OAS2,OAS3
                                                  Union✗OAS3
                                                  allOf✗OAS2,OAS3
                                                  anyOf✗OAS3
                                                  oneOf✗OAS3
                                                  not✗OAS3

                                                  Security Feature​

                                                  NameSupportedDefined By
                                                  BasicAuth✓OAS2,OAS3
                                                  ApiKey✓OAS2,OAS3
                                                  OpenIDConnect✗OAS3
                                                  BearerToken✗OAS3
                                                  OAuth2_Implicit✓OAS2,OAS3
                                                  OAuth2_Password✓OAS2,OAS3
                                                  OAuth2_ClientCredentials✓OAS2,OAS3
                                                  OAuth2_AuthorizationCode✓OAS2,OAS3
                                                  SignatureAuth✗OAS3
                                                  AWSV4Signature✗ToolingExtension

                                                  Wire Format Feature​

                                                  NameSupportedDefined By
                                                  JSON✓OAS2,OAS3
                                                  XML✓OAS2,OAS3
                                                  PROTOBUF✗ToolingExtension
                                                  Custom✗OAS2,OAS3
                                                  - + \ No newline at end of file diff --git a/docs/generators/kotlin-vertx/index.html b/docs/generators/kotlin-vertx/index.html index f38b0a481f8..a9884c887f2 100644 --- a/docs/generators/kotlin-vertx/index.html +++ b/docs/generators/kotlin-vertx/index.html @@ -15,13 +15,13 @@ - +

                                                  Documentation for the kotlin-vertx Generator

                                                  METADATA​

                                                  PropertyValueNotes
                                                  generator namekotlin-vertxpass this to the generate command after -g
                                                  generator stabilityBETA
                                                  generator typeSERVER
                                                  generator languageKotlin
                                                  generator default templating enginemustache
                                                  helpTxtGenerates a kotlin-vertx server.

                                                  CONFIG OPTIONS​

                                                  These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                  OptionDescriptionValuesDefault
                                                  additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                                  apiSuffixsuffix for api classesApi
                                                  artifactIdGenerated artifact id (name of jar).null
                                                  artifactVersionGenerated artifact's package version.1.0.0
                                                  enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'original
                                                  groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                  modelMutableCreate mutable modelsfalse
                                                  packageNameGenerated artifact package name.org.openapitools
                                                  parcelizeModelstoggle "@Parcelize" for generated modelsnull
                                                  serializableModelboolean - toggle "implements Serializable" for generated modelsnull
                                                  sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                  sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                  sourceFoldersource folder for generated codesrc/main/kotlin

                                                  IMPORT MAPPING​

                                                  Type/AliasImports
                                                  BigDecimaljava.math.BigDecimal
                                                  Datejava.time.LocalDate
                                                  DateTimejava.time.OffsetDateTime
                                                  Filejava.io.File
                                                  LocalDatejava.time.LocalDate
                                                  LocalDateTimejava.time.LocalDateTime
                                                  LocalTimejava.time.LocalTime
                                                  Timestampjava.sql.Timestamp
                                                  URIjava.net.URI
                                                  UUIDjava.util.UUID

                                                  INSTANTIATION TYPES​

                                                  Type/AliasInstantiated By
                                                  arraykotlin.collections.ArrayList
                                                  listkotlin.collections.ArrayList
                                                  mapkotlin.collections.HashMap

                                                  LANGUAGE PRIMITIVES​

                                                  • kotlin.Array
                                                  • kotlin.Boolean
                                                  • kotlin.Byte
                                                  • kotlin.ByteArray
                                                  • kotlin.Char
                                                  • kotlin.Double
                                                  • kotlin.Float
                                                  • kotlin.Int
                                                  • kotlin.Long
                                                  • kotlin.Short
                                                  • kotlin.String
                                                  • kotlin.collections.List
                                                  • kotlin.collections.Map
                                                  • kotlin.collections.MutableList
                                                  • kotlin.collections.MutableMap
                                                  • kotlin.collections.MutableSet
                                                  • kotlin.collections.Set

                                                  RESERVED WORDS​

                                                  • ApiResponse
                                                  • abstract
                                                  • actual
                                                  • annotation
                                                  • as
                                                  • break
                                                  • class
                                                  • companion
                                                  • const
                                                  • constructor
                                                  • continue
                                                  • contract
                                                  • crossinline
                                                  • data
                                                  • delegate
                                                  • do
                                                  • dynamic
                                                  • else
                                                  • enum
                                                  • expect
                                                  • external
                                                  • false
                                                  • field
                                                  • final
                                                  • finally
                                                  • for
                                                  • fun
                                                  • if
                                                  • import
                                                  • in
                                                  • infix
                                                  • init
                                                  • inline
                                                  • inner
                                                  • interface
                                                  • internal
                                                  • is
                                                  • it
                                                  • lateinit
                                                  • noinline
                                                  • null
                                                  • object
                                                  • open
                                                  • operator
                                                  • out
                                                  • override
                                                  • package
                                                  • param
                                                  • private
                                                  • property
                                                  • protected
                                                  • public
                                                  • receiver
                                                  • reified
                                                  • return
                                                  • sealed
                                                  • setparam
                                                  • super
                                                  • suspend
                                                  • tailrec
                                                  • this
                                                  • throw
                                                  • true
                                                  • try
                                                  • typealias
                                                  • typeof
                                                  • val
                                                  • value
                                                  • var
                                                  • vararg
                                                  • when
                                                  • where
                                                  • while

                                                  FEATURE SET​

                                                  Client Modification Feature​

                                                  NameSupportedDefined By
                                                  BasePath✗ToolingExtension
                                                  Authorizations✗ToolingExtension
                                                  UserAgent✗ToolingExtension
                                                  MockServer✗ToolingExtension

                                                  Data Type Feature​

                                                  NameSupportedDefined By
                                                  Custom✗OAS2,OAS3
                                                  Int32✓OAS2,OAS3
                                                  Int64✓OAS2,OAS3
                                                  Float✓OAS2,OAS3
                                                  Double✓OAS2,OAS3
                                                  Decimal✓ToolingExtension
                                                  String✓OAS2,OAS3
                                                  Byte✓OAS2,OAS3
                                                  Binary✓OAS2,OAS3
                                                  Boolean✓OAS2,OAS3
                                                  Date✓OAS2,OAS3
                                                  DateTime✓OAS2,OAS3
                                                  Password✓OAS2,OAS3
                                                  File✓OAS2
                                                  Uuid✗
                                                  Array✓OAS2,OAS3
                                                  Null✗OAS3
                                                  AnyType✗OAS2,OAS3
                                                  Object✓OAS2,OAS3
                                                  Maps✓ToolingExtension
                                                  CollectionFormat✓OAS2
                                                  CollectionFormatMulti✓OAS2
                                                  Enum✓OAS2,OAS3
                                                  ArrayOfEnum✓ToolingExtension
                                                  ArrayOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                  ArrayOfCollectionOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfEnum✓ToolingExtension
                                                  MapOfEnum✓ToolingExtension
                                                  MapOfModel✓ToolingExtension
                                                  MapOfCollectionOfPrimitives✓ToolingExtension
                                                  MapOfCollectionOfModel✓ToolingExtension
                                                  MapOfCollectionOfEnum✓ToolingExtension

                                                  Documentation Feature​

                                                  NameSupportedDefined By
                                                  Readme✓ToolingExtension
                                                  Model✓ToolingExtension
                                                  Api✓ToolingExtension

                                                  Global Feature​

                                                  NameSupportedDefined By
                                                  Host✓OAS2,OAS3
                                                  BasePath✓OAS2,OAS3
                                                  Info✓OAS2,OAS3
                                                  Schemes✗OAS2,OAS3
                                                  PartialSchemes✓OAS2,OAS3
                                                  Consumes✓OAS2
                                                  Produces✓OAS2
                                                  ExternalDocumentation✓OAS2,OAS3
                                                  Examples✓OAS2,OAS3
                                                  XMLStructureDefinitions✗OAS2,OAS3
                                                  MultiServer✗OAS3
                                                  ParameterizedServer✗OAS3
                                                  ParameterStyling✗OAS3
                                                  Callbacks✗OAS3
                                                  LinkObjects✗OAS3

                                                  Parameter Feature​

                                                  NameSupportedDefined By
                                                  Path✓OAS2,OAS3
                                                  Query✓OAS2,OAS3
                                                  Header✓OAS2,OAS3
                                                  Body✓OAS2
                                                  FormUnencoded✓OAS2
                                                  FormMultipart✓OAS2
                                                  Cookie✓OAS3

                                                  Schema Support Feature​

                                                  NameSupportedDefined By
                                                  Simple✓OAS2,OAS3
                                                  Composite✓OAS2,OAS3
                                                  Polymorphism✗OAS2,OAS3
                                                  Union✗OAS3
                                                  allOf✗OAS2,OAS3
                                                  anyOf✗OAS3
                                                  oneOf✗OAS3
                                                  not✗OAS3

                                                  Security Feature​

                                                  NameSupportedDefined By
                                                  BasicAuth✗OAS2,OAS3
                                                  ApiKey✗OAS2,OAS3
                                                  OpenIDConnect✗OAS3
                                                  BearerToken✗OAS3
                                                  OAuth2_Implicit✗OAS2,OAS3
                                                  OAuth2_Password✗OAS2,OAS3
                                                  OAuth2_ClientCredentials✗OAS2,OAS3
                                                  OAuth2_AuthorizationCode✗OAS2,OAS3
                                                  SignatureAuth✗OAS3
                                                  AWSV4Signature✗ToolingExtension

                                                  Wire Format Feature​

                                                  NameSupportedDefined By
                                                  JSON✓OAS2,OAS3
                                                  XML✓OAS2,OAS3
                                                  PROTOBUF✗ToolingExtension
                                                  Custom✗OAS2,OAS3
                                                  - + \ No newline at end of file diff --git a/docs/generators/kotlin-wiremock/index.html b/docs/generators/kotlin-wiremock/index.html index 8d189605306..8dd6bddea53 100644 --- a/docs/generators/kotlin-wiremock/index.html +++ b/docs/generators/kotlin-wiremock/index.html @@ -15,13 +15,13 @@ - +

                                                  Documentation for the kotlin-wiremock Generator

                                                  METADATA​

                                                  PropertyValueNotes
                                                  generator namekotlin-wiremockpass this to the generate command after -g
                                                  generator stabilityBETA
                                                  generator typeSERVER
                                                  generator languageKotlin
                                                  generator default templating enginemustache
                                                  helpTxtGenerates Kotlin WireMock stub request and response samples.

                                                  CONFIG OPTIONS​

                                                  These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                  OptionDescriptionValuesDefault
                                                  additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                                  apiSuffixsuffix for api classesApi
                                                  artifactIdGenerated artifact id (name of jar).null
                                                  artifactVersionGenerated artifact's package version.1.0.0
                                                  enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'original
                                                  groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                  modelMutableCreate mutable modelsfalse
                                                  packageNameGenerated artifact package name.org.openapitools
                                                  parcelizeModelstoggle "@Parcelize" for generated modelsnull
                                                  serializableModelboolean - toggle "implements Serializable" for generated modelsnull
                                                  sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                  sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                  sourceFoldersource folder for generated codesrc/main/kotlin

                                                  IMPORT MAPPING​

                                                  Type/AliasImports
                                                  BigDecimaljava.math.BigDecimal
                                                  Datejava.time.LocalDate
                                                  DateTimejava.time.OffsetDateTime
                                                  Filejava.io.File
                                                  LocalDatejava.time.LocalDate
                                                  LocalDateTimejava.time.LocalDateTime
                                                  LocalTimejava.time.LocalTime
                                                  Timestampjava.sql.Timestamp
                                                  URIjava.net.URI
                                                  UUIDjava.util.UUID

                                                  INSTANTIATION TYPES​

                                                  Type/AliasInstantiated By
                                                  arraykotlin.collections.ArrayList
                                                  listkotlin.collections.ArrayList
                                                  mapkotlin.collections.HashMap

                                                  LANGUAGE PRIMITIVES​

                                                  • kotlin.Array
                                                  • kotlin.Boolean
                                                  • kotlin.Byte
                                                  • kotlin.ByteArray
                                                  • kotlin.Char
                                                  • kotlin.Double
                                                  • kotlin.Float
                                                  • kotlin.Int
                                                  • kotlin.Long
                                                  • kotlin.Short
                                                  • kotlin.String
                                                  • kotlin.collections.List
                                                  • kotlin.collections.Map
                                                  • kotlin.collections.MutableList
                                                  • kotlin.collections.MutableMap
                                                  • kotlin.collections.MutableSet
                                                  • kotlin.collections.Set

                                                  RESERVED WORDS​

                                                  • ApiResponse
                                                  • abstract
                                                  • actual
                                                  • annotation
                                                  • as
                                                  • break
                                                  • class
                                                  • companion
                                                  • const
                                                  • constructor
                                                  • continue
                                                  • contract
                                                  • crossinline
                                                  • data
                                                  • delegate
                                                  • do
                                                  • dynamic
                                                  • else
                                                  • enum
                                                  • expect
                                                  • external
                                                  • false
                                                  • field
                                                  • final
                                                  • finally
                                                  • for
                                                  • fun
                                                  • if
                                                  • import
                                                  • in
                                                  • infix
                                                  • init
                                                  • inline
                                                  • inner
                                                  • interface
                                                  • internal
                                                  • is
                                                  • it
                                                  • lateinit
                                                  • noinline
                                                  • null
                                                  • object
                                                  • open
                                                  • operator
                                                  • out
                                                  • override
                                                  • package
                                                  • param
                                                  • private
                                                  • property
                                                  • protected
                                                  • public
                                                  • receiver
                                                  • reified
                                                  • return
                                                  • sealed
                                                  • setparam
                                                  • super
                                                  • suspend
                                                  • tailrec
                                                  • this
                                                  • throw
                                                  • true
                                                  • try
                                                  • typealias
                                                  • typeof
                                                  • val
                                                  • value
                                                  • var
                                                  • vararg
                                                  • when
                                                  • where
                                                  • while

                                                  FEATURE SET​

                                                  Client Modification Feature​

                                                  NameSupportedDefined By
                                                  BasePath✗ToolingExtension
                                                  Authorizations✗ToolingExtension
                                                  UserAgent✗ToolingExtension
                                                  MockServer✗ToolingExtension

                                                  Data Type Feature​

                                                  NameSupportedDefined By
                                                  Custom✗OAS2,OAS3
                                                  Int32✓OAS2,OAS3
                                                  Int64✓OAS2,OAS3
                                                  Float✓OAS2,OAS3
                                                  Double✓OAS2,OAS3
                                                  Decimal✓ToolingExtension
                                                  String✓OAS2,OAS3
                                                  Byte✓OAS2,OAS3
                                                  Binary✓OAS2,OAS3
                                                  Boolean✓OAS2,OAS3
                                                  Date✓OAS2,OAS3
                                                  DateTime✓OAS2,OAS3
                                                  Password✓OAS2,OAS3
                                                  File✓OAS2
                                                  Uuid✗
                                                  Array✓OAS2,OAS3
                                                  Null✗OAS3
                                                  AnyType✗OAS2,OAS3
                                                  Object✓OAS2,OAS3
                                                  Maps✓ToolingExtension
                                                  CollectionFormat✓OAS2
                                                  CollectionFormatMulti✓OAS2
                                                  Enum✓OAS2,OAS3
                                                  ArrayOfEnum✓ToolingExtension
                                                  ArrayOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                  ArrayOfCollectionOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfEnum✓ToolingExtension
                                                  MapOfEnum✓ToolingExtension
                                                  MapOfModel✓ToolingExtension
                                                  MapOfCollectionOfPrimitives✓ToolingExtension
                                                  MapOfCollectionOfModel✓ToolingExtension
                                                  MapOfCollectionOfEnum✓ToolingExtension

                                                  Documentation Feature​

                                                  NameSupportedDefined By
                                                  Readme✗ToolingExtension
                                                  Model✓ToolingExtension
                                                  Api✓ToolingExtension

                                                  Global Feature​

                                                  NameSupportedDefined By
                                                  Host✓OAS2,OAS3
                                                  BasePath✓OAS2,OAS3
                                                  Info✓OAS2,OAS3
                                                  Schemes✗OAS2,OAS3
                                                  PartialSchemes✓OAS2,OAS3
                                                  Consumes✓OAS2
                                                  Produces✓OAS2
                                                  ExternalDocumentation✓OAS2,OAS3
                                                  Examples✓OAS2,OAS3
                                                  XMLStructureDefinitions✗OAS2,OAS3
                                                  MultiServer✗OAS3
                                                  ParameterizedServer✗OAS3
                                                  ParameterStyling✗OAS3
                                                  Callbacks✓OAS3
                                                  LinkObjects✗OAS3

                                                  Parameter Feature​

                                                  NameSupportedDefined By
                                                  Path✓OAS2,OAS3
                                                  Query✓OAS2,OAS3
                                                  Header✓OAS2,OAS3
                                                  Body✓OAS2
                                                  FormUnencoded✓OAS2
                                                  FormMultipart✓OAS2
                                                  Cookie✓OAS3

                                                  Schema Support Feature​

                                                  NameSupportedDefined By
                                                  Simple✓OAS2,OAS3
                                                  Composite✓OAS2,OAS3
                                                  Polymorphism✓OAS2,OAS3
                                                  Union✗OAS3
                                                  allOf✗OAS2,OAS3
                                                  anyOf✗OAS3
                                                  oneOf✗OAS3
                                                  not✗OAS3

                                                  Security Feature​

                                                  NameSupportedDefined By
                                                  BasicAuth✓OAS2,OAS3
                                                  ApiKey✓OAS2,OAS3
                                                  OpenIDConnect✗OAS3
                                                  BearerToken✓OAS3
                                                  OAuth2_Implicit✓OAS2,OAS3
                                                  OAuth2_Password✓OAS2,OAS3
                                                  OAuth2_ClientCredentials✓OAS2,OAS3
                                                  OAuth2_AuthorizationCode✓OAS2,OAS3
                                                  SignatureAuth✗OAS3
                                                  AWSV4Signature✗ToolingExtension

                                                  Wire Format Feature​

                                                  NameSupportedDefined By
                                                  JSON✓OAS2,OAS3
                                                  XML✓OAS2,OAS3
                                                  PROTOBUF✗ToolingExtension
                                                  Custom✗OAS2,OAS3
                                                  - + \ No newline at end of file diff --git a/docs/generators/kotlin/index.html b/docs/generators/kotlin/index.html index 6b852536971..08bacfb8205 100644 --- a/docs/generators/kotlin/index.html +++ b/docs/generators/kotlin/index.html @@ -15,13 +15,13 @@ - +

                                                  Documentation for the kotlin Generator

                                                  METADATA​

                                                  PropertyValueNotes
                                                  generator namekotlinpass this to the generate command after -g
                                                  generator stabilitySTABLE
                                                  generator typeCLIENT
                                                  generator languageKotlin
                                                  generator default templating enginemustache
                                                  helpTxtGenerates a Kotlin client.

                                                  CONFIG OPTIONS​

                                                  These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                  OptionDescriptionValuesDefault
                                                  additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                                  apiSuffixsuffix for api classesApi
                                                  artifactIdGenerated artifact id (name of jar).kotlin-client
                                                  artifactVersionGenerated artifact's package version.1.0.0
                                                  collectionTypeOption. Collection type to use
                                                  array
                                                  kotlin.Array
                                                  list
                                                  kotlin.collections.List
                                                  		list
                                                  dateLibraryOption. Date library to use
                                                  threetenbp-localdatetime
                                                  Threetenbp - Backport of JSR310 (jvm only, for legacy app only)
                                                  kotlinx-datetime
                                                  kotlinx-datetime (preferred for multiplatform)
                                                  string
                                                  String
                                                  java8-localdatetime
                                                  Java 8 native JSR310 (jvm only, for legacy app only)
                                                  java8
                                                  Java 8 native JSR310 (jvm only, preferred for jdk 1.8+)
                                                  threetenbp
                                                  Threetenbp - Backport of JSR310 (jvm only, preferred for jdk < 1.8)
                                                  		java8
                                                  enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'original
                                                  explicitApiGenerates code with explicit access modifiers to comply with Kotlin Explicit API Mode.false
                                                  failOnUnknownPropertiesFail Jackson de-serialization on unknown propertiesfalse
                                                  generateOneOfAnyOfWrappersGenerate oneOf, anyOf schemas as wrappers.false
                                                  generateRoomModelsGenerate Android Room database models in addition to API models (JVM Volley library only)false
                                                  groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                  ideaAdd IntellJ Idea plugin and mark Kotlin main and test folders as source folders.false
                                                  libraryLibrary template (sub-template) to use
                                                  jvm-ktor
                                                  Platform: Java Virtual Machine. HTTP client: Ktor 1.6.7. JSON processing: Gson, Jackson (default).
                                                  jvm-okhttp4
                                                  [DEFAULT] Platform: Java Virtual Machine. HTTP client: OkHttp 4.2.0 (Android 5.0+ and Java 8+). JSON processing: Moshi 1.8.0.
                                                  jvm-spring-webclient
                                                  Platform: Java Virtual Machine. HTTP: Spring 5 (or 6 with useSpringBoot3 enabled) WebClient. JSON processing: Jackson.
                                                  jvm-spring-restclient
                                                  Platform: Java Virtual Machine. HTTP: Spring 6 RestClient. JSON processing: Jackson.
                                                  jvm-retrofit2
                                                  Platform: Java Virtual Machine. HTTP client: Retrofit 2.6.2.
                                                  multiplatform
                                                  Platform: Kotlin multiplatform. HTTP client: Ktor 1.6.7. JSON processing: Kotlinx Serialization: 1.2.1.
                                                  jvm-volley
                                                  Platform: JVM for Android. HTTP client: Volley 1.2.1. JSON processing: gson 2.8.9
                                                  jvm-vertx
                                                  Platform: Java Virtual Machine. HTTP client: Vert.x Web Client. JSON processing: Moshi, Gson or Jackson.
                                                  		jvm-okhttp4
                                                  mapFileBinaryToByteArrayMap File and Binary to ByteArray (default: false)false
                                                  modelMutableCreate mutable modelsfalse
                                                  moshiCodeGenWhether to enable codegen with the Moshi library. Refer to the official Moshi doc for more info.false
                                                  nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.false
                                                  nullableReturnTypeNullable return typefalse
                                                  omitGradlePluginVersionsWhether to declare Gradle plugin versions in build files.false
                                                  omitGradleWrapperWhether to omit Gradle wrapper for creating a sub project.false
                                                  packageNameGenerated artifact package name.org.openapitools.client
                                                  parcelizeModelstoggle "@Parcelize" for generated modelsnull
                                                  requestDateConverterJVM-Option. Defines in how to handle date-time objects that are used for a request (as query or parameter)
                                                  toJson
                                                  [DEFAULT] Date formatter option using a json converter.
                                                  toString
                                                  Use the 'toString'-method of the date-time object to retrieve the related string representation.
                                                  		toJson
                                                  serializableModelboolean - toggle "implements Serializable" for generated modelsnull
                                                  serializationLibraryWhat serialization library to use: 'moshi' (default), or 'gson' or 'jackson' or 'kotlinx_serialization'moshi
                                                  sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                  sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                  sourceFoldersource folder for generated codesrc/main/kotlin
                                                  supportAndroidApiLevel25AndBelow[WARNING] This flag will generate code that has a known security vulnerability. It uses kotlin.io.createTempFile instead of java.nio.file.Files.createTempFile in order to support Android API level 25 and bellow. For more info, please check the following links https://github.com/OpenAPITools/openapi-generator/security/advisories/GHSA-23x4-m842-fmwf, https://github.com/OpenAPITools/openapi-generator/pull/9284false
                                                  useCoroutinesWhether to use the Coroutines adapter with the retrofit2 library.false
                                                  useRxJava3Whether to use the RxJava3 adapter with the retrofit2 library.false
                                                  useSettingsGradleWhether the project uses settings.gradle.false
                                                  useSpringBoot3Whether to use the Spring Boot 3 with the jvm-spring-webclient library.false

                                                  SUPPORTED VENDOR EXTENSIONS​

                                                  Extension nameDescriptionApplicable forDefault value
                                                  x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                                  x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull

                                                  IMPORT MAPPING​

                                                  Type/AliasImports
                                                  BigDecimaljava.math.BigDecimal
                                                  Datejava.time.LocalDate
                                                  DateTimejava.time.OffsetDateTime
                                                  Filejava.io.File
                                                  LocalDatejava.time.LocalDate
                                                  LocalDateTimejava.time.LocalDateTime
                                                  LocalTimejava.time.LocalTime
                                                  Timestampjava.sql.Timestamp
                                                  URIjava.net.URI
                                                  UUIDjava.util.UUID

                                                  INSTANTIATION TYPES​

                                                  Type/AliasInstantiated By
                                                  arraykotlin.collections.ArrayList
                                                  listkotlin.collections.ArrayList
                                                  mapkotlin.collections.HashMap

                                                  LANGUAGE PRIMITIVES​

                                                  • kotlin.Array
                                                  • kotlin.Boolean
                                                  • kotlin.Byte
                                                  • kotlin.ByteArray
                                                  • kotlin.Char
                                                  • kotlin.Double
                                                  • kotlin.Float
                                                  • kotlin.Int
                                                  • kotlin.Long
                                                  • kotlin.Short
                                                  • kotlin.String
                                                  • kotlin.collections.List
                                                  • kotlin.collections.Map
                                                  • kotlin.collections.MutableList
                                                  • kotlin.collections.MutableMap
                                                  • kotlin.collections.MutableSet
                                                  • kotlin.collections.Set

                                                  RESERVED WORDS​

                                                  • ApiResponse
                                                  • abstract
                                                  • actual
                                                  • annotation
                                                  • as
                                                  • break
                                                  • class
                                                  • companion
                                                  • const
                                                  • constructor
                                                  • continue
                                                  • contract
                                                  • crossinline
                                                  • data
                                                  • delegate
                                                  • do
                                                  • dynamic
                                                  • else
                                                  • enum
                                                  • expect
                                                  • external
                                                  • false
                                                  • field
                                                  • final
                                                  • finally
                                                  • for
                                                  • fun
                                                  • if
                                                  • import
                                                  • in
                                                  • infix
                                                  • init
                                                  • inline
                                                  • inner
                                                  • interface
                                                  • internal
                                                  • is
                                                  • it
                                                  • lateinit
                                                  • noinline
                                                  • null
                                                  • object
                                                  • open
                                                  • operator
                                                  • out
                                                  • override
                                                  • package
                                                  • param
                                                  • private
                                                  • property
                                                  • protected
                                                  • public
                                                  • receiver
                                                  • reified
                                                  • return
                                                  • sealed
                                                  • setparam
                                                  • super
                                                  • suspend
                                                  • tailrec
                                                  • this
                                                  • throw
                                                  • true
                                                  • try
                                                  • typealias
                                                  • typeof
                                                  • val
                                                  • value
                                                  • var
                                                  • vararg
                                                  • when
                                                  • where
                                                  • while

                                                  FEATURE SET​

                                                  Client Modification Feature​

                                                  NameSupportedDefined By
                                                  BasePath✓ToolingExtension
                                                  Authorizations✗ToolingExtension
                                                  UserAgent✗ToolingExtension
                                                  MockServer✗ToolingExtension

                                                  Data Type Feature​

                                                  NameSupportedDefined By
                                                  Custom✗OAS2,OAS3
                                                  Int32✓OAS2,OAS3
                                                  Int64✓OAS2,OAS3
                                                  Float✓OAS2,OAS3
                                                  Double✓OAS2,OAS3
                                                  Decimal✓ToolingExtension
                                                  String✓OAS2,OAS3
                                                  Byte✓OAS2,OAS3
                                                  Binary✓OAS2,OAS3
                                                  Boolean✓OAS2,OAS3
                                                  Date✓OAS2,OAS3
                                                  DateTime✓OAS2,OAS3
                                                  Password✓OAS2,OAS3
                                                  File✓OAS2
                                                  Uuid✗
                                                  Array✓OAS2,OAS3
                                                  Null✗OAS3
                                                  AnyType✗OAS2,OAS3
                                                  Object✓OAS2,OAS3
                                                  Maps✓ToolingExtension
                                                  CollectionFormat✓OAS2
                                                  CollectionFormatMulti✓OAS2
                                                  Enum✓OAS2,OAS3
                                                  ArrayOfEnum✓ToolingExtension
                                                  ArrayOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                  ArrayOfCollectionOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfEnum✓ToolingExtension
                                                  MapOfEnum✓ToolingExtension
                                                  MapOfModel✓ToolingExtension
                                                  MapOfCollectionOfPrimitives✓ToolingExtension
                                                  MapOfCollectionOfModel✓ToolingExtension
                                                  MapOfCollectionOfEnum✓ToolingExtension

                                                  Documentation Feature​

                                                  NameSupportedDefined By
                                                  Readme✓ToolingExtension
                                                  Model✓ToolingExtension
                                                  Api✓ToolingExtension

                                                  Global Feature​

                                                  NameSupportedDefined By
                                                  Host✓OAS2,OAS3
                                                  BasePath✓OAS2,OAS3
                                                  Info✓OAS2,OAS3
                                                  Schemes✗OAS2,OAS3
                                                  PartialSchemes✓OAS2,OAS3
                                                  Consumes✓OAS2
                                                  Produces✓OAS2
                                                  ExternalDocumentation✓OAS2,OAS3
                                                  Examples✓OAS2,OAS3
                                                  XMLStructureDefinitions✗OAS2,OAS3
                                                  MultiServer✗OAS3
                                                  ParameterizedServer✗OAS3
                                                  ParameterStyling✗OAS3
                                                  Callbacks✗OAS3
                                                  LinkObjects✗OAS3

                                                  Parameter Feature​

                                                  NameSupportedDefined By
                                                  Path✓OAS2,OAS3
                                                  Query✓OAS2,OAS3
                                                  Header✓OAS2,OAS3
                                                  Body✓OAS2
                                                  FormUnencoded✓OAS2
                                                  FormMultipart✓OAS2
                                                  Cookie✗OAS3

                                                  Schema Support Feature​

                                                  NameSupportedDefined By
                                                  Simple✓OAS2,OAS3
                                                  Composite✓OAS2,OAS3
                                                  Polymorphism✗OAS2,OAS3
                                                  Union✗OAS3
                                                  allOf✗OAS2,OAS3
                                                  anyOf✗OAS3
                                                  oneOf✗OAS3
                                                  not✗OAS3

                                                  Security Feature​

                                                  NameSupportedDefined By
                                                  BasicAuth✓OAS2,OAS3
                                                  ApiKey✓OAS2,OAS3
                                                  OpenIDConnect✗OAS3
                                                  BearerToken✓OAS3
                                                  OAuth2_Implicit✓OAS2,OAS3
                                                  OAuth2_Password✗OAS2,OAS3
                                                  OAuth2_ClientCredentials✗OAS2,OAS3
                                                  OAuth2_AuthorizationCode✓OAS2,OAS3
                                                  SignatureAuth✗OAS3
                                                  AWSV4Signature✗ToolingExtension

                                                  Wire Format Feature​

                                                  NameSupportedDefined By
                                                  JSON✓OAS2,OAS3
                                                  XML✗OAS2,OAS3
                                                  PROTOBUF✗ToolingExtension
                                                  Custom✗OAS2,OAS3
                                                  - + \ No newline at end of file diff --git a/docs/generators/ktorm-schema/index.html b/docs/generators/ktorm-schema/index.html index fb66acc8d08..d79e81dbb6e 100644 --- a/docs/generators/ktorm-schema/index.html +++ b/docs/generators/ktorm-schema/index.html @@ -15,13 +15,13 @@ - +

                                                  Documentation for the ktorm-schema Generator

                                                  METADATA​

                                                  PropertyValueNotes
                                                  generator namektorm-schemapass this to the generate command after -g
                                                  generator stabilityBETA
                                                  generator typeSCHEMA
                                                  generator languageKtorm
                                                  generator default templating enginemustache
                                                  helpTxtGenerates a kotlin-ktorm schema (beta)

                                                  CONFIG OPTIONS​

                                                  These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                  OptionDescriptionValuesDefault
                                                  addSurrogateKeyAdds the surrogate key for all models that don't already have a primary key (named by the above convention)false
                                                  additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                                  artifactIdGenerated artifact id (name of jar).ktorm
                                                  artifactVersionGenerated artifact's package version.1.0.0
                                                  defaultDatabaseNameDefault database name for all queriessqlite.db
                                                  enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'original
                                                  groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                  identifierNamingConventionNaming convention of Ktorm identifiers(table names and column names). This is not related to database name which is defined by defaultDatabaseName option
                                                  original
                                                  Do not transform original names
                                                  snake_case
                                                  Use snake_case names
                                                  		original
                                                  importModelPackageNamePackage name of the imported modelsorg.openapitools.database.models
                                                  modelMutableCreate mutable modelsfalse
                                                  packageNameGenerated artifact package name.org.openapitools.database
                                                  primaryKeyConventionPrimary key naming conventionid
                                                  sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                  sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                  sourceFoldersource folder for generated codesrc/main/kotlin

                                                  IMPORT MAPPING​

                                                  Type/AliasImports
                                                  BigDecimaljava.math.BigDecimal
                                                  Datejava.time.LocalDate
                                                  DateTimejava.time.OffsetDateTime
                                                  Filejava.io.File
                                                  LocalDatejava.time.LocalDate
                                                  LocalDateTimejava.time.LocalDateTime
                                                  LocalTimejava.time.LocalTime
                                                  Timestampjava.sql.Timestamp
                                                  URIjava.net.URI
                                                  UUIDjava.util.UUID

                                                  INSTANTIATION TYPES​

                                                  Type/AliasInstantiated By
                                                  arraykotlin.collections.ArrayList
                                                  listkotlin.collections.ArrayList
                                                  mapkotlin.collections.HashMap

                                                  LANGUAGE PRIMITIVES​

                                                  • kotlin.Array
                                                  • kotlin.Boolean
                                                  • kotlin.Byte
                                                  • kotlin.ByteArray
                                                  • kotlin.Char
                                                  • kotlin.Double
                                                  • kotlin.Float
                                                  • kotlin.Int
                                                  • kotlin.Long
                                                  • kotlin.Short
                                                  • kotlin.String
                                                  • kotlin.collections.List
                                                  • kotlin.collections.Map
                                                  • kotlin.collections.MutableList
                                                  • kotlin.collections.MutableMap
                                                  • kotlin.collections.MutableSet
                                                  • kotlin.collections.Set

                                                  RESERVED WORDS​

                                                  • abort
                                                  • action
                                                  • add
                                                  • after
                                                  • all
                                                  • alter
                                                  • always
                                                  • analyze
                                                  • and
                                                  • any
                                                  • as
                                                  • asc
                                                  • attach
                                                  • autoincr
                                                  • autoincrement
                                                  • before
                                                  • begin
                                                  • between
                                                  • bitand
                                                  • bitnot
                                                  • bitor
                                                  • blob
                                                  • by
                                                  • cascade
                                                  • case
                                                  • cast
                                                  • check
                                                  • collate
                                                  • column
                                                  • comma
                                                  • commit
                                                  • concat
                                                  • conflict
                                                  • constraint
                                                  • create
                                                  • cross
                                                  • current
                                                  • current_date
                                                  • current_time
                                                  • current_timestamp
                                                  • database
                                                  • default
                                                  • deferrable
                                                  • deferred
                                                  • delete
                                                  • desc
                                                  • detach
                                                  • distinct
                                                  • do
                                                  • dot
                                                  • drop
                                                  • each
                                                  • else
                                                  • end
                                                  • eq
                                                  • escape
                                                  • except
                                                  • exclude
                                                  • exclusive
                                                  • exists
                                                  • explain
                                                  • fail
                                                  • filter
                                                  • first
                                                  • float
                                                  • following
                                                  • for
                                                  • foreign
                                                  • from
                                                  • full
                                                  • ge
                                                  • generated
                                                  • glob
                                                  • group
                                                  • groups
                                                  • gt
                                                  • having
                                                  • id
                                                  • if
                                                  • ignore
                                                  • immediate
                                                  • in
                                                  • index
                                                  • indexed
                                                  • initially
                                                  • inner
                                                  • insert
                                                  • instead
                                                  • integer
                                                  • intersect
                                                  • into
                                                  • is
                                                  • isnull
                                                  • join
                                                  • key
                                                  • last
                                                  • le
                                                  • left
                                                  • like
                                                  • limit
                                                  • lp
                                                  • lshift
                                                  • lt
                                                  • match
                                                  • minus
                                                  • natural
                                                  • ne
                                                  • no
                                                  • not
                                                  • nothing
                                                  • notnull
                                                  • null
                                                  • nulls
                                                  • of
                                                  • offset
                                                  • on
                                                  • or
                                                  • order
                                                  • others
                                                  • outer
                                                  • over
                                                  • partition
                                                  • plan
                                                  • plus
                                                  • pragma
                                                  • preceding
                                                  • primary
                                                  • query
                                                  • raise
                                                  • range
                                                  • recursive
                                                  • references
                                                  • regexp
                                                  • reindex
                                                  • release
                                                  • rem
                                                  • rename
                                                  • replace
                                                  • restrict
                                                  • right
                                                  • rollback
                                                  • row
                                                  • rows
                                                  • rp
                                                  • rshift
                                                  • savepoint
                                                  • select
                                                  • set
                                                  • slash
                                                  • star
                                                  • string
                                                  • table
                                                  • temp
                                                  • temporary
                                                  • then
                                                  • ties
                                                  • to
                                                  • transaction
                                                  • trigger
                                                  • unbounded
                                                  • union
                                                  • unique
                                                  • update
                                                  • using
                                                  • vacuum
                                                  • values
                                                  • variable
                                                  • view
                                                  • virtual
                                                  • when
                                                  • where
                                                  • window
                                                  • with
                                                  • without

                                                  FEATURE SET​

                                                  Client Modification Feature​

                                                  NameSupportedDefined By
                                                  BasePath✗ToolingExtension
                                                  Authorizations✗ToolingExtension
                                                  UserAgent✗ToolingExtension
                                                  MockServer✗ToolingExtension

                                                  Data Type Feature​

                                                  NameSupportedDefined By
                                                  Custom✗OAS2,OAS3
                                                  Int32✓OAS2,OAS3
                                                  Int64✓OAS2,OAS3
                                                  Float✓OAS2,OAS3
                                                  Double✓OAS2,OAS3
                                                  Decimal✓ToolingExtension
                                                  String✓OAS2,OAS3
                                                  Byte✓OAS2,OAS3
                                                  Binary✓OAS2,OAS3
                                                  Boolean✓OAS2,OAS3
                                                  Date✓OAS2,OAS3
                                                  DateTime✓OAS2,OAS3
                                                  Password✓OAS2,OAS3
                                                  File✓OAS2
                                                  Uuid✗
                                                  Array✓OAS2,OAS3
                                                  Null✗OAS3
                                                  AnyType✗OAS2,OAS3
                                                  Object✓OAS2,OAS3
                                                  Maps✓ToolingExtension
                                                  CollectionFormat✓OAS2
                                                  CollectionFormatMulti✓OAS2
                                                  Enum✓OAS2,OAS3
                                                  ArrayOfEnum✓ToolingExtension
                                                  ArrayOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                  ArrayOfCollectionOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfEnum✓ToolingExtension
                                                  MapOfEnum✓ToolingExtension
                                                  MapOfModel✓ToolingExtension
                                                  MapOfCollectionOfPrimitives✓ToolingExtension
                                                  MapOfCollectionOfModel✓ToolingExtension
                                                  MapOfCollectionOfEnum✓ToolingExtension

                                                  Documentation Feature​

                                                  NameSupportedDefined By
                                                  Readme✓ToolingExtension
                                                  Model✓ToolingExtension
                                                  Api✓ToolingExtension

                                                  Global Feature​

                                                  NameSupportedDefined By
                                                  Host✓OAS2,OAS3
                                                  BasePath✓OAS2,OAS3
                                                  Info✓OAS2,OAS3
                                                  Schemes✗OAS2,OAS3
                                                  PartialSchemes✓OAS2,OAS3
                                                  Consumes✓OAS2
                                                  Produces✓OAS2
                                                  ExternalDocumentation✓OAS2,OAS3
                                                  Examples✓OAS2,OAS3
                                                  XMLStructureDefinitions✗OAS2,OAS3
                                                  MultiServer✗OAS3
                                                  ParameterizedServer✗OAS3
                                                  ParameterStyling✗OAS3
                                                  Callbacks✗OAS3
                                                  LinkObjects✗OAS3

                                                  Parameter Feature​

                                                  NameSupportedDefined By
                                                  Path✓OAS2,OAS3
                                                  Query✓OAS2,OAS3
                                                  Header✓OAS2,OAS3
                                                  Body✓OAS2
                                                  FormUnencoded✓OAS2
                                                  FormMultipart✓OAS2
                                                  Cookie✓OAS3

                                                  Schema Support Feature​

                                                  NameSupportedDefined By
                                                  Simple✓OAS2,OAS3
                                                  Composite✓OAS2,OAS3
                                                  Polymorphism✗OAS2,OAS3
                                                  Union✗OAS3
                                                  allOf✗OAS2,OAS3
                                                  anyOf✗OAS3
                                                  oneOf✗OAS3
                                                  not✗OAS3

                                                  Security Feature​

                                                  NameSupportedDefined By
                                                  BasicAuth✗OAS2,OAS3
                                                  ApiKey✗OAS2,OAS3
                                                  OpenIDConnect✗OAS3
                                                  BearerToken✗OAS3
                                                  OAuth2_Implicit✗OAS2,OAS3
                                                  OAuth2_Password✗OAS2,OAS3
                                                  OAuth2_ClientCredentials✗OAS2,OAS3
                                                  OAuth2_AuthorizationCode✗OAS2,OAS3
                                                  SignatureAuth✗OAS3
                                                  AWSV4Signature✗ToolingExtension

                                                  Wire Format Feature​

                                                  NameSupportedDefined By
                                                  JSON✗OAS2,OAS3
                                                  XML✗OAS2,OAS3
                                                  PROTOBUF✗ToolingExtension
                                                  Custom✗OAS2,OAS3
                                                  - + \ No newline at end of file diff --git a/docs/generators/lua/index.html b/docs/generators/lua/index.html index e49967a9c08..8b57b463a49 100644 --- a/docs/generators/lua/index.html +++ b/docs/generators/lua/index.html @@ -15,13 +15,13 @@ - +

                                                  Documentation for the lua Generator

                                                  METADATA​

                                                  PropertyValueNotes
                                                  generator nameluapass this to the generate command after -g
                                                  generator stabilityBETA
                                                  generator typeCLIENT
                                                  generator languageLua
                                                  generator default templating enginemustache
                                                  helpTxtGenerates a Lua client library (beta).

                                                  CONFIG OPTIONS​

                                                  These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                  OptionDescriptionValuesDefault
                                                  hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                  packageNameLua package name (convention: single word).openapiclient
                                                  packageVersionLua package version.1.0.0-1

                                                  IMPORT MAPPING​

                                                  Type/AliasImports
                                                  *os.Fileos
                                                  osio/ioutil
                                                  time.Timetime

                                                  INSTANTIATION TYPES​

                                                  Type/AliasInstantiated By

                                                  LANGUAGE PRIMITIVES​

                                                  • boolean
                                                  • nil
                                                  • number
                                                  • string

                                                  RESERVED WORDS​

                                                  • and
                                                  • boolean
                                                  • break
                                                  • do
                                                  • else
                                                  • elseif
                                                  • end
                                                  • false
                                                  • for
                                                  • function
                                                  • if
                                                  • in
                                                  • local
                                                  • nil
                                                  • not
                                                  • number
                                                  • or
                                                  • repeat
                                                  • return
                                                  • string
                                                  • table
                                                  • then
                                                  • thread
                                                  • true
                                                  • until
                                                  • userdata
                                                  • while

                                                  FEATURE SET​

                                                  Client Modification Feature​

                                                  NameSupportedDefined By
                                                  BasePath✗ToolingExtension
                                                  Authorizations✗ToolingExtension
                                                  UserAgent✗ToolingExtension
                                                  MockServer✗ToolingExtension

                                                  Data Type Feature​

                                                  NameSupportedDefined By
                                                  Custom✗OAS2,OAS3
                                                  Int32✓OAS2,OAS3
                                                  Int64✓OAS2,OAS3
                                                  Float✓OAS2,OAS3
                                                  Double✓OAS2,OAS3
                                                  Decimal✓ToolingExtension
                                                  String✓OAS2,OAS3
                                                  Byte✓OAS2,OAS3
                                                  Binary✓OAS2,OAS3
                                                  Boolean✓OAS2,OAS3
                                                  Date✓OAS2,OAS3
                                                  DateTime✓OAS2,OAS3
                                                  Password✓OAS2,OAS3
                                                  File✓OAS2
                                                  Uuid✗
                                                  Array✓OAS2,OAS3
                                                  Null✗OAS3
                                                  AnyType✗OAS2,OAS3
                                                  Object✓OAS2,OAS3
                                                  Maps✓ToolingExtension
                                                  CollectionFormat✓OAS2
                                                  CollectionFormatMulti✓OAS2
                                                  Enum✓OAS2,OAS3
                                                  ArrayOfEnum✓ToolingExtension
                                                  ArrayOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                  ArrayOfCollectionOfModel✓ToolingExtension
                                                  ArrayOfCollectionOfEnum✓ToolingExtension
                                                  MapOfEnum✓ToolingExtension
                                                  MapOfModel✓ToolingExtension
                                                  MapOfCollectionOfPrimitives✓ToolingExtension
                                                  MapOfCollectionOfModel✓ToolingExtension
                                                  MapOfCollectionOfEnum✓ToolingExtension

                                                  Documentation Feature​

                                                  NameSupportedDefined By
                                                  Readme✓ToolingExtension
                                                  Model✓ToolingExtension
                                                  Api✓ToolingExtension

                                                  Global Feature​

                                                  NameSupportedDefined By
                                                  Host✓OAS2,OAS3
                                                  BasePath✓OAS2,OAS3
                                                  Info✓OAS2,OAS3
                                                  Schemes✗OAS2,OAS3
                                                  PartialSchemes✓OAS2,OAS3
                                                  Consumes✓OAS2
                                                  Produces✓OAS2
                                                  ExternalDocumentation✓OAS2,OAS3
                                                  Examples✓OAS2,OAS3
                                                  XMLStructureDefinitions✗OAS2,OAS3
                                                  MultiServer✗OAS3
                                                  ParameterizedServer✗OAS3
                                                  ParameterStyling✗OAS3
                                                  Callbacks✗OAS3
                                                  LinkObjects✗OAS3

                                                  Parameter Feature​

                                                  NameSupportedDefined By
                                                  Path✓OAS2,OAS3
                                                  Query✓OAS2,OAS3
                                                  Header✓OAS2,OAS3
                                                  Body✓OAS2
                                                  FormUnencoded✓OAS2
                                                  FormMultipart✓OAS2
                                                  Cookie✓OAS3

                                                  Schema Support Feature​

                                                  NameSupportedDefined By
                                                  Simple✓OAS2,OAS3
                                                  Composite✓OAS2,OAS3
                                                  Polymorphism✓OAS2,OAS3
                                                  Union✗OAS3
                                                  allOf✗OAS2,OAS3
                                                  anyOf✗OAS3
                                                  oneOf✗OAS3
                                                  not✗OAS3

                                                  Security Feature​

                                                  NameSupportedDefined By
                                                  BasicAuth✓OAS2,OAS3
                                                  ApiKey✓OAS2,OAS3
                                                  OpenIDConnect✗OAS3
                                                  BearerToken✗OAS3
                                                  OAuth2_Implicit✓OAS2,OAS3
                                                  OAuth2_Password✗OAS2,OAS3
                                                  OAuth2_ClientCredentials✗OAS2,OAS3
                                                  OAuth2_AuthorizationCode✗OAS2,OAS3
                                                  SignatureAuth✗OAS3
                                                  AWSV4Signature✗ToolingExtension

                                                  Wire Format Feature​

                                                  NameSupportedDefined By
                                                  JSON✓OAS2,OAS3
                                                  XML✓OAS2,OAS3
                                                  PROTOBUF✗ToolingExtension
                                                  Custom✗OAS2,OAS3
                                                  - + \ No newline at end of file diff --git a/docs/generators/markdown/index.html b/docs/generators/markdown/index.html index 845f4e3e228..70914679a32 100644 --- a/docs/generators/markdown/index.html +++ b/docs/generators/markdown/index.html @@ -15,13 +15,13 @@ - +

                                                  Documentation for the markdown Generator

                                                  METADATA​

                                                  PropertyValueNotes
                                                  generator namemarkdownpass this to the generate command after -g
                                                  generator stabilityBETA
                                                  generator typeDOCUMENTATION
                                                  generator default templating enginemustache
                                                  helpTxtGenerates a markdown documentation.

                                                  CONFIG OPTIONS​

                                                  These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                  OptionDescriptionValuesDefault
                                                  allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                  disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                  false
                                                  The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                  true
                                                  Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                  		true
                                                  ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                  enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                  false
                                                  No changes to the enum's are made, this is the default option.
                                                  true
                                                  With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                  		false
                                                  legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                  true
                                                  The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                  false
                                                  The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                  		true
                                                  prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                  sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                  sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                  IMPORT MAPPING​

                                                  Type/AliasImports

                                                  INSTANTIATION TYPES​

                                                  Type/AliasInstantiated By

                                                  LANGUAGE PRIMITIVES​

                                                  • ByteArray
                                                  • DateTime
                                                  • URI
                                                  • UUID
                                                  • boolean
                                                  • char
                                                  • date
                                                  • decimal
                                                  • double
                                                  • file
                                                  • float
                                                  • int
                                                  • integer
                                                  • long
                                                  • number
                                                  • object
                                                  • short
                                                  • string

                                                  RESERVED WORDS​

                                                    FEATURE SET​

                                                    Client Modification Feature​

                                                    NameSupportedDefined By
                                                    BasePath✗ToolingExtension
                                                    Authorizations✗ToolingExtension
                                                    UserAgent✗ToolingExtension
                                                    MockServer✗ToolingExtension

                                                    Data Type Feature​

                                                    NameSupportedDefined By
                                                    Custom✗OAS2,OAS3
                                                    Int32✓OAS2,OAS3
                                                    Int64✓OAS2,OAS3
                                                    Float✓OAS2,OAS3
                                                    Double✓OAS2,OAS3
                                                    Decimal✓ToolingExtension
                                                    String✓OAS2,OAS3
                                                    Byte✓OAS2,OAS3
                                                    Binary✓OAS2,OAS3
                                                    Boolean✓OAS2,OAS3
                                                    Date✓OAS2,OAS3
                                                    DateTime✓OAS2,OAS3
                                                    Password✓OAS2,OAS3
                                                    File✓OAS2
                                                    Uuid✗
                                                    Array✓OAS2,OAS3
                                                    Null✗OAS3
                                                    AnyType✗OAS2,OAS3
                                                    Object✓OAS2,OAS3
                                                    Maps✓ToolingExtension
                                                    CollectionFormat✓OAS2
                                                    CollectionFormatMulti✓OAS2
                                                    Enum✓OAS2,OAS3
                                                    ArrayOfEnum✓ToolingExtension
                                                    ArrayOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                    MapOfEnum✓ToolingExtension
                                                    MapOfModel✓ToolingExtension
                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                    MapOfCollectionOfModel✓ToolingExtension
                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                    Documentation Feature​

                                                    NameSupportedDefined By
                                                    Readme✗ToolingExtension
                                                    Model✓ToolingExtension
                                                    Api✓ToolingExtension

                                                    Global Feature​

                                                    NameSupportedDefined By
                                                    Host✓OAS2,OAS3
                                                    BasePath✓OAS2,OAS3
                                                    Info✓OAS2,OAS3
                                                    Schemes✗OAS2,OAS3
                                                    PartialSchemes✓OAS2,OAS3
                                                    Consumes✓OAS2
                                                    Produces✓OAS2
                                                    ExternalDocumentation✓OAS2,OAS3
                                                    Examples✓OAS2,OAS3
                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                    MultiServer✗OAS3
                                                    ParameterizedServer✗OAS3
                                                    ParameterStyling✗OAS3
                                                    Callbacks✓OAS3
                                                    LinkObjects✗OAS3

                                                    Parameter Feature​

                                                    NameSupportedDefined By
                                                    Path✓OAS2,OAS3
                                                    Query✓OAS2,OAS3
                                                    Header✓OAS2,OAS3
                                                    Body✓OAS2
                                                    FormUnencoded✓OAS2
                                                    FormMultipart✓OAS2
                                                    Cookie✓OAS3

                                                    Schema Support Feature​

                                                    NameSupportedDefined By
                                                    Simple✓OAS2,OAS3
                                                    Composite✓OAS2,OAS3
                                                    Polymorphism✓OAS2,OAS3
                                                    Union✗OAS3
                                                    allOf✗OAS2,OAS3
                                                    anyOf✗OAS3
                                                    oneOf✗OAS3
                                                    not✗OAS3

                                                    Security Feature​

                                                    NameSupportedDefined By
                                                    BasicAuth✓OAS2,OAS3
                                                    ApiKey✓OAS2,OAS3
                                                    OpenIDConnect✗OAS3
                                                    BearerToken✓OAS3
                                                    OAuth2_Implicit✓OAS2,OAS3
                                                    OAuth2_Password✓OAS2,OAS3
                                                    OAuth2_ClientCredentials✓OAS2,OAS3
                                                    OAuth2_AuthorizationCode✓OAS2,OAS3
                                                    SignatureAuth✗OAS3
                                                    AWSV4Signature✗ToolingExtension

                                                    Wire Format Feature​

                                                    NameSupportedDefined By
                                                    JSON✓OAS2,OAS3
                                                    XML✓OAS2,OAS3
                                                    PROTOBUF✗ToolingExtension
                                                    Custom✗OAS2,OAS3
                                                    - + \ No newline at end of file diff --git a/docs/generators/mysql-schema/index.html b/docs/generators/mysql-schema/index.html index 9be24eafd07..e5ab2e10367 100644 --- a/docs/generators/mysql-schema/index.html +++ b/docs/generators/mysql-schema/index.html @@ -15,13 +15,13 @@ - +

                                                    Documentation for the mysql-schema Generator

                                                    METADATA​

                                                    PropertyValueNotes
                                                    generator namemysql-schemapass this to the generate command after -g
                                                    generator stabilitySTABLE
                                                    generator typeSCHEMA
                                                    generator languageMysql
                                                    generator default templating enginemustache
                                                    helpTxtGenerates a MySQL schema based on the model or schema defined in the OpenAPI specification (v2, v3).

                                                    CONFIG OPTIONS​

                                                    These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                    OptionDescriptionValuesDefault
                                                    defaultDatabaseNameDefault database name for all MySQL queries
                                                    identifierNamingConventionNaming convention of MySQL identifiers(table names and column names). This is not related to database name which is defined by defaultDatabaseName option
                                                    original
                                                    Do not transform original names
                                                    snake_case
                                                    Use snake_case names
                                                    		original
                                                    jsonDataTypeEnabledUse special JSON MySQL data type for complex model properties. Requires MySQL version 5.7.8. Generates TEXT data type when disabledtrue
                                                    namedParametersEnabledGenerates model prepared SQLs with named parameters, eg. :petName. Question mark placeholder used when option disabled.false

                                                    IMPORT MAPPING​

                                                    Type/AliasImports

                                                    INSTANTIATION TYPES​

                                                    Type/AliasInstantiated By

                                                    LANGUAGE PRIMITIVES​

                                                    • BigDecimal
                                                    • ByteArray
                                                    • Date
                                                    • DateTime
                                                    • URI
                                                    • UUID
                                                    • binary
                                                    • bool
                                                    • boolean
                                                    • byte
                                                    • char
                                                    • date
                                                    • double
                                                    • file
                                                    • float
                                                    • int
                                                    • integer
                                                    • long
                                                    • mixed
                                                    • number
                                                    • short
                                                    • string
                                                    • void

                                                    RESERVED WORDS​

                                                    • accessible
                                                    • add
                                                    • all
                                                    • alter
                                                    • analyze
                                                    • and
                                                    • as
                                                    • asc
                                                    • asensitive
                                                    • before
                                                    • between
                                                    • bigint
                                                    • binary
                                                    • blob
                                                    • both
                                                    • by
                                                    • call
                                                    • cascade
                                                    • case
                                                    • change
                                                    • char
                                                    • character
                                                    • check
                                                    • collate
                                                    • column
                                                    • condition
                                                    • constraint
                                                    • continue
                                                    • convert
                                                    • create
                                                    • cross
                                                    • cube
                                                    • cume_dist
                                                    • current_date
                                                    • current_time
                                                    • current_timestamp
                                                    • current_user
                                                    • cursor
                                                    • database
                                                    • databases
                                                    • day_hour
                                                    • day_microsecond
                                                    • day_minute
                                                    • day_second
                                                    • dec
                                                    • decimal
                                                    • declare
                                                    • default
                                                    • delayed
                                                    • delete
                                                    • dense_rank
                                                    • desc
                                                    • describe
                                                    • deterministic
                                                    • distinct
                                                    • distinctrow
                                                    • div
                                                    • double
                                                    • drop
                                                    • dual
                                                    • each
                                                    • else
                                                    • elseif
                                                    • empty
                                                    • enclosed
                                                    • escaped
                                                    • except
                                                    • exists
                                                    • exit
                                                    • explain
                                                    • false
                                                    • fetch
                                                    • first_value
                                                    • float
                                                    • float4
                                                    • float8
                                                    • for
                                                    • force
                                                    • foreign
                                                    • from
                                                    • fulltext
                                                    • function
                                                    • generated
                                                    • get
                                                    • grant
                                                    • group
                                                    • grouping
                                                    • groups
                                                    • having
                                                    • high_priority
                                                    • hour_microsecond
                                                    • hour_minute
                                                    • hour_second
                                                    • if
                                                    • ignore
                                                    • in
                                                    • index
                                                    • infile
                                                    • inner
                                                    • inout
                                                    • insensitive
                                                    • insert
                                                    • int
                                                    • int1
                                                    • int2
                                                    • int3
                                                    • int4
                                                    • int8
                                                    • integer
                                                    • interval
                                                    • into
                                                    • io_after_gtids
                                                    • io_before_gtids
                                                    • is
                                                    • iterate
                                                    • join
                                                    • json_table
                                                    • key
                                                    • keys
                                                    • kill
                                                    • lag
                                                    • last_value
                                                    • lead
                                                    • leading
                                                    • leave
                                                    • left
                                                    • like
                                                    • limit
                                                    • linear
                                                    • lines
                                                    • load
                                                    • localtime
                                                    • localtimestamp
                                                    • lock
                                                    • long
                                                    • longblob
                                                    • longtext
                                                    • loop
                                                    • low_priority
                                                    • master_bind
                                                    • master_ssl_verify_server_cert
                                                    • match
                                                    • maxvalue
                                                    • mediumblob
                                                    • mediumint
                                                    • mediumtext
                                                    • middleint
                                                    • minute_microsecond
                                                    • minute_second
                                                    • mod
                                                    • modifies
                                                    • natural
                                                    • no_write_to_binlog
                                                    • not
                                                    • nth_value
                                                    • ntile
                                                    • null
                                                    • numeric
                                                    • of
                                                    • on
                                                    • optimize
                                                    • optimizer_costs
                                                    • option
                                                    • optionally
                                                    • or
                                                    • order
                                                    • out
                                                    • outer
                                                    • outfile
                                                    • over
                                                    • partition
                                                    • percent_rank
                                                    • persist
                                                    • persist_only
                                                    • precision
                                                    • primary
                                                    • procedure
                                                    • purge
                                                    • range
                                                    • rank
                                                    • read
                                                    • read_write
                                                    • reads
                                                    • real
                                                    • recursive
                                                    • references
                                                    • regexp
                                                    • release
                                                    • rename
                                                    • repeat
                                                    • replace
                                                    • require
                                                    • resignal
                                                    • restrict
                                                    • return
                                                    • revoke
                                                    • right
                                                    • rlike
                                                    • role
                                                    • row
                                                    • row_number
                                                    • rows
                                                    • schema
                                                    • schemas
                                                    • second_microsecond
                                                    • select
                                                    • sensitive
                                                    • separator
                                                    • set
                                                    • show
                                                    • signal
                                                    • smallint
                                                    • spatial
                                                    • specific
                                                    • sql
                                                    • sql_big_result
                                                    • sql_calc_found_rows
                                                    • sql_small_result
                                                    • sqlexception
                                                    • sqlstate
                                                    • sqlwarning
                                                    • ssl
                                                    • starting
                                                    • stored
                                                    • straight_join
                                                    • system
                                                    • table
                                                    • terminated
                                                    • then
                                                    • tinyblob
                                                    • tinyint
                                                    • tinytext
                                                    • to
                                                    • trailing
                                                    • trigger
                                                    • true
                                                    • undo
                                                    • union
                                                    • unique
                                                    • unlock
                                                    • unsigned
                                                    • update
                                                    • usage
                                                    • use
                                                    • using
                                                    • utc_date
                                                    • utc_time
                                                    • utc_timestamp
                                                    • values
                                                    • varbinary
                                                    • varchar
                                                    • varcharacter
                                                    • varying
                                                    • virtual
                                                    • when
                                                    • where
                                                    • while
                                                    • window
                                                    • with
                                                    • write
                                                    • xor
                                                    • year_month
                                                    • zerofill

                                                    FEATURE SET​

                                                    Client Modification Feature​

                                                    NameSupportedDefined By
                                                    BasePath✗ToolingExtension
                                                    Authorizations✗ToolingExtension
                                                    UserAgent✗ToolingExtension
                                                    MockServer✗ToolingExtension

                                                    Data Type Feature​

                                                    NameSupportedDefined By
                                                    Custom✗OAS2,OAS3
                                                    Int32✓OAS2,OAS3
                                                    Int64✓OAS2,OAS3
                                                    Float✓OAS2,OAS3
                                                    Double✓OAS2,OAS3
                                                    Decimal✓ToolingExtension
                                                    String✓OAS2,OAS3
                                                    Byte✓OAS2,OAS3
                                                    Binary✓OAS2,OAS3
                                                    Boolean✓OAS2,OAS3
                                                    Date✓OAS2,OAS3
                                                    DateTime✓OAS2,OAS3
                                                    Password✓OAS2,OAS3
                                                    File✓OAS2
                                                    Uuid✗
                                                    Array✓OAS2,OAS3
                                                    Null✗OAS3
                                                    AnyType✗OAS2,OAS3
                                                    Object✓OAS2,OAS3
                                                    Maps✓ToolingExtension
                                                    CollectionFormat✓OAS2
                                                    CollectionFormatMulti✓OAS2
                                                    Enum✓OAS2,OAS3
                                                    ArrayOfEnum✓ToolingExtension
                                                    ArrayOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                    MapOfEnum✓ToolingExtension
                                                    MapOfModel✓ToolingExtension
                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                    MapOfCollectionOfModel✓ToolingExtension
                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                    Documentation Feature​

                                                    NameSupportedDefined By
                                                    Readme✓ToolingExtension
                                                    Model✓ToolingExtension
                                                    Api✓ToolingExtension

                                                    Global Feature​

                                                    NameSupportedDefined By
                                                    Host✓OAS2,OAS3
                                                    BasePath✓OAS2,OAS3
                                                    Info✓OAS2,OAS3
                                                    Schemes✗OAS2,OAS3
                                                    PartialSchemes✓OAS2,OAS3
                                                    Consumes✓OAS2
                                                    Produces✓OAS2
                                                    ExternalDocumentation✓OAS2,OAS3
                                                    Examples✓OAS2,OAS3
                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                    MultiServer✗OAS3
                                                    ParameterizedServer✗OAS3
                                                    ParameterStyling✗OAS3
                                                    Callbacks✗OAS3
                                                    LinkObjects✗OAS3

                                                    Parameter Feature​

                                                    NameSupportedDefined By
                                                    Path✓OAS2,OAS3
                                                    Query✓OAS2,OAS3
                                                    Header✓OAS2,OAS3
                                                    Body✓OAS2
                                                    FormUnencoded✓OAS2
                                                    FormMultipart✓OAS2
                                                    Cookie✓OAS3

                                                    Schema Support Feature​

                                                    NameSupportedDefined By
                                                    Simple✓OAS2,OAS3
                                                    Composite✓OAS2,OAS3
                                                    Polymorphism✗OAS2,OAS3
                                                    Union✗OAS3
                                                    allOf✗OAS2,OAS3
                                                    anyOf✗OAS3
                                                    oneOf✗OAS3
                                                    not✗OAS3

                                                    Security Feature​

                                                    NameSupportedDefined By
                                                    BasicAuth✗OAS2,OAS3
                                                    ApiKey✗OAS2,OAS3
                                                    OpenIDConnect✗OAS3
                                                    BearerToken✗OAS3
                                                    OAuth2_Implicit✗OAS2,OAS3
                                                    OAuth2_Password✗OAS2,OAS3
                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                    OAuth2_AuthorizationCode✗OAS2,OAS3
                                                    SignatureAuth✗OAS3
                                                    AWSV4Signature✗ToolingExtension

                                                    Wire Format Feature​

                                                    NameSupportedDefined By
                                                    JSON✗OAS2,OAS3
                                                    XML✗OAS2,OAS3
                                                    PROTOBUF✗ToolingExtension
                                                    Custom✗OAS2,OAS3
                                                    - + \ No newline at end of file diff --git a/docs/generators/n4js/index.html b/docs/generators/n4js/index.html index 0d4c307d44a..5773598b025 100644 --- a/docs/generators/n4js/index.html +++ b/docs/generators/n4js/index.html @@ -15,13 +15,13 @@ - +

                                                    Documentation for the n4js Generator

                                                    METADATA​

                                                    PropertyValueNotes
                                                    generator namen4jspass this to the generate command after -g
                                                    generator stabilityBETA
                                                    generator typeCLIENT
                                                    generator languageJava
                                                    generator default templating enginemustache
                                                    helpTxtGenerates a n4js client.

                                                    CONFIG OPTIONS​

                                                    These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                    OptionDescriptionValuesDefault
                                                    apiNamePrefixPrefix that will be appended to all API names ('tags'). Default: empty string. e.g. Pet => Pet.null
                                                    apiPackagepackage for generated api classesnull
                                                    checkRequiredParamsNotNullIff true null-checks are performed for required parameters.null
                                                    checkSuperfluousBodyPropsIff true a new copy of the given body object is transmitted. This copy only contains those properties defined in its model specification.null
                                                    generateDefaultApiExecuterIff true a default implementation of the api executer interface is generated.null
                                                    modelPackagepackage for generated modelsnull

                                                    IMPORT MAPPING​

                                                    Type/AliasImports

                                                    INSTANTIATION TYPES​

                                                    Type/AliasInstantiated By

                                                    LANGUAGE PRIMITIVES​

                                                    • Array
                                                    • Error
                                                    • Object
                                                    • String
                                                    • any
                                                    • any+
                                                    • boolean
                                                    • int
                                                    • number
                                                    • object
                                                    • string

                                                    RESERVED WORDS​

                                                    • abstract
                                                    • await
                                                    • boolean
                                                    • break
                                                    • byte
                                                    • case
                                                    • catch
                                                    • char
                                                    • class
                                                    • const
                                                    • continue
                                                    • debugger
                                                    • default
                                                    • delete
                                                    • do
                                                    • double
                                                    • else
                                                    • enum
                                                    • export
                                                    • extends
                                                    • false
                                                    • final
                                                    • finally
                                                    • float
                                                    • for
                                                    • formParams
                                                    • function
                                                    • goto
                                                    • headerParams
                                                    • if
                                                    • implements
                                                    • import
                                                    • in
                                                    • instanceof
                                                    • int
                                                    • interface
                                                    • let
                                                    • long
                                                    • native
                                                    • new
                                                    • null
                                                    • package
                                                    • private
                                                    • protected
                                                    • public
                                                    • queryParameters
                                                    • requestOptions
                                                    • return
                                                    • short
                                                    • static
                                                    • super
                                                    • switch
                                                    • synchronized
                                                    • this
                                                    • throw
                                                    • transient
                                                    • true
                                                    • try
                                                    • typeof
                                                    • useFormData
                                                    • var
                                                    • varLocalDeferred
                                                    • varLocalPath
                                                    • void
                                                    • volatile
                                                    • while
                                                    • with
                                                    • yield

                                                    FEATURE SET​

                                                    Client Modification Feature​

                                                    NameSupportedDefined By
                                                    BasePath✗ToolingExtension
                                                    Authorizations✗ToolingExtension
                                                    UserAgent✗ToolingExtension
                                                    MockServer✗ToolingExtension

                                                    Data Type Feature​

                                                    NameSupportedDefined By
                                                    Custom✗OAS2,OAS3
                                                    Int32✓OAS2,OAS3
                                                    Int64✓OAS2,OAS3
                                                    Float✓OAS2,OAS3
                                                    Double✓OAS2,OAS3
                                                    Decimal✓ToolingExtension
                                                    String✓OAS2,OAS3
                                                    Byte✓OAS2,OAS3
                                                    Binary✓OAS2,OAS3
                                                    Boolean✓OAS2,OAS3
                                                    Date✓OAS2,OAS3
                                                    DateTime✓OAS2,OAS3
                                                    Password✓OAS2,OAS3
                                                    File✓OAS2
                                                    Uuid✗
                                                    Array✓OAS2,OAS3
                                                    Null✗OAS3
                                                    AnyType✗OAS2,OAS3
                                                    Object✓OAS2,OAS3
                                                    Maps✓ToolingExtension
                                                    CollectionFormat✓OAS2
                                                    CollectionFormatMulti✓OAS2
                                                    Enum✓OAS2,OAS3
                                                    ArrayOfEnum✓ToolingExtension
                                                    ArrayOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                    MapOfEnum✓ToolingExtension
                                                    MapOfModel✓ToolingExtension
                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                    MapOfCollectionOfModel✓ToolingExtension
                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                    Documentation Feature​

                                                    NameSupportedDefined By
                                                    Readme✗ToolingExtension
                                                    Model✓ToolingExtension
                                                    Api✓ToolingExtension

                                                    Global Feature​

                                                    NameSupportedDefined By
                                                    Host✓OAS2,OAS3
                                                    BasePath✓OAS2,OAS3
                                                    Info✓OAS2,OAS3
                                                    Schemes✗OAS2,OAS3
                                                    PartialSchemes✓OAS2,OAS3
                                                    Consumes✓OAS2
                                                    Produces✓OAS2
                                                    ExternalDocumentation✓OAS2,OAS3
                                                    Examples✓OAS2,OAS3
                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                    MultiServer✗OAS3
                                                    ParameterizedServer✗OAS3
                                                    ParameterStyling✗OAS3
                                                    Callbacks✓OAS3
                                                    LinkObjects✗OAS3

                                                    Parameter Feature​

                                                    NameSupportedDefined By
                                                    Path✓OAS2,OAS3
                                                    Query✓OAS2,OAS3
                                                    Header✓OAS2,OAS3
                                                    Body✓OAS2
                                                    FormUnencoded✓OAS2
                                                    FormMultipart✓OAS2
                                                    Cookie✓OAS3

                                                    Schema Support Feature​

                                                    NameSupportedDefined By
                                                    Simple✓OAS2,OAS3
                                                    Composite✓OAS2,OAS3
                                                    Polymorphism✓OAS2,OAS3
                                                    Union✗OAS3
                                                    allOf✗OAS2,OAS3
                                                    anyOf✗OAS3
                                                    oneOf✗OAS3
                                                    not✗OAS3

                                                    Security Feature​

                                                    NameSupportedDefined By
                                                    BasicAuth✓OAS2,OAS3
                                                    ApiKey✓OAS2,OAS3
                                                    OpenIDConnect✗OAS3
                                                    BearerToken✓OAS3
                                                    OAuth2_Implicit✓OAS2,OAS3
                                                    OAuth2_Password✓OAS2,OAS3
                                                    OAuth2_ClientCredentials✓OAS2,OAS3
                                                    OAuth2_AuthorizationCode✓OAS2,OAS3
                                                    SignatureAuth✗OAS3
                                                    AWSV4Signature✗ToolingExtension

                                                    Wire Format Feature​

                                                    NameSupportedDefined By
                                                    JSON✓OAS2,OAS3
                                                    XML✓OAS2,OAS3
                                                    PROTOBUF✗ToolingExtension
                                                    Custom✗OAS2,OAS3
                                                    - + \ No newline at end of file diff --git a/docs/generators/nim/index.html b/docs/generators/nim/index.html index cd2c709eca0..dcf2448ca72 100644 --- a/docs/generators/nim/index.html +++ b/docs/generators/nim/index.html @@ -15,13 +15,13 @@ - +

                                                    Documentation for the nim Generator

                                                    METADATA​

                                                    PropertyValueNotes
                                                    generator namenimpass this to the generate command after -g
                                                    generator stabilityBETA
                                                    generator typeCLIENT
                                                    generator languageNim
                                                    generator default templating enginemustache
                                                    helpTxtGenerates a nim client (beta).

                                                    CONFIG OPTIONS​

                                                    These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                    OptionDescriptionValuesDefault
                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                    disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                    false
                                                    The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                    true
                                                    Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                    		true
                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                    enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                    false
                                                    No changes to the enum's are made, this is the default option.
                                                    true
                                                    With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                    		false
                                                    legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                    true
                                                    The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                    false
                                                    The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                    		true
                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                    IMPORT MAPPING​

                                                    Type/AliasImports

                                                    INSTANTIATION TYPES​

                                                    Type/AliasInstantiated By

                                                    LANGUAGE PRIMITIVES​

                                                    • bool
                                                    • char
                                                    • cstring
                                                    • float
                                                    • float32
                                                    • float64
                                                    • int
                                                    • int16
                                                    • int32
                                                    • int64
                                                    • int8
                                                    • pointer
                                                    • string
                                                    • uint
                                                    • uint16
                                                    • uint32
                                                    • uint64
                                                    • uint8

                                                    RESERVED WORDS​

                                                    • addr
                                                    • and
                                                    • as
                                                    • asm
                                                    • bind
                                                    • block
                                                    • break
                                                    • case
                                                    • cast
                                                    • concept
                                                    • const
                                                    • continue
                                                    • converter
                                                    • defer
                                                    • discard
                                                    • distinct
                                                    • div
                                                    • do
                                                    • elif
                                                    • else
                                                    • end
                                                    • enum
                                                    • except
                                                    • export
                                                    • finally
                                                    • for
                                                    • from
                                                    • func
                                                    • if
                                                    • import
                                                    • in
                                                    • include
                                                    • interface
                                                    • is
                                                    • isnot
                                                    • iterator
                                                    • let
                                                    • macro
                                                    • method
                                                    • mixin
                                                    • mod
                                                    • nil
                                                    • not
                                                    • notin
                                                    • object
                                                    • of
                                                    • or
                                                    • out
                                                    • proc
                                                    • ptr
                                                    • raise
                                                    • ref
                                                    • return
                                                    • shl
                                                    • shr
                                                    • static
                                                    • template
                                                    • try
                                                    • tuple
                                                    • type
                                                    • using
                                                    • var
                                                    • when
                                                    • while
                                                    • xor
                                                    • yield

                                                    FEATURE SET​

                                                    Client Modification Feature​

                                                    NameSupportedDefined By
                                                    BasePath✓ToolingExtension
                                                    Authorizations✗ToolingExtension
                                                    UserAgent✓ToolingExtension
                                                    MockServer✗ToolingExtension

                                                    Data Type Feature​

                                                    NameSupportedDefined By
                                                    Custom✗OAS2,OAS3
                                                    Int32✓OAS2,OAS3
                                                    Int64✓OAS2,OAS3
                                                    Float✓OAS2,OAS3
                                                    Double✓OAS2,OAS3
                                                    Decimal✓ToolingExtension
                                                    String✓OAS2,OAS3
                                                    Byte✓OAS2,OAS3
                                                    Binary✓OAS2,OAS3
                                                    Boolean✓OAS2,OAS3
                                                    Date✓OAS2,OAS3
                                                    DateTime✓OAS2,OAS3
                                                    Password✓OAS2,OAS3
                                                    File✓OAS2
                                                    Uuid✗
                                                    Array✓OAS2,OAS3
                                                    Null✗OAS3
                                                    AnyType✗OAS2,OAS3
                                                    Object✓OAS2,OAS3
                                                    Maps✓ToolingExtension
                                                    CollectionFormat✓OAS2
                                                    CollectionFormatMulti✓OAS2
                                                    Enum✓OAS2,OAS3
                                                    ArrayOfEnum✓ToolingExtension
                                                    ArrayOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                    MapOfEnum✓ToolingExtension
                                                    MapOfModel✓ToolingExtension
                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                    MapOfCollectionOfModel✓ToolingExtension
                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                    Documentation Feature​

                                                    NameSupportedDefined By
                                                    Readme✓ToolingExtension
                                                    Model✓ToolingExtension
                                                    Api✓ToolingExtension

                                                    Global Feature​

                                                    NameSupportedDefined By
                                                    Host✓OAS2,OAS3
                                                    BasePath✓OAS2,OAS3
                                                    Info✓OAS2,OAS3
                                                    Schemes✗OAS2,OAS3
                                                    PartialSchemes✓OAS2,OAS3
                                                    Consumes✓OAS2
                                                    Produces✓OAS2
                                                    ExternalDocumentation✓OAS2,OAS3
                                                    Examples✓OAS2,OAS3
                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                    MultiServer✗OAS3
                                                    ParameterizedServer✗OAS3
                                                    ParameterStyling✗OAS3
                                                    Callbacks✗OAS3
                                                    LinkObjects✗OAS3

                                                    Parameter Feature​

                                                    NameSupportedDefined By
                                                    Path✓OAS2,OAS3
                                                    Query✓OAS2,OAS3
                                                    Header✓OAS2,OAS3
                                                    Body✓OAS2
                                                    FormUnencoded✓OAS2
                                                    FormMultipart✓OAS2
                                                    Cookie✗OAS3

                                                    Schema Support Feature​

                                                    NameSupportedDefined By
                                                    Simple✓OAS2,OAS3
                                                    Composite✓OAS2,OAS3
                                                    Polymorphism✗OAS2,OAS3
                                                    Union✗OAS3
                                                    allOf✗OAS2,OAS3
                                                    anyOf✗OAS3
                                                    oneOf✗OAS3
                                                    not✗OAS3

                                                    Security Feature​

                                                    NameSupportedDefined By
                                                    BasicAuth✗OAS2,OAS3
                                                    ApiKey✗OAS2,OAS3
                                                    OpenIDConnect✗OAS3
                                                    BearerToken✗OAS3
                                                    OAuth2_Implicit✗OAS2,OAS3
                                                    OAuth2_Password✗OAS2,OAS3
                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                    OAuth2_AuthorizationCode✗OAS2,OAS3
                                                    SignatureAuth✗OAS3
                                                    AWSV4Signature✗ToolingExtension

                                                    Wire Format Feature​

                                                    NameSupportedDefined By
                                                    JSON✓OAS2,OAS3
                                                    XML✗OAS2,OAS3
                                                    PROTOBUF✗ToolingExtension
                                                    Custom✗OAS2,OAS3
                                                    - + \ No newline at end of file diff --git a/docs/generators/nodejs-express-server/index.html b/docs/generators/nodejs-express-server/index.html index 01f244de1e3..ef0782766e4 100644 --- a/docs/generators/nodejs-express-server/index.html +++ b/docs/generators/nodejs-express-server/index.html @@ -15,13 +15,13 @@ - +

                                                    Documentation for the nodejs-express-server Generator

                                                    METADATA​

                                                    PropertyValueNotes
                                                    generator namenodejs-express-serverpass this to the generate command after -g
                                                    generator stabilityBETA
                                                    generator typeSERVER
                                                    generator languageJavascript
                                                    generator default templating enginemustache
                                                    helpTxtGenerates a NodeJS Express server (alpha). IMPORTANT: this generator may subject to breaking changes without further notice).

                                                    CONFIG OPTIONS​

                                                    These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                    OptionDescriptionValuesDefault
                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                    disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                    false
                                                    The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                    true
                                                    Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                    		true
                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                    enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                    false
                                                    No changes to the enum's are made, this is the default option.
                                                    true
                                                    With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                    		false
                                                    legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                    true
                                                    The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                    false
                                                    The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                    		true
                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                    serverPortTCP port to listen on.null
                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                    IMPORT MAPPING​

                                                    Type/AliasImports

                                                    INSTANTIATION TYPES​

                                                    Type/AliasInstantiated By

                                                    LANGUAGE PRIMITIVES​

                                                      RESERVED WORDS​

                                                      • break
                                                      • case
                                                      • catch
                                                      • class
                                                      • const
                                                      • continue
                                                      • debugger
                                                      • default
                                                      • delete
                                                      • do
                                                      • else
                                                      • export
                                                      • extends
                                                      • finally
                                                      • for
                                                      • function
                                                      • if
                                                      • import
                                                      • in
                                                      • instanceof
                                                      • let
                                                      • new
                                                      • return
                                                      • super
                                                      • switch
                                                      • this
                                                      • throw
                                                      • try
                                                      • typeof
                                                      • var
                                                      • void
                                                      • while
                                                      • with
                                                      • yield

                                                      FEATURE SET​

                                                      Client Modification Feature​

                                                      NameSupportedDefined By
                                                      BasePath✗ToolingExtension
                                                      Authorizations✗ToolingExtension
                                                      UserAgent✗ToolingExtension
                                                      MockServer✗ToolingExtension

                                                      Data Type Feature​

                                                      NameSupportedDefined By
                                                      Custom✗OAS2,OAS3
                                                      Int32✓OAS2,OAS3
                                                      Int64✓OAS2,OAS3
                                                      Float✓OAS2,OAS3
                                                      Double✓OAS2,OAS3
                                                      Decimal✓ToolingExtension
                                                      String✓OAS2,OAS3
                                                      Byte✓OAS2,OAS3
                                                      Binary✓OAS2,OAS3
                                                      Boolean✓OAS2,OAS3
                                                      Date✓OAS2,OAS3
                                                      DateTime✓OAS2,OAS3
                                                      Password✓OAS2,OAS3
                                                      File✓OAS2
                                                      Uuid✗
                                                      Array✓OAS2,OAS3
                                                      Null✗OAS3
                                                      AnyType✗OAS2,OAS3
                                                      Object✓OAS2,OAS3
                                                      Maps✓ToolingExtension
                                                      CollectionFormat✓OAS2
                                                      CollectionFormatMulti✓OAS2
                                                      Enum✓OAS2,OAS3
                                                      ArrayOfEnum✓ToolingExtension
                                                      ArrayOfModel✓ToolingExtension
                                                      ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                      ArrayOfCollectionOfModel✓ToolingExtension
                                                      ArrayOfCollectionOfEnum✓ToolingExtension
                                                      MapOfEnum✓ToolingExtension
                                                      MapOfModel✓ToolingExtension
                                                      MapOfCollectionOfPrimitives✓ToolingExtension
                                                      MapOfCollectionOfModel✓ToolingExtension
                                                      MapOfCollectionOfEnum✓ToolingExtension

                                                      Documentation Feature​

                                                      NameSupportedDefined By
                                                      Readme✓ToolingExtension
                                                      Model✓ToolingExtension
                                                      Api✓ToolingExtension

                                                      Global Feature​

                                                      NameSupportedDefined By
                                                      Host✓OAS2,OAS3
                                                      BasePath✓OAS2,OAS3
                                                      Info✓OAS2,OAS3
                                                      Schemes✗OAS2,OAS3
                                                      PartialSchemes✓OAS2,OAS3
                                                      Consumes✓OAS2
                                                      Produces✓OAS2
                                                      ExternalDocumentation✓OAS2,OAS3
                                                      Examples✓OAS2,OAS3
                                                      XMLStructureDefinitions✗OAS2,OAS3
                                                      MultiServer✗OAS3
                                                      ParameterizedServer✗OAS3
                                                      ParameterStyling✗OAS3
                                                      Callbacks✗OAS3
                                                      LinkObjects✗OAS3

                                                      Parameter Feature​

                                                      NameSupportedDefined By
                                                      Path✓OAS2,OAS3
                                                      Query✓OAS2,OAS3
                                                      Header✓OAS2,OAS3
                                                      Body✓OAS2
                                                      FormUnencoded✓OAS2
                                                      FormMultipart✓OAS2
                                                      Cookie✓OAS3

                                                      Schema Support Feature​

                                                      NameSupportedDefined By
                                                      Simple✓OAS2,OAS3
                                                      Composite✓OAS2,OAS3
                                                      Polymorphism✗OAS2,OAS3
                                                      Union✗OAS3
                                                      allOf✗OAS2,OAS3
                                                      anyOf✗OAS3
                                                      oneOf✗OAS3
                                                      not✗OAS3

                                                      Security Feature​

                                                      NameSupportedDefined By
                                                      BasicAuth✗OAS2,OAS3
                                                      ApiKey✗OAS2,OAS3
                                                      OpenIDConnect✗OAS3
                                                      BearerToken✗OAS3
                                                      OAuth2_Implicit✓OAS2,OAS3
                                                      OAuth2_Password✗OAS2,OAS3
                                                      OAuth2_ClientCredentials✗OAS2,OAS3
                                                      OAuth2_AuthorizationCode✗OAS2,OAS3
                                                      SignatureAuth✗OAS3
                                                      AWSV4Signature✗ToolingExtension

                                                      Wire Format Feature​

                                                      NameSupportedDefined By
                                                      JSON✓OAS2,OAS3
                                                      XML✗OAS2,OAS3
                                                      PROTOBUF✗ToolingExtension
                                                      Custom✗OAS2,OAS3
                                                      - + \ No newline at end of file diff --git a/docs/generators/objc/index.html b/docs/generators/objc/index.html index e0af543859c..3971cfd4d60 100644 --- a/docs/generators/objc/index.html +++ b/docs/generators/objc/index.html @@ -15,13 +15,13 @@ - +

                                                      Documentation for the objc Generator

                                                      METADATA​

                                                      PropertyValueNotes
                                                      generator nameobjcpass this to the generate command after -g
                                                      generator stabilitySTABLE
                                                      generator typeCLIENT
                                                      generator languageObjective-C
                                                      generator default templating enginemustache
                                                      helpTxtGenerates an Objective-C client library.

                                                      CONFIG OPTIONS​

                                                      These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                      OptionDescriptionValuesDefault
                                                      authorEmailEmail to use in the podspec file.team@openapitools.org
                                                      authorNameName to use in the podspec file.OpenAPI
                                                      classPrefixprefix for generated classes (convention: Abbreviation of pod name e.g. HN for HackerNews).`OAI
                                                      coreDataShould generate core data modelsfalse
                                                      gitRepoURLURL for the git repo where this podspec should point to.https://github.com/openapitools/openapi-generator
                                                      hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                      podNamecocoapods package name (convention: CameCase).OpenAPIClient
                                                      podVersioncocoapods package version.1.0.0

                                                      IMPORT MAPPING​

                                                      Type/AliasImports

                                                      INSTANTIATION TYPES​

                                                      Type/AliasInstantiated By
                                                      arrayNSMutableArray
                                                      mapNSMutableDictionary

                                                      LANGUAGE PRIMITIVES​

                                                      • BOOL
                                                      • NSData
                                                      • NSDate
                                                      • NSNumber
                                                      • NSObject
                                                      • NSString
                                                      • NSURL
                                                      • bool

                                                      RESERVED WORDS​

                                                      • _packed
                                                      • authsettings
                                                      • auto
                                                      • bodyparam
                                                      • break
                                                      • case
                                                      • cgfloat
                                                      • char
                                                      • class
                                                      • const
                                                      • continue
                                                      • default
                                                      • description
                                                      • do
                                                      • double
                                                      • else
                                                      • enum
                                                      • extern
                                                      • float
                                                      • for
                                                      • formparams
                                                      • goto
                                                      • headerparams
                                                      • id
                                                      • if
                                                      • implementation
                                                      • int
                                                      • interface
                                                      • localvarfiles
                                                      • long
                                                      • nonatomic
                                                      • nsinteger
                                                      • nsnumber
                                                      • nsobject
                                                      • pathparams
                                                      • property
                                                      • protocol
                                                      • queryparams
                                                      • readonly
                                                      • readwrite
                                                      • register
                                                      • requestcontenttype
                                                      • resourcepath
                                                      • responsecontenttype
                                                      • retain
                                                      • return
                                                      • short
                                                      • signed
                                                      • sizeof
                                                      • static
                                                      • strong
                                                      • struct
                                                      • switch
                                                      • typedef
                                                      • union
                                                      • unsafe_unretained
                                                      • unsigned
                                                      • void
                                                      • volatile
                                                      • weak
                                                      • while

                                                      FEATURE SET​

                                                      Client Modification Feature​

                                                      NameSupportedDefined By
                                                      BasePath✓ToolingExtension
                                                      Authorizations✗ToolingExtension
                                                      UserAgent✓ToolingExtension
                                                      MockServer✗ToolingExtension

                                                      Data Type Feature​

                                                      NameSupportedDefined By
                                                      Custom✗OAS2,OAS3
                                                      Int32✓OAS2,OAS3
                                                      Int64✓OAS2,OAS3
                                                      Float✓OAS2,OAS3
                                                      Double✓OAS2,OAS3
                                                      Decimal✓ToolingExtension
                                                      String✓OAS2,OAS3
                                                      Byte✓OAS2,OAS3
                                                      Binary✓OAS2,OAS3
                                                      Boolean✓OAS2,OAS3
                                                      Date✓OAS2,OAS3
                                                      DateTime✓OAS2,OAS3
                                                      Password✓OAS2,OAS3
                                                      File✓OAS2
                                                      Uuid✗
                                                      Array✓OAS2,OAS3
                                                      Null✗OAS3
                                                      AnyType✗OAS2,OAS3
                                                      Object✓OAS2,OAS3
                                                      Maps✓ToolingExtension
                                                      CollectionFormat✓OAS2
                                                      CollectionFormatMulti✓OAS2
                                                      Enum✓OAS2,OAS3
                                                      ArrayOfEnum✓ToolingExtension
                                                      ArrayOfModel✓ToolingExtension
                                                      ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                      ArrayOfCollectionOfModel✓ToolingExtension
                                                      ArrayOfCollectionOfEnum✓ToolingExtension
                                                      MapOfEnum✓ToolingExtension
                                                      MapOfModel✓ToolingExtension
                                                      MapOfCollectionOfPrimitives✓ToolingExtension
                                                      MapOfCollectionOfModel✓ToolingExtension
                                                      MapOfCollectionOfEnum✓ToolingExtension

                                                      Documentation Feature​

                                                      NameSupportedDefined By
                                                      Readme✓ToolingExtension
                                                      Model✓ToolingExtension
                                                      Api✓ToolingExtension

                                                      Global Feature​

                                                      NameSupportedDefined By
                                                      Host✓OAS2,OAS3
                                                      BasePath✓OAS2,OAS3
                                                      Info✓OAS2,OAS3
                                                      Schemes✗OAS2,OAS3
                                                      PartialSchemes✓OAS2,OAS3
                                                      Consumes✓OAS2
                                                      Produces✓OAS2
                                                      ExternalDocumentation✓OAS2,OAS3
                                                      Examples✓OAS2,OAS3
                                                      XMLStructureDefinitions✗OAS2,OAS3
                                                      MultiServer✗OAS3
                                                      ParameterizedServer✗OAS3
                                                      ParameterStyling✗OAS3
                                                      Callbacks✗OAS3
                                                      LinkObjects✗OAS3

                                                      Parameter Feature​

                                                      NameSupportedDefined By
                                                      Path✓OAS2,OAS3
                                                      Query✓OAS2,OAS3
                                                      Header✓OAS2,OAS3
                                                      Body✓OAS2
                                                      FormUnencoded✓OAS2
                                                      FormMultipart✓OAS2
                                                      Cookie✓OAS3

                                                      Schema Support Feature​

                                                      NameSupportedDefined By
                                                      Simple✓OAS2,OAS3
                                                      Composite✓OAS2,OAS3
                                                      Polymorphism✓OAS2,OAS3
                                                      Union✗OAS3
                                                      allOf✗OAS2,OAS3
                                                      anyOf✗OAS3
                                                      oneOf✗OAS3
                                                      not✗OAS3

                                                      Security Feature​

                                                      NameSupportedDefined By
                                                      BasicAuth✓OAS2,OAS3
                                                      ApiKey✓OAS2,OAS3
                                                      OpenIDConnect✗OAS3
                                                      BearerToken✗OAS3
                                                      OAuth2_Implicit✓OAS2,OAS3
                                                      OAuth2_Password✗OAS2,OAS3
                                                      OAuth2_ClientCredentials✗OAS2,OAS3
                                                      OAuth2_AuthorizationCode✗OAS2,OAS3
                                                      SignatureAuth✗OAS3
                                                      AWSV4Signature✗ToolingExtension

                                                      Wire Format Feature​

                                                      NameSupportedDefined By
                                                      JSON✓OAS2,OAS3
                                                      XML✗OAS2,OAS3
                                                      PROTOBUF✗ToolingExtension
                                                      Custom✗OAS2,OAS3
                                                      - + \ No newline at end of file diff --git a/docs/generators/ocaml/index.html b/docs/generators/ocaml/index.html index 4ad1065e7c1..3eef5ab4fba 100644 --- a/docs/generators/ocaml/index.html +++ b/docs/generators/ocaml/index.html @@ -15,13 +15,13 @@ - +

                                                      Documentation for the ocaml Generator

                                                      METADATA​

                                                      PropertyValueNotes
                                                      generator nameocamlpass this to the generate command after -g
                                                      generator stabilitySTABLE
                                                      generator typeCLIENT
                                                      generator languageOCaml
                                                      generator default templating enginemustache
                                                      helpTxtGenerates an OCaml client library (beta).

                                                      CONFIG OPTIONS​

                                                      These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                      OptionDescriptionValuesDefault
                                                      allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                      disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                      false
                                                      The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                      true
                                                      Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                      		true
                                                      ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                      enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                      false
                                                      No changes to the enum's are made, this is the default option.
                                                      true
                                                      With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                      		false
                                                      legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                      true
                                                      The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                      false
                                                      The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                      		true
                                                      prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                      sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                      sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                      IMPORT MAPPING​

                                                      Type/AliasImports

                                                      INSTANTIATION TYPES​

                                                      Type/AliasInstantiated By

                                                      LANGUAGE PRIMITIVES​

                                                      • Yojson.Safe.t
                                                      • bool
                                                      • bytes
                                                      • char
                                                      • float
                                                      • int
                                                      • int32
                                                      • int64
                                                      • list
                                                      • string

                                                      RESERVED WORDS​

                                                      • and
                                                      • as
                                                      • asr
                                                      • assert
                                                      • begin
                                                      • class
                                                      • constraint
                                                      • do
                                                      • done
                                                      • downto
                                                      • else
                                                      • end
                                                      • exception
                                                      • external
                                                      • false
                                                      • for
                                                      • fun
                                                      • function
                                                      • functor
                                                      • if
                                                      • in
                                                      • include
                                                      • inherit
                                                      • initializer
                                                      • land
                                                      • lazy
                                                      • let
                                                      • lor
                                                      • lsl
                                                      • lsr
                                                      • lxor
                                                      • match
                                                      • method
                                                      • mod
                                                      • module
                                                      • mutable
                                                      • new
                                                      • nonrec
                                                      • object
                                                      • of
                                                      • open
                                                      • or
                                                      • private
                                                      • rec
                                                      • result
                                                      • sig
                                                      • struct
                                                      • then
                                                      • to
                                                      • true
                                                      • try
                                                      • type
                                                      • val
                                                      • virtual
                                                      • when
                                                      • while
                                                      • with

                                                      FEATURE SET​

                                                      Client Modification Feature​

                                                      NameSupportedDefined By
                                                      BasePath✓ToolingExtension
                                                      Authorizations✗ToolingExtension
                                                      UserAgent✗ToolingExtension
                                                      MockServer✗ToolingExtension

                                                      Data Type Feature​

                                                      NameSupportedDefined By
                                                      Custom✗OAS2,OAS3
                                                      Int32✓OAS2,OAS3
                                                      Int64✓OAS2,OAS3
                                                      Float✓OAS2,OAS3
                                                      Double✓OAS2,OAS3
                                                      Decimal✓ToolingExtension
                                                      String✓OAS2,OAS3
                                                      Byte✓OAS2,OAS3
                                                      Binary✓OAS2,OAS3
                                                      Boolean✓OAS2,OAS3
                                                      Date✓OAS2,OAS3
                                                      DateTime✓OAS2,OAS3
                                                      Password✓OAS2,OAS3
                                                      File✓OAS2
                                                      Uuid✗
                                                      Array✓OAS2,OAS3
                                                      Null✗OAS3
                                                      AnyType✗OAS2,OAS3
                                                      Object✓OAS2,OAS3
                                                      Maps✓ToolingExtension
                                                      CollectionFormat✓OAS2
                                                      CollectionFormatMulti✓OAS2
                                                      Enum✓OAS2,OAS3
                                                      ArrayOfEnum✓ToolingExtension
                                                      ArrayOfModel✓ToolingExtension
                                                      ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                      ArrayOfCollectionOfModel✓ToolingExtension
                                                      ArrayOfCollectionOfEnum✓ToolingExtension
                                                      MapOfEnum✓ToolingExtension
                                                      MapOfModel✓ToolingExtension
                                                      MapOfCollectionOfPrimitives✓ToolingExtension
                                                      MapOfCollectionOfModel✓ToolingExtension
                                                      MapOfCollectionOfEnum✓ToolingExtension

                                                      Documentation Feature​

                                                      NameSupportedDefined By
                                                      Readme✓ToolingExtension
                                                      Model✓ToolingExtension
                                                      Api✓ToolingExtension

                                                      Global Feature​

                                                      NameSupportedDefined By
                                                      Host✓OAS2,OAS3
                                                      BasePath✓OAS2,OAS3
                                                      Info✓OAS2,OAS3
                                                      Schemes✗OAS2,OAS3
                                                      PartialSchemes✓OAS2,OAS3
                                                      Consumes✓OAS2
                                                      Produces✓OAS2
                                                      ExternalDocumentation✓OAS2,OAS3
                                                      Examples✓OAS2,OAS3
                                                      XMLStructureDefinitions✗OAS2,OAS3
                                                      MultiServer✗OAS3
                                                      ParameterizedServer✗OAS3
                                                      ParameterStyling✗OAS3
                                                      Callbacks✗OAS3
                                                      LinkObjects✗OAS3

                                                      Parameter Feature​

                                                      NameSupportedDefined By
                                                      Path✓OAS2,OAS3
                                                      Query✓OAS2,OAS3
                                                      Header✓OAS2,OAS3
                                                      Body✓OAS2
                                                      FormUnencoded✓OAS2
                                                      FormMultipart✓OAS2
                                                      Cookie✓OAS3

                                                      Schema Support Feature​

                                                      NameSupportedDefined By
                                                      Simple✓OAS2,OAS3
                                                      Composite✓OAS2,OAS3
                                                      Polymorphism✗OAS2,OAS3
                                                      Union✗OAS3
                                                      allOf✗OAS2,OAS3
                                                      anyOf✗OAS3
                                                      oneOf✗OAS3
                                                      not✗OAS3

                                                      Security Feature​

                                                      NameSupportedDefined By
                                                      BasicAuth✗OAS2,OAS3
                                                      ApiKey✓OAS2,OAS3
                                                      OpenIDConnect✗OAS3
                                                      BearerToken✗OAS3
                                                      OAuth2_Implicit✗OAS2,OAS3
                                                      OAuth2_Password✗OAS2,OAS3
                                                      OAuth2_ClientCredentials✗OAS2,OAS3
                                                      OAuth2_AuthorizationCode✗OAS2,OAS3
                                                      SignatureAuth✗OAS3
                                                      AWSV4Signature✗ToolingExtension

                                                      Wire Format Feature​

                                                      NameSupportedDefined By
                                                      JSON✓OAS2,OAS3
                                                      XML✗OAS2,OAS3
                                                      PROTOBUF✗ToolingExtension
                                                      Custom✗OAS2,OAS3
                                                      - + \ No newline at end of file diff --git a/docs/generators/openapi-yaml/index.html b/docs/generators/openapi-yaml/index.html index a6c74045bdb..56f2bb7e19e 100644 --- a/docs/generators/openapi-yaml/index.html +++ b/docs/generators/openapi-yaml/index.html @@ -15,13 +15,13 @@ - +

                                                      Documentation for the openapi-yaml Generator

                                                      METADATA​

                                                      PropertyValueNotes
                                                      generator nameopenapi-yamlpass this to the generate command after -g
                                                      generator stabilitySTABLE
                                                      generator typeDOCUMENTATION
                                                      generator default templating enginemustache
                                                      helpTxtCreates a static openapi.yaml file (OpenAPI spec v3).

                                                      CONFIG OPTIONS​

                                                      These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                      OptionDescriptionValuesDefault
                                                      allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                      disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                      false
                                                      The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                      true
                                                      Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                      		true
                                                      ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                      enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                      false
                                                      No changes to the enum's are made, this is the default option.
                                                      true
                                                      With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                      		false
                                                      legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                      true
                                                      The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                      false
                                                      The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                      		true
                                                      outputFileOutput filenameopenapi/openapi.yaml
                                                      prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                      sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                      sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                      IMPORT MAPPING​

                                                      Type/AliasImports

                                                      INSTANTIATION TYPES​

                                                      Type/AliasInstantiated By

                                                      LANGUAGE PRIMITIVES​

                                                        RESERVED WORDS​

                                                          FEATURE SET​

                                                          Client Modification Feature​

                                                          NameSupportedDefined By
                                                          BasePath✗ToolingExtension
                                                          Authorizations✗ToolingExtension
                                                          UserAgent✗ToolingExtension
                                                          MockServer✗ToolingExtension

                                                          Data Type Feature​

                                                          NameSupportedDefined By
                                                          Custom✓OAS2,OAS3
                                                          Int32✓OAS2,OAS3
                                                          Int64✓OAS2,OAS3
                                                          Float✓OAS2,OAS3
                                                          Double✓OAS2,OAS3
                                                          Decimal✓ToolingExtension
                                                          String✓OAS2,OAS3
                                                          Byte✓OAS2,OAS3
                                                          Binary✓OAS2,OAS3
                                                          Boolean✓OAS2,OAS3
                                                          Date✓OAS2,OAS3
                                                          DateTime✓OAS2,OAS3
                                                          Password✓OAS2,OAS3
                                                          File✓OAS2
                                                          Uuid✓
                                                          Array✓OAS2,OAS3
                                                          Null✓OAS3
                                                          AnyType✓OAS2,OAS3
                                                          Object✓OAS2,OAS3
                                                          Maps✓ToolingExtension
                                                          CollectionFormat✓OAS2
                                                          CollectionFormatMulti✓OAS2
                                                          Enum✓OAS2,OAS3
                                                          ArrayOfEnum✓ToolingExtension
                                                          ArrayOfModel✓ToolingExtension
                                                          ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                          ArrayOfCollectionOfModel✓ToolingExtension
                                                          ArrayOfCollectionOfEnum✓ToolingExtension
                                                          MapOfEnum✓ToolingExtension
                                                          MapOfModel✓ToolingExtension
                                                          MapOfCollectionOfPrimitives✓ToolingExtension
                                                          MapOfCollectionOfModel✓ToolingExtension
                                                          MapOfCollectionOfEnum✓ToolingExtension

                                                          Documentation Feature​

                                                          NameSupportedDefined By
                                                          Readme✓ToolingExtension
                                                          Model✓ToolingExtension
                                                          Api✓ToolingExtension

                                                          Global Feature​

                                                          NameSupportedDefined By
                                                          Host✓OAS2,OAS3
                                                          BasePath✓OAS2,OAS3
                                                          Info✓OAS2,OAS3
                                                          Schemes✓OAS2,OAS3
                                                          PartialSchemes✓OAS2,OAS3
                                                          Consumes✓OAS2
                                                          Produces✓OAS2
                                                          ExternalDocumentation✓OAS2,OAS3
                                                          Examples✓OAS2,OAS3
                                                          XMLStructureDefinitions✓OAS2,OAS3
                                                          MultiServer✓OAS3
                                                          ParameterizedServer✓OAS3
                                                          ParameterStyling✓OAS3
                                                          Callbacks✓OAS3
                                                          LinkObjects✓OAS3

                                                          Parameter Feature​

                                                          NameSupportedDefined By
                                                          Path✓OAS2,OAS3
                                                          Query✓OAS2,OAS3
                                                          Header✓OAS2,OAS3
                                                          Body✓OAS2
                                                          FormUnencoded✓OAS2
                                                          FormMultipart✓OAS2
                                                          Cookie✓OAS3

                                                          Schema Support Feature​

                                                          NameSupportedDefined By
                                                          Simple✓OAS2,OAS3
                                                          Composite✓OAS2,OAS3
                                                          Polymorphism✓OAS2,OAS3
                                                          Union✓OAS3
                                                          allOf✓OAS2,OAS3
                                                          anyOf✓OAS3
                                                          oneOf✓OAS3
                                                          not✓OAS3

                                                          Security Feature​

                                                          NameSupportedDefined By
                                                          BasicAuth✓OAS2,OAS3
                                                          ApiKey✓OAS2,OAS3
                                                          OpenIDConnect✓OAS3
                                                          BearerToken✓OAS3
                                                          OAuth2_Implicit✓OAS2,OAS3
                                                          OAuth2_Password✓OAS2,OAS3
                                                          OAuth2_ClientCredentials✓OAS2,OAS3
                                                          OAuth2_AuthorizationCode✓OAS2,OAS3
                                                          SignatureAuth✓OAS3
                                                          AWSV4Signature✓ToolingExtension

                                                          Wire Format Feature​

                                                          NameSupportedDefined By
                                                          JSON✓OAS2,OAS3
                                                          XML✓OAS2,OAS3
                                                          PROTOBUF✓ToolingExtension
                                                          Custom✓OAS2,OAS3
                                                          - + \ No newline at end of file diff --git a/docs/generators/openapi/index.html b/docs/generators/openapi/index.html index 09716bcdce7..a80a7f770c6 100644 --- a/docs/generators/openapi/index.html +++ b/docs/generators/openapi/index.html @@ -15,13 +15,13 @@ - +

                                                          Documentation for the openapi Generator

                                                          METADATA​

                                                          PropertyValueNotes
                                                          generator nameopenapipass this to the generate command after -g
                                                          generator stabilitySTABLE
                                                          generator typeDOCUMENTATION
                                                          generator default templating enginemustache
                                                          helpTxtCreates a static openapi.json file (OpenAPI spec v3.0).

                                                          CONFIG OPTIONS​

                                                          These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                          OptionDescriptionValuesDefault
                                                          allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                          disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                          false
                                                          The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                          true
                                                          Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                          		true
                                                          ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                          enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                          false
                                                          No changes to the enum's are made, this is the default option.
                                                          true
                                                          With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                          		false
                                                          legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                          true
                                                          The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                          false
                                                          The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                          		true
                                                          outputFileNameOutput file nameopenapi.json
                                                          prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                          sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                          sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                          IMPORT MAPPING​

                                                          Type/AliasImports

                                                          INSTANTIATION TYPES​

                                                          Type/AliasInstantiated By

                                                          LANGUAGE PRIMITIVES​

                                                            RESERVED WORDS​

                                                              FEATURE SET​

                                                              Client Modification Feature​

                                                              NameSupportedDefined By
                                                              BasePath✗ToolingExtension
                                                              Authorizations✗ToolingExtension
                                                              UserAgent✗ToolingExtension
                                                              MockServer✗ToolingExtension

                                                              Data Type Feature​

                                                              NameSupportedDefined By
                                                              Custom✓OAS2,OAS3
                                                              Int32✓OAS2,OAS3
                                                              Int64✓OAS2,OAS3
                                                              Float✓OAS2,OAS3
                                                              Double✓OAS2,OAS3
                                                              Decimal✓ToolingExtension
                                                              String✓OAS2,OAS3
                                                              Byte✓OAS2,OAS3
                                                              Binary✓OAS2,OAS3
                                                              Boolean✓OAS2,OAS3
                                                              Date✓OAS2,OAS3
                                                              DateTime✓OAS2,OAS3
                                                              Password✓OAS2,OAS3
                                                              File✓OAS2
                                                              Uuid✓
                                                              Array✓OAS2,OAS3
                                                              Null✓OAS3
                                                              AnyType✓OAS2,OAS3
                                                              Object✓OAS2,OAS3
                                                              Maps✓ToolingExtension
                                                              CollectionFormat✓OAS2
                                                              CollectionFormatMulti✓OAS2
                                                              Enum✓OAS2,OAS3
                                                              ArrayOfEnum✓ToolingExtension
                                                              ArrayOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                              ArrayOfCollectionOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                                              MapOfEnum✓ToolingExtension
                                                              MapOfModel✓ToolingExtension
                                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                                              MapOfCollectionOfModel✓ToolingExtension
                                                              MapOfCollectionOfEnum✓ToolingExtension

                                                              Documentation Feature​

                                                              NameSupportedDefined By
                                                              Readme✓ToolingExtension
                                                              Model✓ToolingExtension
                                                              Api✓ToolingExtension

                                                              Global Feature​

                                                              NameSupportedDefined By
                                                              Host✓OAS2,OAS3
                                                              BasePath✓OAS2,OAS3
                                                              Info✓OAS2,OAS3
                                                              Schemes✓OAS2,OAS3
                                                              PartialSchemes✓OAS2,OAS3
                                                              Consumes✓OAS2
                                                              Produces✓OAS2
                                                              ExternalDocumentation✓OAS2,OAS3
                                                              Examples✓OAS2,OAS3
                                                              XMLStructureDefinitions✓OAS2,OAS3
                                                              MultiServer✓OAS3
                                                              ParameterizedServer✓OAS3
                                                              ParameterStyling✓OAS3
                                                              Callbacks✓OAS3
                                                              LinkObjects✓OAS3

                                                              Parameter Feature​

                                                              NameSupportedDefined By
                                                              Path✓OAS2,OAS3
                                                              Query✓OAS2,OAS3
                                                              Header✓OAS2,OAS3
                                                              Body✓OAS2
                                                              FormUnencoded✓OAS2
                                                              FormMultipart✓OAS2
                                                              Cookie✓OAS3

                                                              Schema Support Feature​

                                                              NameSupportedDefined By
                                                              Simple✓OAS2,OAS3
                                                              Composite✓OAS2,OAS3
                                                              Polymorphism✓OAS2,OAS3
                                                              Union✓OAS3
                                                              allOf✓OAS2,OAS3
                                                              anyOf✓OAS3
                                                              oneOf✓OAS3
                                                              not✓OAS3

                                                              Security Feature​

                                                              NameSupportedDefined By
                                                              BasicAuth✓OAS2,OAS3
                                                              ApiKey✓OAS2,OAS3
                                                              OpenIDConnect✓OAS3
                                                              BearerToken✓OAS3
                                                              OAuth2_Implicit✓OAS2,OAS3
                                                              OAuth2_Password✓OAS2,OAS3
                                                              OAuth2_ClientCredentials✓OAS2,OAS3
                                                              OAuth2_AuthorizationCode✓OAS2,OAS3
                                                              SignatureAuth✓OAS3
                                                              AWSV4Signature✓ToolingExtension

                                                              Wire Format Feature​

                                                              NameSupportedDefined By
                                                              JSON✓OAS2,OAS3
                                                              XML✓OAS2,OAS3
                                                              PROTOBUF✓ToolingExtension
                                                              Custom✓OAS2,OAS3
                                                              - + \ No newline at end of file diff --git a/docs/generators/perl/index.html b/docs/generators/perl/index.html index 4f42af0f2bb..a0746f3422b 100644 --- a/docs/generators/perl/index.html +++ b/docs/generators/perl/index.html @@ -15,13 +15,13 @@ - +

                                                              Documentation for the perl Generator

                                                              METADATA​

                                                              PropertyValueNotes
                                                              generator nameperlpass this to the generate command after -g
                                                              generator stabilitySTABLE
                                                              generator typeCLIENT
                                                              generator languagePerl
                                                              generator default templating enginemustache
                                                              helpTxtGenerates a Perl client library.

                                                              CONFIG OPTIONS​

                                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                              OptionDescriptionValuesDefault
                                                              ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                              hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                              moduleNamePerl module name (convention: CamelCase or Long::Module).OpenAPIClient
                                                              moduleVersionPerl module version.1.0.0
                                                              prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                              sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                              IMPORT MAPPING​

                                                              Type/AliasImports

                                                              INSTANTIATION TYPES​

                                                              Type/AliasInstantiated By

                                                              LANGUAGE PRIMITIVES​

                                                              • ARRAY
                                                              • DATE
                                                              • DATE_TIME
                                                              • HASH
                                                              • boolean
                                                              • double
                                                              • int
                                                              • object
                                                              • string

                                                              RESERVED WORDS​

                                                              • __end__
                                                              • __file__
                                                              • __line__
                                                              • __package__
                                                              • and
                                                              • cmp
                                                              • continue
                                                              • core
                                                              • do
                                                              • else
                                                              • elsif
                                                              • eq
                                                              • exp
                                                              • for
                                                              • foreach
                                                              • ge
                                                              • gt
                                                              • if
                                                              • le
                                                              • lock
                                                              • lt
                                                              • m
                                                              • ne
                                                              • no
                                                              • or
                                                              • package
                                                              • q
                                                              • qq
                                                              • qr
                                                              • qw
                                                              • qx
                                                              • return
                                                              • s
                                                              • sub
                                                              • tr
                                                              • unless
                                                              • until
                                                              • while
                                                              • xor
                                                              • y

                                                              FEATURE SET​

                                                              Client Modification Feature​

                                                              NameSupportedDefined By
                                                              BasePath✓ToolingExtension
                                                              Authorizations✗ToolingExtension
                                                              UserAgent✓ToolingExtension
                                                              MockServer✗ToolingExtension

                                                              Data Type Feature​

                                                              NameSupportedDefined By
                                                              Custom✗OAS2,OAS3
                                                              Int32✓OAS2,OAS3
                                                              Int64✓OAS2,OAS3
                                                              Float✓OAS2,OAS3
                                                              Double✓OAS2,OAS3
                                                              Decimal✓ToolingExtension
                                                              String✓OAS2,OAS3
                                                              Byte✓OAS2,OAS3
                                                              Binary✓OAS2,OAS3
                                                              Boolean✓OAS2,OAS3
                                                              Date✓OAS2,OAS3
                                                              DateTime✓OAS2,OAS3
                                                              Password✓OAS2,OAS3
                                                              File✓OAS2
                                                              Uuid✗
                                                              Array✓OAS2,OAS3
                                                              Null✗OAS3
                                                              AnyType✗OAS2,OAS3
                                                              Object✓OAS2,OAS3
                                                              Maps✓ToolingExtension
                                                              CollectionFormat✓OAS2
                                                              CollectionFormatMulti✓OAS2
                                                              Enum✓OAS2,OAS3
                                                              ArrayOfEnum✓ToolingExtension
                                                              ArrayOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                              ArrayOfCollectionOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                                              MapOfEnum✓ToolingExtension
                                                              MapOfModel✓ToolingExtension
                                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                                              MapOfCollectionOfModel✓ToolingExtension
                                                              MapOfCollectionOfEnum✓ToolingExtension

                                                              Documentation Feature​

                                                              NameSupportedDefined By
                                                              Readme✓ToolingExtension
                                                              Model✓ToolingExtension
                                                              Api✓ToolingExtension

                                                              Global Feature​

                                                              NameSupportedDefined By
                                                              Host✓OAS2,OAS3
                                                              BasePath✓OAS2,OAS3
                                                              Info✓OAS2,OAS3
                                                              Schemes✗OAS2,OAS3
                                                              PartialSchemes✓OAS2,OAS3
                                                              Consumes✓OAS2
                                                              Produces✓OAS2
                                                              ExternalDocumentation✓OAS2,OAS3
                                                              Examples✓OAS2,OAS3
                                                              XMLStructureDefinitions✗OAS2,OAS3
                                                              MultiServer✗OAS3
                                                              ParameterizedServer✗OAS3
                                                              ParameterStyling✗OAS3
                                                              Callbacks✗OAS3
                                                              LinkObjects✗OAS3

                                                              Parameter Feature​

                                                              NameSupportedDefined By
                                                              Path✓OAS2,OAS3
                                                              Query✓OAS2,OAS3
                                                              Header✓OAS2,OAS3
                                                              Body✓OAS2
                                                              FormUnencoded✓OAS2
                                                              FormMultipart✓OAS2
                                                              Cookie✓OAS3

                                                              Schema Support Feature​

                                                              NameSupportedDefined By
                                                              Simple✓OAS2,OAS3
                                                              Composite✓OAS2,OAS3
                                                              Polymorphism✓OAS2,OAS3
                                                              Union✗OAS3
                                                              allOf✗OAS2,OAS3
                                                              anyOf✗OAS3
                                                              oneOf✗OAS3
                                                              not✗OAS3

                                                              Security Feature​

                                                              NameSupportedDefined By
                                                              BasicAuth✓OAS2,OAS3
                                                              ApiKey✓OAS2,OAS3
                                                              OpenIDConnect✗OAS3
                                                              BearerToken✓OAS3
                                                              OAuth2_Implicit✓OAS2,OAS3
                                                              OAuth2_Password✗OAS2,OAS3
                                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                                              OAuth2_AuthorizationCode✗OAS2,OAS3
                                                              SignatureAuth✗OAS3
                                                              AWSV4Signature✗ToolingExtension

                                                              Wire Format Feature​

                                                              NameSupportedDefined By
                                                              JSON✓OAS2,OAS3
                                                              XML✓OAS2,OAS3
                                                              PROTOBUF✗ToolingExtension
                                                              Custom✗OAS2,OAS3
                                                              - + \ No newline at end of file diff --git a/docs/generators/php-dt/index.html b/docs/generators/php-dt/index.html index e2aeb21ca3c..ba0d9ba75ba 100644 --- a/docs/generators/php-dt/index.html +++ b/docs/generators/php-dt/index.html @@ -15,13 +15,13 @@ - +

                                                              Documentation for the php-dt Generator

                                                              METADATA​

                                                              PropertyValueNotes
                                                              generator namephp-dtpass this to the generate command after -g
                                                              generator stabilityBETA
                                                              generator typeCLIENT
                                                              generator languagePHP
                                                              generator default templating enginemustache
                                                              helpTxtGenerates a PHP client relying on Data Transfer ( https://github.com/Articus/DataTransfer ) and compliant with PSR-7, PSR-11, PSR-17 and PSR-18.

                                                              CONFIG OPTIONS​

                                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                              OptionDescriptionValuesDefault
                                                              allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                              apiPackagepackage for generated api classesnull
                                                              artifactUrlartifact URL in generated pom.xmlnull
                                                              artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                              composerPackageNameThe name to use in the composer package name field. e.g. vendor/project (must be lowercase and consist of words separated by -, . or _).null
                                                              developerOrganizationdeveloper organization in generated pom.xmlnull
                                                              developerOrganizationUrldeveloper organization URL in generated pom.xmlnull
                                                              disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              false
                                                              The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                              true
                                                              Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              		true
                                                              ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                              enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                              false
                                                              No changes to the enum's are made, this is the default option.
                                                              true
                                                              With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                              		false
                                                              invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                              legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                              true
                                                              The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                              false
                                                              The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                              		true
                                                              licenseNameThe name of the licensenull
                                                              modelPackagepackage for generated modelsnull
                                                              modernuse modern language features (generated code will require PHP 8.1)false
                                                              packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                              prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                              sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                              sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                              srcBasePathThe directory to serve as source root.null
                                                              variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                              IMPORT MAPPING​

                                                              Type/AliasImports

                                                              INSTANTIATION TYPES​

                                                              Type/AliasInstantiated By
                                                              arrayarray
                                                              maparray

                                                              LANGUAGE PRIMITIVES​

                                                              • array
                                                              • bool
                                                              • boolean
                                                              • byte
                                                              • float
                                                              • int
                                                              • integer
                                                              • mixed
                                                              • number
                                                              • object
                                                              • string
                                                              • void

                                                              RESERVED WORDS​

                                                              • __halt_compiler
                                                              • _header_accept
                                                              • _tempbody
                                                              • abstract
                                                              • and
                                                              • array
                                                              • as
                                                              • break
                                                              • callable
                                                              • case
                                                              • catch
                                                              • class
                                                              • clone
                                                              • const
                                                              • continue
                                                              • declare
                                                              • default
                                                              • die
                                                              • do
                                                              • echo
                                                              • else
                                                              • elseif
                                                              • empty
                                                              • enddeclare
                                                              • endfor
                                                              • endforeach
                                                              • endif
                                                              • endswitch
                                                              • endwhile
                                                              • eval
                                                              • exit
                                                              • extends
                                                              • final
                                                              • for
                                                              • foreach
                                                              • formparams
                                                              • function
                                                              • global
                                                              • goto
                                                              • headerparams
                                                              • httpbody
                                                              • if
                                                              • implements
                                                              • include
                                                              • include_once
                                                              • instanceof
                                                              • insteadof
                                                              • interface
                                                              • isset
                                                              • list
                                                              • namespace
                                                              • new
                                                              • or
                                                              • print
                                                              • private
                                                              • protected
                                                              • public
                                                              • queryparams
                                                              • require
                                                              • require_once
                                                              • resourcepath
                                                              • return
                                                              • static
                                                              • switch
                                                              • throw
                                                              • trait
                                                              • try
                                                              • unset
                                                              • use
                                                              • var
                                                              • while
                                                              • xor

                                                              FEATURE SET​

                                                              Client Modification Feature​

                                                              NameSupportedDefined By
                                                              BasePath✗ToolingExtension
                                                              Authorizations✗ToolingExtension
                                                              UserAgent✗ToolingExtension
                                                              MockServer✗ToolingExtension

                                                              Data Type Feature​

                                                              NameSupportedDefined By
                                                              Custom✗OAS2,OAS3
                                                              Int32✓OAS2,OAS3
                                                              Int64✓OAS2,OAS3
                                                              Float✓OAS2,OAS3
                                                              Double✓OAS2,OAS3
                                                              Decimal✓ToolingExtension
                                                              String✓OAS2,OAS3
                                                              Byte✓OAS2,OAS3
                                                              Binary✓OAS2,OAS3
                                                              Boolean✓OAS2,OAS3
                                                              Date✓OAS2,OAS3
                                                              DateTime✓OAS2,OAS3
                                                              Password✓OAS2,OAS3
                                                              File✓OAS2
                                                              Uuid✗
                                                              Array✓OAS2,OAS3
                                                              Null✗OAS3
                                                              AnyType✗OAS2,OAS3
                                                              Object✓OAS2,OAS3
                                                              Maps✓ToolingExtension
                                                              CollectionFormat✓OAS2
                                                              CollectionFormatMulti✓OAS2
                                                              Enum✓OAS2,OAS3
                                                              ArrayOfEnum✓ToolingExtension
                                                              ArrayOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                              ArrayOfCollectionOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                                              MapOfEnum✓ToolingExtension
                                                              MapOfModel✓ToolingExtension
                                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                                              MapOfCollectionOfModel✓ToolingExtension
                                                              MapOfCollectionOfEnum✓ToolingExtension

                                                              Documentation Feature​

                                                              NameSupportedDefined By
                                                              Readme✓ToolingExtension
                                                              Model✓ToolingExtension
                                                              Api✓ToolingExtension

                                                              Global Feature​

                                                              NameSupportedDefined By
                                                              Host✓OAS2,OAS3
                                                              BasePath✓OAS2,OAS3
                                                              Info✓OAS2,OAS3
                                                              Schemes✗OAS2,OAS3
                                                              PartialSchemes✓OAS2,OAS3
                                                              Consumes✓OAS2
                                                              Produces✓OAS2
                                                              ExternalDocumentation✓OAS2,OAS3
                                                              Examples✓OAS2,OAS3
                                                              XMLStructureDefinitions✗OAS2,OAS3
                                                              MultiServer✗OAS3
                                                              ParameterizedServer✗OAS3
                                                              ParameterStyling✗OAS3
                                                              Callbacks✗OAS3
                                                              LinkObjects✗OAS3

                                                              Parameter Feature​

                                                              NameSupportedDefined By
                                                              Path✓OAS2,OAS3
                                                              Query✓OAS2,OAS3
                                                              Header✓OAS2,OAS3
                                                              Body✓OAS2
                                                              FormUnencoded✓OAS2
                                                              FormMultipart✓OAS2
                                                              Cookie✓OAS3

                                                              Schema Support Feature​

                                                              NameSupportedDefined By
                                                              Simple✓OAS2,OAS3
                                                              Composite✓OAS2,OAS3
                                                              Polymorphism✗OAS2,OAS3
                                                              Union✗OAS3
                                                              allOf✗OAS2,OAS3
                                                              anyOf✗OAS3
                                                              oneOf✗OAS3
                                                              not✗OAS3

                                                              Security Feature​

                                                              NameSupportedDefined By
                                                              BasicAuth✓OAS2,OAS3
                                                              ApiKey✓OAS2,OAS3
                                                              OpenIDConnect✗OAS3
                                                              BearerToken✓OAS3
                                                              OAuth2_Implicit✓OAS2,OAS3
                                                              OAuth2_Password✗OAS2,OAS3
                                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                                              OAuth2_AuthorizationCode✗OAS2,OAS3
                                                              SignatureAuth✗OAS3
                                                              AWSV4Signature✗ToolingExtension

                                                              Wire Format Feature​

                                                              NameSupportedDefined By
                                                              JSON✓OAS2,OAS3
                                                              XML✗OAS2,OAS3
                                                              PROTOBUF✗ToolingExtension
                                                              Custom✗OAS2,OAS3
                                                              - + \ No newline at end of file diff --git a/docs/generators/php-flight/index.html b/docs/generators/php-flight/index.html index 8c7840a430e..b586df7f019 100644 --- a/docs/generators/php-flight/index.html +++ b/docs/generators/php-flight/index.html @@ -15,13 +15,13 @@ - +

                                                              Documentation for the php-flight Generator

                                                              METADATA​

                                                              PropertyValueNotes
                                                              generator namephp-flightpass this to the generate command after -g
                                                              generator stabilityEXPERIMENTAL
                                                              generator typeSERVER
                                                              generator languagePHP
                                                              generator default templating enginemustache
                                                              helpTxtGenerates a PHP Flight Framework server library.

                                                              CONFIG OPTIONS​

                                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                              OptionDescriptionValuesDefault
                                                              allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                              apiPackagepackage for generated api classesnull
                                                              artifactUrlartifact URL in generated pom.xmlnull
                                                              artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                              composerPackageNameThe name to use in the composer package name field. e.g. vendor/project (must be lowercase and consist of words separated by -, . or _).null
                                                              developerOrganizationdeveloper organization in generated pom.xmlnull
                                                              developerOrganizationUrldeveloper organization URL in generated pom.xmlnull
                                                              disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              false
                                                              The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                              true
                                                              Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              		true
                                                              ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                              enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                              false
                                                              No changes to the enum's are made, this is the default option.
                                                              true
                                                              With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                              		false
                                                              hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                              invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                              legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                              true
                                                              The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                              false
                                                              The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                              		true
                                                              licenseNameThe name of the licensenull
                                                              modelPackagepackage for generated modelsnull
                                                              packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                              prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                              sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                              sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                              srcBasePathThe directory to serve as source root.null
                                                              variableNamingConventionnaming convention of variable name, e.g. camelCase.camelCase

                                                              IMPORT MAPPING​

                                                              Type/AliasImports

                                                              INSTANTIATION TYPES​

                                                              Type/AliasInstantiated By
                                                              arrayarray
                                                              maparray

                                                              LANGUAGE PRIMITIVES​

                                                              • \DateTime
                                                              • \SplFileObject
                                                              • array
                                                              • bool
                                                              • boolean
                                                              • byte
                                                              • float
                                                              • int
                                                              • integer
                                                              • mixed
                                                              • number
                                                              • object
                                                              • string
                                                              • void

                                                              RESERVED WORDS​

                                                              • __halt_compiler
                                                              • _header_accept
                                                              • _tempbody
                                                              • abstract
                                                              • and
                                                              • array
                                                              • as
                                                              • break
                                                              • callable
                                                              • case
                                                              • catch
                                                              • class
                                                              • clone
                                                              • const
                                                              • continue
                                                              • declare
                                                              • default
                                                              • die
                                                              • do
                                                              • echo
                                                              • else
                                                              • elseif
                                                              • empty
                                                              • enddeclare
                                                              • endfor
                                                              • endforeach
                                                              • endif
                                                              • endswitch
                                                              • endwhile
                                                              • eval
                                                              • exit
                                                              • extends
                                                              • final
                                                              • for
                                                              • foreach
                                                              • formparams
                                                              • function
                                                              • global
                                                              • goto
                                                              • headerparams
                                                              • httpbody
                                                              • if
                                                              • implements
                                                              • include
                                                              • include_once
                                                              • instanceof
                                                              • insteadof
                                                              • interface
                                                              • isset
                                                              • list
                                                              • namespace
                                                              • new
                                                              • or
                                                              • print
                                                              • private
                                                              • protected
                                                              • public
                                                              • queryparams
                                                              • require
                                                              • require_once
                                                              • resourcepath
                                                              • return
                                                              • static
                                                              • switch
                                                              • throw
                                                              • trait
                                                              • try
                                                              • unset
                                                              • use
                                                              • var
                                                              • while
                                                              • xor

                                                              FEATURE SET​

                                                              Client Modification Feature​

                                                              NameSupportedDefined By
                                                              BasePath✗ToolingExtension
                                                              Authorizations✗ToolingExtension
                                                              UserAgent✗ToolingExtension
                                                              MockServer✗ToolingExtension

                                                              Data Type Feature​

                                                              NameSupportedDefined By
                                                              Custom✗OAS2,OAS3
                                                              Int32✓OAS2,OAS3
                                                              Int64✓OAS2,OAS3
                                                              Float✓OAS2,OAS3
                                                              Double✓OAS2,OAS3
                                                              Decimal✓ToolingExtension
                                                              String✓OAS2,OAS3
                                                              Byte✓OAS2,OAS3
                                                              Binary✓OAS2,OAS3
                                                              Boolean✓OAS2,OAS3
                                                              Date✓OAS2,OAS3
                                                              DateTime✓OAS2,OAS3
                                                              Password✓OAS2,OAS3
                                                              File✓OAS2
                                                              Uuid✗
                                                              Array✓OAS2,OAS3
                                                              Null✗OAS3
                                                              AnyType✗OAS2,OAS3
                                                              Object✓OAS2,OAS3
                                                              Maps✓ToolingExtension
                                                              CollectionFormat✓OAS2
                                                              CollectionFormatMulti✓OAS2
                                                              Enum✓OAS2,OAS3
                                                              ArrayOfEnum✓ToolingExtension
                                                              ArrayOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                              ArrayOfCollectionOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                                              MapOfEnum✗ToolingExtension
                                                              MapOfModel✗ToolingExtension
                                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                                              MapOfCollectionOfModel✗ToolingExtension
                                                              MapOfCollectionOfEnum✗ToolingExtension

                                                              Documentation Feature​

                                                              NameSupportedDefined By
                                                              Readme✓ToolingExtension
                                                              Model✓ToolingExtension
                                                              Api✓ToolingExtension

                                                              Global Feature​

                                                              NameSupportedDefined By
                                                              Host✓OAS2,OAS3
                                                              BasePath✓OAS2,OAS3
                                                              Info✓OAS2,OAS3
                                                              Schemes✗OAS2,OAS3
                                                              PartialSchemes✓OAS2,OAS3
                                                              Consumes✓OAS2
                                                              Produces✓OAS2
                                                              ExternalDocumentation✓OAS2,OAS3
                                                              Examples✓OAS2,OAS3
                                                              XMLStructureDefinitions✗OAS2,OAS3
                                                              MultiServer✗OAS3
                                                              ParameterizedServer✗OAS3
                                                              ParameterStyling✗OAS3
                                                              Callbacks✗OAS3
                                                              LinkObjects✗OAS3

                                                              Parameter Feature​

                                                              NameSupportedDefined By
                                                              Path✓OAS2,OAS3
                                                              Query✓OAS2,OAS3
                                                              Header✓OAS2,OAS3
                                                              Body✓OAS2
                                                              FormUnencoded✗OAS2
                                                              FormMultipart✗OAS2
                                                              Cookie✗OAS3

                                                              Schema Support Feature​

                                                              NameSupportedDefined By
                                                              Simple✓OAS2,OAS3
                                                              Composite✓OAS2,OAS3
                                                              Polymorphism✗OAS2,OAS3
                                                              Union✗OAS3
                                                              allOf✗OAS2,OAS3
                                                              anyOf✗OAS3
                                                              oneOf✗OAS3
                                                              not✗OAS3

                                                              Security Feature​

                                                              NameSupportedDefined By
                                                              BasicAuth✓OAS2,OAS3
                                                              ApiKey✓OAS2,OAS3
                                                              OpenIDConnect✗OAS3
                                                              BearerToken✓OAS3
                                                              OAuth2_Implicit✓OAS2,OAS3
                                                              OAuth2_Password✗OAS2,OAS3
                                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                                              OAuth2_AuthorizationCode✗OAS2,OAS3
                                                              SignatureAuth✗OAS3
                                                              AWSV4Signature✗ToolingExtension

                                                              Wire Format Feature​

                                                              NameSupportedDefined By
                                                              JSON✓OAS2,OAS3
                                                              XML✗OAS2,OAS3
                                                              PROTOBUF✗ToolingExtension
                                                              Custom✗OAS2,OAS3
                                                              - + \ No newline at end of file diff --git a/docs/generators/php-laravel/index.html b/docs/generators/php-laravel/index.html index 7bfc7ee8b9d..3ca79a34175 100644 --- a/docs/generators/php-laravel/index.html +++ b/docs/generators/php-laravel/index.html @@ -15,13 +15,13 @@ - +

                                                              Documentation for the php-laravel Generator

                                                              METADATA​

                                                              PropertyValueNotes
                                                              generator namephp-laravelpass this to the generate command after -g
                                                              generator stabilitySTABLE
                                                              generator typeSERVER
                                                              generator languagePHP
                                                              generator default templating enginemustache
                                                              helpTxtGenerates a PHP laravel server library.

                                                              CONFIG OPTIONS​

                                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                              OptionDescriptionValuesDefault
                                                              allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                              apiPackagepackage for generated api classesnull
                                                              artifactUrlartifact URL in generated pom.xmlnull
                                                              artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                              composerPackageNameThe name to use in the composer package name field. e.g. vendor/project (must be lowercase and consist of words separated by -, . or _).null
                                                              developerOrganizationdeveloper organization in generated pom.xmlnull
                                                              developerOrganizationUrldeveloper organization URL in generated pom.xmlnull
                                                              disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              false
                                                              The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                              true
                                                              Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              		true
                                                              ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                              enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                              false
                                                              No changes to the enum's are made, this is the default option.
                                                              true
                                                              With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                              		false
                                                              invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                              legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                              true
                                                              The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                              false
                                                              The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                              		true
                                                              licenseNameThe name of the licensenull
                                                              modelPackagepackage for generated modelsnull
                                                              packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                              prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                              sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                              sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                              srcBasePathThe directory to serve as source root.null
                                                              variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                              IMPORT MAPPING​

                                                              Type/AliasImports

                                                              INSTANTIATION TYPES​

                                                              Type/AliasInstantiated By
                                                              arrayarray
                                                              maparray

                                                              LANGUAGE PRIMITIVES​

                                                              • \DateTime
                                                              • \SplFileObject
                                                              • array
                                                              • bool
                                                              • boolean
                                                              • byte
                                                              • float
                                                              • int
                                                              • integer
                                                              • mixed
                                                              • number
                                                              • object
                                                              • string
                                                              • void

                                                              RESERVED WORDS​

                                                              • __halt_compiler
                                                              • _header_accept
                                                              • _tempbody
                                                              • abstract
                                                              • and
                                                              • array
                                                              • as
                                                              • break
                                                              • callable
                                                              • case
                                                              • catch
                                                              • class
                                                              • clone
                                                              • const
                                                              • continue
                                                              • declare
                                                              • default
                                                              • die
                                                              • do
                                                              • echo
                                                              • else
                                                              • elseif
                                                              • empty
                                                              • enddeclare
                                                              • endfor
                                                              • endforeach
                                                              • endif
                                                              • endswitch
                                                              • endwhile
                                                              • eval
                                                              • exit
                                                              • extends
                                                              • final
                                                              • for
                                                              • foreach
                                                              • formparams
                                                              • function
                                                              • global
                                                              • goto
                                                              • headerparams
                                                              • httpbody
                                                              • if
                                                              • implements
                                                              • include
                                                              • include_once
                                                              • instanceof
                                                              • insteadof
                                                              • interface
                                                              • isset
                                                              • list
                                                              • namespace
                                                              • new
                                                              • or
                                                              • print
                                                              • private
                                                              • protected
                                                              • public
                                                              • queryparams
                                                              • require
                                                              • require_once
                                                              • resourcepath
                                                              • return
                                                              • static
                                                              • switch
                                                              • throw
                                                              • trait
                                                              • try
                                                              • unset
                                                              • use
                                                              • var
                                                              • while
                                                              • xor

                                                              FEATURE SET​

                                                              Client Modification Feature​

                                                              NameSupportedDefined By
                                                              BasePath✗ToolingExtension
                                                              Authorizations✗ToolingExtension
                                                              UserAgent✗ToolingExtension
                                                              MockServer✗ToolingExtension

                                                              Data Type Feature​

                                                              NameSupportedDefined By
                                                              Custom✗OAS2,OAS3
                                                              Int32✓OAS2,OAS3
                                                              Int64✓OAS2,OAS3
                                                              Float✓OAS2,OAS3
                                                              Double✓OAS2,OAS3
                                                              Decimal✓ToolingExtension
                                                              String✓OAS2,OAS3
                                                              Byte✓OAS2,OAS3
                                                              Binary✓OAS2,OAS3
                                                              Boolean✓OAS2,OAS3
                                                              Date✓OAS2,OAS3
                                                              DateTime✓OAS2,OAS3
                                                              Password✓OAS2,OAS3
                                                              File✓OAS2
                                                              Uuid✗
                                                              Array✓OAS2,OAS3
                                                              Null✗OAS3
                                                              AnyType✗OAS2,OAS3
                                                              Object✓OAS2,OAS3
                                                              Maps✓ToolingExtension
                                                              CollectionFormat✓OAS2
                                                              CollectionFormatMulti✓OAS2
                                                              Enum✓OAS2,OAS3
                                                              ArrayOfEnum✓ToolingExtension
                                                              ArrayOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                              ArrayOfCollectionOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                                              MapOfEnum✓ToolingExtension
                                                              MapOfModel✓ToolingExtension
                                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                                              MapOfCollectionOfModel✓ToolingExtension
                                                              MapOfCollectionOfEnum✓ToolingExtension

                                                              Documentation Feature​

                                                              NameSupportedDefined By
                                                              Readme✓ToolingExtension
                                                              Model✓ToolingExtension
                                                              Api✓ToolingExtension

                                                              Global Feature​

                                                              NameSupportedDefined By
                                                              Host✓OAS2,OAS3
                                                              BasePath✓OAS2,OAS3
                                                              Info✓OAS2,OAS3
                                                              Schemes✗OAS2,OAS3
                                                              PartialSchemes✓OAS2,OAS3
                                                              Consumes✓OAS2
                                                              Produces✓OAS2
                                                              ExternalDocumentation✓OAS2,OAS3
                                                              Examples✓OAS2,OAS3
                                                              XMLStructureDefinitions✗OAS2,OAS3
                                                              MultiServer✗OAS3
                                                              ParameterizedServer✗OAS3
                                                              ParameterStyling✗OAS3
                                                              Callbacks✗OAS3
                                                              LinkObjects✗OAS3

                                                              Parameter Feature​

                                                              NameSupportedDefined By
                                                              Path✓OAS2,OAS3
                                                              Query✓OAS2,OAS3
                                                              Header✓OAS2,OAS3
                                                              Body✓OAS2
                                                              FormUnencoded✓OAS2
                                                              FormMultipart✓OAS2
                                                              Cookie✓OAS3

                                                              Schema Support Feature​

                                                              NameSupportedDefined By
                                                              Simple✓OAS2,OAS3
                                                              Composite✓OAS2,OAS3
                                                              Polymorphism✗OAS2,OAS3
                                                              Union✗OAS3
                                                              allOf✗OAS2,OAS3
                                                              anyOf✗OAS3
                                                              oneOf✗OAS3
                                                              not✗OAS3

                                                              Security Feature​

                                                              NameSupportedDefined By
                                                              BasicAuth✗OAS2,OAS3
                                                              ApiKey✗OAS2,OAS3
                                                              OpenIDConnect✗OAS3
                                                              BearerToken✗OAS3
                                                              OAuth2_Implicit✗OAS2,OAS3
                                                              OAuth2_Password✗OAS2,OAS3
                                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                                              OAuth2_AuthorizationCode✗OAS2,OAS3
                                                              SignatureAuth✗OAS3
                                                              AWSV4Signature✗ToolingExtension

                                                              Wire Format Feature​

                                                              NameSupportedDefined By
                                                              JSON✓OAS2,OAS3
                                                              XML✓OAS2,OAS3
                                                              PROTOBUF✗ToolingExtension
                                                              Custom✗OAS2,OAS3
                                                              - + \ No newline at end of file diff --git a/docs/generators/php-lumen/index.html b/docs/generators/php-lumen/index.html index c70b2d232f6..fb98893ec53 100644 --- a/docs/generators/php-lumen/index.html +++ b/docs/generators/php-lumen/index.html @@ -15,13 +15,13 @@ - +

                                                              Documentation for the php-lumen Generator

                                                              METADATA​

                                                              PropertyValueNotes
                                                              generator namephp-lumenpass this to the generate command after -g
                                                              generator stabilitySTABLE
                                                              generator typeSERVER
                                                              generator languagePHP
                                                              generator default templating enginemustache
                                                              helpTxtGenerates a PHP Lumen server library.

                                                              CONFIG OPTIONS​

                                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                              OptionDescriptionValuesDefault
                                                              allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                              apiPackagepackage for generated api classesnull
                                                              artifactUrlartifact URL in generated pom.xmlnull
                                                              artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                              composerPackageNameThe name to use in the composer package name field. e.g. vendor/project (must be lowercase and consist of words separated by -, . or _).null
                                                              developerOrganizationdeveloper organization in generated pom.xmlnull
                                                              developerOrganizationUrldeveloper organization URL in generated pom.xmlnull
                                                              disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              false
                                                              The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                              true
                                                              Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              		true
                                                              ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                              enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                              false
                                                              No changes to the enum's are made, this is the default option.
                                                              true
                                                              With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                              		false
                                                              invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                              legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                              true
                                                              The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                              false
                                                              The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                              		true
                                                              licenseNameThe name of the licensenull
                                                              modelPackagepackage for generated modelsnull
                                                              packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                              prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                              sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                              sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                              srcBasePathThe directory to serve as source root.null
                                                              variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                              IMPORT MAPPING​

                                                              Type/AliasImports

                                                              INSTANTIATION TYPES​

                                                              Type/AliasInstantiated By
                                                              arrayarray
                                                              maparray

                                                              LANGUAGE PRIMITIVES​

                                                              • \DateTime
                                                              • \SplFileObject
                                                              • array
                                                              • bool
                                                              • boolean
                                                              • byte
                                                              • float
                                                              • int
                                                              • integer
                                                              • mixed
                                                              • number
                                                              • object
                                                              • string
                                                              • void

                                                              RESERVED WORDS​

                                                              • __halt_compiler
                                                              • _header_accept
                                                              • _tempbody
                                                              • abstract
                                                              • and
                                                              • array
                                                              • as
                                                              • break
                                                              • callable
                                                              • case
                                                              • catch
                                                              • class
                                                              • clone
                                                              • const
                                                              • continue
                                                              • declare
                                                              • default
                                                              • die
                                                              • do
                                                              • echo
                                                              • else
                                                              • elseif
                                                              • empty
                                                              • enddeclare
                                                              • endfor
                                                              • endforeach
                                                              • endif
                                                              • endswitch
                                                              • endwhile
                                                              • eval
                                                              • exit
                                                              • extends
                                                              • final
                                                              • for
                                                              • foreach
                                                              • formparams
                                                              • function
                                                              • global
                                                              • goto
                                                              • headerparams
                                                              • httpbody
                                                              • if
                                                              • implements
                                                              • include
                                                              • include_once
                                                              • instanceof
                                                              • insteadof
                                                              • interface
                                                              • isset
                                                              • list
                                                              • namespace
                                                              • new
                                                              • or
                                                              • print
                                                              • private
                                                              • protected
                                                              • public
                                                              • queryparams
                                                              • require
                                                              • require_once
                                                              • resourcepath
                                                              • return
                                                              • static
                                                              • switch
                                                              • throw
                                                              • trait
                                                              • try
                                                              • unset
                                                              • use
                                                              • var
                                                              • while
                                                              • xor

                                                              FEATURE SET​

                                                              Client Modification Feature​

                                                              NameSupportedDefined By
                                                              BasePath✗ToolingExtension
                                                              Authorizations✗ToolingExtension
                                                              UserAgent✗ToolingExtension
                                                              MockServer✗ToolingExtension

                                                              Data Type Feature​

                                                              NameSupportedDefined By
                                                              Custom✗OAS2,OAS3
                                                              Int32✓OAS2,OAS3
                                                              Int64✓OAS2,OAS3
                                                              Float✓OAS2,OAS3
                                                              Double✓OAS2,OAS3
                                                              Decimal✓ToolingExtension
                                                              String✓OAS2,OAS3
                                                              Byte✓OAS2,OAS3
                                                              Binary✓OAS2,OAS3
                                                              Boolean✓OAS2,OAS3
                                                              Date✓OAS2,OAS3
                                                              DateTime✓OAS2,OAS3
                                                              Password✓OAS2,OAS3
                                                              File✓OAS2
                                                              Uuid✗
                                                              Array✓OAS2,OAS3
                                                              Null✗OAS3
                                                              AnyType✗OAS2,OAS3
                                                              Object✓OAS2,OAS3
                                                              Maps✓ToolingExtension
                                                              CollectionFormat✓OAS2
                                                              CollectionFormatMulti✓OAS2
                                                              Enum✓OAS2,OAS3
                                                              ArrayOfEnum✓ToolingExtension
                                                              ArrayOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                              ArrayOfCollectionOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                                              MapOfEnum✓ToolingExtension
                                                              MapOfModel✓ToolingExtension
                                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                                              MapOfCollectionOfModel✓ToolingExtension
                                                              MapOfCollectionOfEnum✓ToolingExtension

                                                              Documentation Feature​

                                                              NameSupportedDefined By
                                                              Readme✓ToolingExtension
                                                              Model✓ToolingExtension
                                                              Api✓ToolingExtension

                                                              Global Feature​

                                                              NameSupportedDefined By
                                                              Host✓OAS2,OAS3
                                                              BasePath✓OAS2,OAS3
                                                              Info✓OAS2,OAS3
                                                              Schemes✗OAS2,OAS3
                                                              PartialSchemes✓OAS2,OAS3
                                                              Consumes✓OAS2
                                                              Produces✓OAS2
                                                              ExternalDocumentation✓OAS2,OAS3
                                                              Examples✓OAS2,OAS3
                                                              XMLStructureDefinitions✗OAS2,OAS3
                                                              MultiServer✗OAS3
                                                              ParameterizedServer✗OAS3
                                                              ParameterStyling✗OAS3
                                                              Callbacks✗OAS3
                                                              LinkObjects✗OAS3

                                                              Parameter Feature​

                                                              NameSupportedDefined By
                                                              Path✓OAS2,OAS3
                                                              Query✓OAS2,OAS3
                                                              Header✓OAS2,OAS3
                                                              Body✓OAS2
                                                              FormUnencoded✓OAS2
                                                              FormMultipart✓OAS2
                                                              Cookie✓OAS3

                                                              Schema Support Feature​

                                                              NameSupportedDefined By
                                                              Simple✓OAS2,OAS3
                                                              Composite✓OAS2,OAS3
                                                              Polymorphism✗OAS2,OAS3
                                                              Union✗OAS3
                                                              allOf✗OAS2,OAS3
                                                              anyOf✗OAS3
                                                              oneOf✗OAS3
                                                              not✗OAS3

                                                              Security Feature​

                                                              NameSupportedDefined By
                                                              BasicAuth✗OAS2,OAS3
                                                              ApiKey✗OAS2,OAS3
                                                              OpenIDConnect✗OAS3
                                                              BearerToken✗OAS3
                                                              OAuth2_Implicit✗OAS2,OAS3
                                                              OAuth2_Password✗OAS2,OAS3
                                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                                              OAuth2_AuthorizationCode✗OAS2,OAS3
                                                              SignatureAuth✗OAS3
                                                              AWSV4Signature✗ToolingExtension

                                                              Wire Format Feature​

                                                              NameSupportedDefined By
                                                              JSON✓OAS2,OAS3
                                                              XML✓OAS2,OAS3
                                                              PROTOBUF✗ToolingExtension
                                                              Custom✗OAS2,OAS3
                                                              - + \ No newline at end of file diff --git a/docs/generators/php-mezzio-ph/index.html b/docs/generators/php-mezzio-ph/index.html index 9201599be6f..e4a446f8c33 100644 --- a/docs/generators/php-mezzio-ph/index.html +++ b/docs/generators/php-mezzio-ph/index.html @@ -15,13 +15,13 @@ - +

                                                              Documentation for the php-mezzio-ph Generator

                                                              METADATA​

                                                              PropertyValueNotes
                                                              generator namephp-mezzio-phpass this to the generate command after -g
                                                              generator stabilitySTABLE
                                                              generator typeSERVER
                                                              generator languagePHP
                                                              generator default templating enginemustache
                                                              helpTxtGenerates PHP server stub using Mezzio ( https://docs.mezzio.dev/mezzio/ ) and Path Handler ( https://github.com/Articus/PathHandler ).

                                                              CONFIG OPTIONS​

                                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                              OptionDescriptionValuesDefault
                                                              allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                              apiPackagepackage for generated api classesnull
                                                              artifactUrlartifact URL in generated pom.xmlnull
                                                              artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                              composerPackageNameThe name to use in the composer package name field. e.g. vendor/project (must be lowercase and consist of words separated by -, . or _).null
                                                              developerOrganizationdeveloper organization in generated pom.xmlnull
                                                              developerOrganizationUrldeveloper organization URL in generated pom.xmlnull
                                                              disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              false
                                                              The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                              true
                                                              Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              		true
                                                              ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                              enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                              false
                                                              No changes to the enum's are made, this is the default option.
                                                              true
                                                              With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                              		false
                                                              invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                              legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                              true
                                                              The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                              false
                                                              The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                              		true
                                                              licenseNameThe name of the licensenull
                                                              modelPackagepackage for generated modelsnull
                                                              modernuse modern language features (generated code will require PHP 8.0)false
                                                              packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                              prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                              sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                              sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                              srcBasePathThe directory to serve as source root.null
                                                              variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                              IMPORT MAPPING​

                                                              Type/AliasImports

                                                              INSTANTIATION TYPES​

                                                              Type/AliasInstantiated By
                                                              arrayarray
                                                              maparray

                                                              LANGUAGE PRIMITIVES​

                                                              • array
                                                              • bool
                                                              • boolean
                                                              • byte
                                                              • float
                                                              • int
                                                              • integer
                                                              • mixed
                                                              • number
                                                              • object
                                                              • string
                                                              • void

                                                              RESERVED WORDS​

                                                              • __halt_compiler
                                                              • _header_accept
                                                              • _tempbody
                                                              • abstract
                                                              • and
                                                              • array
                                                              • as
                                                              • break
                                                              • callable
                                                              • case
                                                              • catch
                                                              • class
                                                              • clone
                                                              • const
                                                              • continue
                                                              • declare
                                                              • default
                                                              • die
                                                              • do
                                                              • echo
                                                              • else
                                                              • elseif
                                                              • empty
                                                              • enddeclare
                                                              • endfor
                                                              • endforeach
                                                              • endif
                                                              • endswitch
                                                              • endwhile
                                                              • eval
                                                              • exit
                                                              • extends
                                                              • final
                                                              • for
                                                              • foreach
                                                              • formparams
                                                              • function
                                                              • global
                                                              • goto
                                                              • headerparams
                                                              • httpbody
                                                              • if
                                                              • implements
                                                              • include
                                                              • include_once
                                                              • instanceof
                                                              • insteadof
                                                              • interface
                                                              • isset
                                                              • list
                                                              • namespace
                                                              • new
                                                              • or
                                                              • print
                                                              • private
                                                              • protected
                                                              • public
                                                              • queryparams
                                                              • require
                                                              • require_once
                                                              • resourcepath
                                                              • return
                                                              • static
                                                              • switch
                                                              • throw
                                                              • trait
                                                              • try
                                                              • unset
                                                              • use
                                                              • var
                                                              • while
                                                              • xor

                                                              FEATURE SET​

                                                              Client Modification Feature​

                                                              NameSupportedDefined By
                                                              BasePath✗ToolingExtension
                                                              Authorizations✗ToolingExtension
                                                              UserAgent✗ToolingExtension
                                                              MockServer✗ToolingExtension

                                                              Data Type Feature​

                                                              NameSupportedDefined By
                                                              Custom✗OAS2,OAS3
                                                              Int32✓OAS2,OAS3
                                                              Int64✓OAS2,OAS3
                                                              Float✓OAS2,OAS3
                                                              Double✓OAS2,OAS3
                                                              Decimal✓ToolingExtension
                                                              String✓OAS2,OAS3
                                                              Byte✓OAS2,OAS3
                                                              Binary✓OAS2,OAS3
                                                              Boolean✓OAS2,OAS3
                                                              Date✓OAS2,OAS3
                                                              DateTime✓OAS2,OAS3
                                                              Password✓OAS2,OAS3
                                                              File✓OAS2
                                                              Uuid✗
                                                              Array✓OAS2,OAS3
                                                              Null✗OAS3
                                                              AnyType✗OAS2,OAS3
                                                              Object✓OAS2,OAS3
                                                              Maps✓ToolingExtension
                                                              CollectionFormat✓OAS2
                                                              CollectionFormatMulti✓OAS2
                                                              Enum✓OAS2,OAS3
                                                              ArrayOfEnum✓ToolingExtension
                                                              ArrayOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                              ArrayOfCollectionOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                                              MapOfEnum✓ToolingExtension
                                                              MapOfModel✓ToolingExtension
                                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                                              MapOfCollectionOfModel✓ToolingExtension
                                                              MapOfCollectionOfEnum✓ToolingExtension

                                                              Documentation Feature​

                                                              NameSupportedDefined By
                                                              Readme✓ToolingExtension
                                                              Model✓ToolingExtension
                                                              Api✓ToolingExtension

                                                              Global Feature​

                                                              NameSupportedDefined By
                                                              Host✓OAS2,OAS3
                                                              BasePath✓OAS2,OAS3
                                                              Info✓OAS2,OAS3
                                                              Schemes✗OAS2,OAS3
                                                              PartialSchemes✓OAS2,OAS3
                                                              Consumes✓OAS2
                                                              Produces✓OAS2
                                                              ExternalDocumentation✓OAS2,OAS3
                                                              Examples✓OAS2,OAS3
                                                              XMLStructureDefinitions✗OAS2,OAS3
                                                              MultiServer✗OAS3
                                                              ParameterizedServer✗OAS3
                                                              ParameterStyling✗OAS3
                                                              Callbacks✗OAS3
                                                              LinkObjects✗OAS3

                                                              Parameter Feature​

                                                              NameSupportedDefined By
                                                              Path✓OAS2,OAS3
                                                              Query✓OAS2,OAS3
                                                              Header✓OAS2,OAS3
                                                              Body✓OAS2
                                                              FormUnencoded✓OAS2
                                                              FormMultipart✓OAS2
                                                              Cookie✓OAS3

                                                              Schema Support Feature​

                                                              NameSupportedDefined By
                                                              Simple✓OAS2,OAS3
                                                              Composite✓OAS2,OAS3
                                                              Polymorphism✗OAS2,OAS3
                                                              Union✗OAS3
                                                              allOf✗OAS2,OAS3
                                                              anyOf✗OAS3
                                                              oneOf✗OAS3
                                                              not✗OAS3

                                                              Security Feature​

                                                              NameSupportedDefined By
                                                              BasicAuth✗OAS2,OAS3
                                                              ApiKey✗OAS2,OAS3
                                                              OpenIDConnect✗OAS3
                                                              BearerToken✗OAS3
                                                              OAuth2_Implicit✗OAS2,OAS3
                                                              OAuth2_Password✗OAS2,OAS3
                                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                                              OAuth2_AuthorizationCode✗OAS2,OAS3
                                                              SignatureAuth✗OAS3
                                                              AWSV4Signature✗ToolingExtension

                                                              Wire Format Feature​

                                                              NameSupportedDefined By
                                                              JSON✓OAS2,OAS3
                                                              XML✓OAS2,OAS3
                                                              PROTOBUF✗ToolingExtension
                                                              Custom✗OAS2,OAS3
                                                              - + \ No newline at end of file diff --git a/docs/generators/php-nextgen/index.html b/docs/generators/php-nextgen/index.html index ac7f045c1ed..5f4e821447a 100644 --- a/docs/generators/php-nextgen/index.html +++ b/docs/generators/php-nextgen/index.html @@ -15,13 +15,13 @@ - +

                                                              Documentation for the php-nextgen Generator

                                                              METADATA​

                                                              PropertyValueNotes
                                                              generator namephp-nextgenpass this to the generate command after -g
                                                              generator stabilityBETA
                                                              generator typeCLIENT
                                                              generator languagePHP
                                                              generator default templating enginemustache
                                                              helpTxtGenerates a PHP client library (beta).

                                                              CONFIG OPTIONS​

                                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                              OptionDescriptionValuesDefault
                                                              allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                              apiPackagepackage for generated api classesnull
                                                              artifactUrlartifact URL in generated pom.xmlnull
                                                              artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                              composerPackageNameThe name to use in the composer package name field. e.g. vendor/project (must be lowercase and consist of words separated by -, . or _).null
                                                              developerOrganizationdeveloper organization in generated pom.xmlnull
                                                              developerOrganizationUrldeveloper organization URL in generated pom.xmlnull
                                                              disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              false
                                                              The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                              true
                                                              Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              		true
                                                              ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                              enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                              false
                                                              No changes to the enum's are made, this is the default option.
                                                              true
                                                              With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                              		false
                                                              hideGenerationTimestampboolean, toggles whether unicode identifiers are allowed in names or not, default is falsetrue
                                                              invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                              legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                              true
                                                              The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                              false
                                                              The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                              		true
                                                              licenseNameThe name of the licensenull
                                                              modelPackagepackage for generated modelsnull
                                                              packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                              prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                              sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                              sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                              srcBasePathThe directory to serve as source root.null
                                                              supportStreamingSupport streaming endpointfalse
                                                              variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                              IMPORT MAPPING​

                                                              Type/AliasImports

                                                              INSTANTIATION TYPES​

                                                              Type/AliasInstantiated By
                                                              arrayarray
                                                              maparray

                                                              LANGUAGE PRIMITIVES​

                                                              • \DateTime
                                                              • \SplFileObject
                                                              • array
                                                              • bool
                                                              • boolean
                                                              • byte
                                                              • float
                                                              • int
                                                              • integer
                                                              • mixed
                                                              • number
                                                              • object
                                                              • string
                                                              • void

                                                              RESERVED WORDS​

                                                              • __halt_compiler
                                                              • _header_accept
                                                              • _tempbody
                                                              • abstract
                                                              • and
                                                              • array
                                                              • as
                                                              • break
                                                              • callable
                                                              • case
                                                              • catch
                                                              • class
                                                              • clone
                                                              • const
                                                              • continue
                                                              • declare
                                                              • default
                                                              • die
                                                              • do
                                                              • echo
                                                              • else
                                                              • elseif
                                                              • empty
                                                              • enddeclare
                                                              • endfor
                                                              • endforeach
                                                              • endif
                                                              • endswitch
                                                              • endwhile
                                                              • eval
                                                              • exit
                                                              • extends
                                                              • final
                                                              • for
                                                              • foreach
                                                              • formparams
                                                              • function
                                                              • global
                                                              • goto
                                                              • headerparams
                                                              • httpbody
                                                              • if
                                                              • implements
                                                              • include
                                                              • include_once
                                                              • instanceof
                                                              • insteadof
                                                              • interface
                                                              • isset
                                                              • list
                                                              • namespace
                                                              • new
                                                              • or
                                                              • print
                                                              • private
                                                              • protected
                                                              • public
                                                              • queryparams
                                                              • require
                                                              • require_once
                                                              • resourcepath
                                                              • return
                                                              • static
                                                              • switch
                                                              • throw
                                                              • trait
                                                              • try
                                                              • unset
                                                              • use
                                                              • var
                                                              • while
                                                              • xor

                                                              FEATURE SET​

                                                              Client Modification Feature​

                                                              NameSupportedDefined By
                                                              BasePath✗ToolingExtension
                                                              Authorizations✗ToolingExtension
                                                              UserAgent✗ToolingExtension
                                                              MockServer✗ToolingExtension

                                                              Data Type Feature​

                                                              NameSupportedDefined By
                                                              Custom✗OAS2,OAS3
                                                              Int32✓OAS2,OAS3
                                                              Int64✓OAS2,OAS3
                                                              Float✓OAS2,OAS3
                                                              Double✓OAS2,OAS3
                                                              Decimal✓ToolingExtension
                                                              String✓OAS2,OAS3
                                                              Byte✓OAS2,OAS3
                                                              Binary✓OAS2,OAS3
                                                              Boolean✓OAS2,OAS3
                                                              Date✓OAS2,OAS3
                                                              DateTime✓OAS2,OAS3
                                                              Password✓OAS2,OAS3
                                                              File✓OAS2
                                                              Uuid✗
                                                              Array✓OAS2,OAS3
                                                              Null✗OAS3
                                                              AnyType✗OAS2,OAS3
                                                              Object✓OAS2,OAS3
                                                              Maps✓ToolingExtension
                                                              CollectionFormat✓OAS2
                                                              CollectionFormatMulti✓OAS2
                                                              Enum✓OAS2,OAS3
                                                              ArrayOfEnum✓ToolingExtension
                                                              ArrayOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                              ArrayOfCollectionOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                                              MapOfEnum✓ToolingExtension
                                                              MapOfModel✓ToolingExtension
                                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                                              MapOfCollectionOfModel✓ToolingExtension
                                                              MapOfCollectionOfEnum✓ToolingExtension

                                                              Documentation Feature​

                                                              NameSupportedDefined By
                                                              Readme✓ToolingExtension
                                                              Model✓ToolingExtension
                                                              Api✓ToolingExtension

                                                              Global Feature​

                                                              NameSupportedDefined By
                                                              Host✓OAS2,OAS3
                                                              BasePath✓OAS2,OAS3
                                                              Info✓OAS2,OAS3
                                                              Schemes✗OAS2,OAS3
                                                              PartialSchemes✓OAS2,OAS3
                                                              Consumes✓OAS2
                                                              Produces✓OAS2
                                                              ExternalDocumentation✓OAS2,OAS3
                                                              Examples✓OAS2,OAS3
                                                              XMLStructureDefinitions✗OAS2,OAS3
                                                              MultiServer✗OAS3
                                                              ParameterizedServer✗OAS3
                                                              ParameterStyling✗OAS3
                                                              Callbacks✗OAS3
                                                              LinkObjects✗OAS3

                                                              Parameter Feature​

                                                              NameSupportedDefined By
                                                              Path✓OAS2,OAS3
                                                              Query✓OAS2,OAS3
                                                              Header✓OAS2,OAS3
                                                              Body✓OAS2
                                                              FormUnencoded✓OAS2
                                                              FormMultipart✓OAS2
                                                              Cookie✓OAS3

                                                              Schema Support Feature​

                                                              NameSupportedDefined By
                                                              Simple✓OAS2,OAS3
                                                              Composite✓OAS2,OAS3
                                                              Polymorphism✗OAS2,OAS3
                                                              Union✗OAS3
                                                              allOf✗OAS2,OAS3
                                                              anyOf✗OAS3
                                                              oneOf✗OAS3
                                                              not✗OAS3

                                                              Security Feature​

                                                              NameSupportedDefined By
                                                              BasicAuth✗OAS2,OAS3
                                                              ApiKey✗OAS2,OAS3
                                                              OpenIDConnect✗OAS3
                                                              BearerToken✗OAS3
                                                              OAuth2_Implicit✗OAS2,OAS3
                                                              OAuth2_Password✗OAS2,OAS3
                                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                                              OAuth2_AuthorizationCode✗OAS2,OAS3
                                                              SignatureAuth✗OAS3
                                                              AWSV4Signature✗ToolingExtension

                                                              Wire Format Feature​

                                                              NameSupportedDefined By
                                                              JSON✓OAS2,OAS3
                                                              XML✓OAS2,OAS3
                                                              PROTOBUF✗ToolingExtension
                                                              Custom✗OAS2,OAS3
                                                              - + \ No newline at end of file diff --git a/docs/generators/php-slim4/index.html b/docs/generators/php-slim4/index.html index 499cc98a52d..9b26c8e7390 100644 --- a/docs/generators/php-slim4/index.html +++ b/docs/generators/php-slim4/index.html @@ -15,13 +15,13 @@ - +

                                                              Documentation for the php-slim4 Generator

                                                              METADATA​

                                                              PropertyValueNotes
                                                              generator namephp-slim4pass this to the generate command after -g
                                                              generator stabilitySTABLE
                                                              generator typeSERVER
                                                              generator languagePHP
                                                              generator default templating enginemustache
                                                              helpTxtGenerates a PHP Slim 4 Framework server library(with Mock server).

                                                              CONFIG OPTIONS​

                                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                              OptionDescriptionValuesDefault
                                                              allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                              apiPackagepackage for generated api classesnull
                                                              artifactUrlartifact URL in generated pom.xmlnull
                                                              artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                              composerPackageNameThe name to use in the composer package name field. e.g. vendor/project (must be lowercase and consist of words separated by -, . or _).null
                                                              developerOrganizationdeveloper organization in generated pom.xmlnull
                                                              developerOrganizationUrldeveloper organization URL in generated pom.xmlnull
                                                              disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              false
                                                              The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                              true
                                                              Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              		true
                                                              ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                              enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                              false
                                                              No changes to the enum's are made, this is the default option.
                                                              true
                                                              With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                              		false
                                                              invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                              legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                              true
                                                              The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                              false
                                                              The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                              		true
                                                              licenseNameThe name of the licensenull
                                                              modelPackagepackage for generated modelsnull
                                                              packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                              prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                              psr7ImplementationSlim 4 provides its own PSR-7 implementation so that it works out of the box. However, you are free to replace Slim’s default PSR-7 objects with a third-party implementation. Ref: https://www.slimframework.com/docs/v4/concepts/value-objects.html
                                                              slim-psr7
                                                              Slim PSR-7 Message implementation
                                                              nyholm-psr7
                                                              Nyholm PSR-7 Message implementation
                                                              guzzle-psr7
                                                              Guzzle PSR-7 Message implementation
                                                              zend-diactoros
                                                              Zend Diactoros PSR-7 Message implementation
                                                              		slim-psr7
                                                              sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                              sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                              srcBasePathThe directory to serve as source root.null
                                                              variableNamingConventionnaming convention of variable name, e.g. camelCase.camelCase

                                                              IMPORT MAPPING​

                                                              Type/AliasImports

                                                              INSTANTIATION TYPES​

                                                              Type/AliasInstantiated By
                                                              arrayarray
                                                              maparray

                                                              LANGUAGE PRIMITIVES​

                                                              • \DateTime
                                                              • \SplFileObject
                                                              • array
                                                              • bool
                                                              • boolean
                                                              • byte
                                                              • float
                                                              • int
                                                              • integer
                                                              • mixed
                                                              • number
                                                              • object
                                                              • string
                                                              • void

                                                              RESERVED WORDS​

                                                              • __halt_compiler
                                                              • _header_accept
                                                              • _tempbody
                                                              • abstract
                                                              • and
                                                              • array
                                                              • as
                                                              • break
                                                              • callable
                                                              • case
                                                              • catch
                                                              • class
                                                              • clone
                                                              • const
                                                              • continue
                                                              • declare
                                                              • default
                                                              • die
                                                              • do
                                                              • echo
                                                              • else
                                                              • elseif
                                                              • empty
                                                              • enddeclare
                                                              • endfor
                                                              • endforeach
                                                              • endif
                                                              • endswitch
                                                              • endwhile
                                                              • eval
                                                              • exit
                                                              • extends
                                                              • final
                                                              • for
                                                              • foreach
                                                              • formparams
                                                              • function
                                                              • global
                                                              • goto
                                                              • headerparams
                                                              • httpbody
                                                              • if
                                                              • implements
                                                              • include
                                                              • include_once
                                                              • instanceof
                                                              • insteadof
                                                              • interface
                                                              • isset
                                                              • list
                                                              • namespace
                                                              • new
                                                              • or
                                                              • print
                                                              • private
                                                              • protected
                                                              • public
                                                              • queryparams
                                                              • require
                                                              • require_once
                                                              • resourcepath
                                                              • return
                                                              • static
                                                              • switch
                                                              • throw
                                                              • trait
                                                              • try
                                                              • unset
                                                              • use
                                                              • var
                                                              • while
                                                              • xor

                                                              FEATURE SET​

                                                              Client Modification Feature​

                                                              NameSupportedDefined By
                                                              BasePath✗ToolingExtension
                                                              Authorizations✗ToolingExtension
                                                              UserAgent✗ToolingExtension
                                                              MockServer✓ToolingExtension

                                                              Data Type Feature​

                                                              NameSupportedDefined By
                                                              Custom✗OAS2,OAS3
                                                              Int32✓OAS2,OAS3
                                                              Int64✓OAS2,OAS3
                                                              Float✓OAS2,OAS3
                                                              Double✓OAS2,OAS3
                                                              Decimal✓ToolingExtension
                                                              String✓OAS2,OAS3
                                                              Byte✓OAS2,OAS3
                                                              Binary✓OAS2,OAS3
                                                              Boolean✓OAS2,OAS3
                                                              Date✓OAS2,OAS3
                                                              DateTime✓OAS2,OAS3
                                                              Password✓OAS2,OAS3
                                                              File✓OAS2
                                                              Uuid✗
                                                              Array✓OAS2,OAS3
                                                              Null✗OAS3
                                                              AnyType✗OAS2,OAS3
                                                              Object✓OAS2,OAS3
                                                              Maps✓ToolingExtension
                                                              CollectionFormat✓OAS2
                                                              CollectionFormatMulti✓OAS2
                                                              Enum✓OAS2,OAS3
                                                              ArrayOfEnum✓ToolingExtension
                                                              ArrayOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                              ArrayOfCollectionOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                                              MapOfEnum✓ToolingExtension
                                                              MapOfModel✓ToolingExtension
                                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                                              MapOfCollectionOfModel✓ToolingExtension
                                                              MapOfCollectionOfEnum✓ToolingExtension

                                                              Documentation Feature​

                                                              NameSupportedDefined By
                                                              Readme✓ToolingExtension
                                                              Model✓ToolingExtension
                                                              Api✓ToolingExtension

                                                              Global Feature​

                                                              NameSupportedDefined By
                                                              Host✓OAS2,OAS3
                                                              BasePath✓OAS2,OAS3
                                                              Info✓OAS2,OAS3
                                                              Schemes✗OAS2,OAS3
                                                              PartialSchemes✓OAS2,OAS3
                                                              Consumes✓OAS2
                                                              Produces✓OAS2
                                                              ExternalDocumentation✓OAS2,OAS3
                                                              Examples✓OAS2,OAS3
                                                              XMLStructureDefinitions✗OAS2,OAS3
                                                              MultiServer✗OAS3
                                                              ParameterizedServer✗OAS3
                                                              ParameterStyling✗OAS3
                                                              Callbacks✗OAS3
                                                              LinkObjects✗OAS3

                                                              Parameter Feature​

                                                              NameSupportedDefined By
                                                              Path✓OAS2,OAS3
                                                              Query✓OAS2,OAS3
                                                              Header✓OAS2,OAS3
                                                              Body✓OAS2
                                                              FormUnencoded✓OAS2
                                                              FormMultipart✓OAS2
                                                              Cookie✓OAS3

                                                              Schema Support Feature​

                                                              NameSupportedDefined By
                                                              Simple✓OAS2,OAS3
                                                              Composite✓OAS2,OAS3
                                                              Polymorphism✗OAS2,OAS3
                                                              Union✗OAS3
                                                              allOf✗OAS2,OAS3
                                                              anyOf✗OAS3
                                                              oneOf✗OAS3
                                                              not✗OAS3

                                                              Security Feature​

                                                              NameSupportedDefined By
                                                              BasicAuth✓OAS2,OAS3
                                                              ApiKey✓OAS2,OAS3
                                                              OpenIDConnect✗OAS3
                                                              BearerToken✓OAS3
                                                              OAuth2_Implicit✓OAS2,OAS3
                                                              OAuth2_Password✗OAS2,OAS3
                                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                                              OAuth2_AuthorizationCode✗OAS2,OAS3
                                                              SignatureAuth✗OAS3
                                                              AWSV4Signature✗ToolingExtension

                                                              Wire Format Feature​

                                                              NameSupportedDefined By
                                                              JSON✓OAS2,OAS3
                                                              XML✓OAS2,OAS3
                                                              PROTOBUF✗ToolingExtension
                                                              Custom✗OAS2,OAS3
                                                              - + \ No newline at end of file diff --git a/docs/generators/php-symfony/index.html b/docs/generators/php-symfony/index.html index 16c666edc0d..a0025f1dc1d 100644 --- a/docs/generators/php-symfony/index.html +++ b/docs/generators/php-symfony/index.html @@ -15,13 +15,13 @@ - +

                                                              Documentation for the php-symfony Generator

                                                              METADATA​

                                                              PropertyValueNotes
                                                              generator namephp-symfonypass this to the generate command after -g
                                                              generator stabilitySTABLE
                                                              generator typeSERVER
                                                              generator languagePHP
                                                              generator default templating enginemustache
                                                              helpTxtGenerates a PHP Symfony server bundle.

                                                              CONFIG OPTIONS​

                                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                              OptionDescriptionValuesDefault
                                                              allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                              apiPackagepackage for generated api classesnull
                                                              artifactUrlartifact URL in generated pom.xmlnull
                                                              artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                              bundleAliasThe alias of the Symfony bundle. The template uses {{aliasName}}null
                                                              bundleNameThe name of the Symfony bundle. The template uses {{bundleName}}null
                                                              composerPackageNameThe name to use in the composer package name field. e.g. vendor/project (must be lowercase and consist of words separated by -, . or _).null
                                                              composerProjectNameThe project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-clientnull
                                                              composerVendorNameThe vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypetsnull
                                                              developerOrganizationdeveloper organization in generated pom.xmlnull
                                                              developerOrganizationUrldeveloper organization URL in generated pom.xmlnull
                                                              disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              false
                                                              The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                              true
                                                              Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              		true
                                                              ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                              enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                              false
                                                              No changes to the enum's are made, this is the default option.
                                                              true
                                                              With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                              		false
                                                              hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                              invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                              legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                              true
                                                              The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                              false
                                                              The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                              		true
                                                              licenseNameThe name of the licensenull
                                                              modelPackagepackage for generated modelsnull
                                                              packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                              phpLegacySupportShould the generated code be compatible with PHP 5.x?true
                                                              prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                              sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                              sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                              srcBasePathThe directory to serve as source root.null
                                                              variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                              IMPORT MAPPING​

                                                              Type/AliasImports

                                                              INSTANTIATION TYPES​

                                                              Type/AliasInstantiated By
                                                              arrayarray
                                                              maparray

                                                              LANGUAGE PRIMITIVES​

                                                              • UploadedFile
                                                              • \DateTime
                                                              • array
                                                              • bool
                                                              • byte
                                                              • float
                                                              • int
                                                              • mixed
                                                              • number
                                                              • object
                                                              • string
                                                              • void

                                                              RESERVED WORDS​

                                                              • __halt_compiler
                                                              • _header_accept
                                                              • _tempbody
                                                              • abstract
                                                              • and
                                                              • array
                                                              • as
                                                              • break
                                                              • callable
                                                              • case
                                                              • catch
                                                              • class
                                                              • clone
                                                              • const
                                                              • continue
                                                              • declare
                                                              • default
                                                              • die
                                                              • do
                                                              • echo
                                                              • else
                                                              • elseif
                                                              • empty
                                                              • enddeclare
                                                              • endfor
                                                              • endforeach
                                                              • endif
                                                              • endswitch
                                                              • endwhile
                                                              • eval
                                                              • exit
                                                              • extends
                                                              • final
                                                              • for
                                                              • foreach
                                                              • formparams
                                                              • function
                                                              • global
                                                              • goto
                                                              • headerparams
                                                              • httpbody
                                                              • if
                                                              • implements
                                                              • include
                                                              • include_once
                                                              • instanceof
                                                              • insteadof
                                                              • interface
                                                              • isset
                                                              • list
                                                              • namespace
                                                              • new
                                                              • or
                                                              • print
                                                              • private
                                                              • protected
                                                              • public
                                                              • queryparams
                                                              • require
                                                              • require_once
                                                              • resourcepath
                                                              • return
                                                              • static
                                                              • switch
                                                              • throw
                                                              • trait
                                                              • try
                                                              • unset
                                                              • use
                                                              • var
                                                              • while
                                                              • xor

                                                              FEATURE SET​

                                                              Client Modification Feature​

                                                              NameSupportedDefined By
                                                              BasePath✗ToolingExtension
                                                              Authorizations✗ToolingExtension
                                                              UserAgent✗ToolingExtension
                                                              MockServer✗ToolingExtension

                                                              Data Type Feature​

                                                              NameSupportedDefined By
                                                              Custom✗OAS2,OAS3
                                                              Int32✓OAS2,OAS3
                                                              Int64✓OAS2,OAS3
                                                              Float✓OAS2,OAS3
                                                              Double✓OAS2,OAS3
                                                              Decimal✓ToolingExtension
                                                              String✓OAS2,OAS3
                                                              Byte✓OAS2,OAS3
                                                              Binary✓OAS2,OAS3
                                                              Boolean✓OAS2,OAS3
                                                              Date✓OAS2,OAS3
                                                              DateTime✓OAS2,OAS3
                                                              Password✓OAS2,OAS3
                                                              File✓OAS2
                                                              Uuid✗
                                                              Array✓OAS2,OAS3
                                                              Null✗OAS3
                                                              AnyType✗OAS2,OAS3
                                                              Object✓OAS2,OAS3
                                                              Maps✓ToolingExtension
                                                              CollectionFormat✓OAS2
                                                              CollectionFormatMulti✓OAS2
                                                              Enum✓OAS2,OAS3
                                                              ArrayOfEnum✓ToolingExtension
                                                              ArrayOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                              ArrayOfCollectionOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                                              MapOfEnum✓ToolingExtension
                                                              MapOfModel✓ToolingExtension
                                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                                              MapOfCollectionOfModel✓ToolingExtension
                                                              MapOfCollectionOfEnum✓ToolingExtension

                                                              Documentation Feature​

                                                              NameSupportedDefined By
                                                              Readme✓ToolingExtension
                                                              Model✓ToolingExtension
                                                              Api✓ToolingExtension

                                                              Global Feature​

                                                              NameSupportedDefined By
                                                              Host✓OAS2,OAS3
                                                              BasePath✓OAS2,OAS3
                                                              Info✓OAS2,OAS3
                                                              Schemes✗OAS2,OAS3
                                                              PartialSchemes✓OAS2,OAS3
                                                              Consumes✓OAS2
                                                              Produces✓OAS2
                                                              ExternalDocumentation✓OAS2,OAS3
                                                              Examples✓OAS2,OAS3
                                                              XMLStructureDefinitions✗OAS2,OAS3
                                                              MultiServer✗OAS3
                                                              ParameterizedServer✗OAS3
                                                              ParameterStyling✗OAS3
                                                              Callbacks✗OAS3
                                                              LinkObjects✗OAS3

                                                              Parameter Feature​

                                                              NameSupportedDefined By
                                                              Path✓OAS2,OAS3
                                                              Query✓OAS2,OAS3
                                                              Header✓OAS2,OAS3
                                                              Body✓OAS2
                                                              FormUnencoded✓OAS2
                                                              FormMultipart✓OAS2
                                                              Cookie✓OAS3

                                                              Schema Support Feature​

                                                              NameSupportedDefined By
                                                              Simple✓OAS2,OAS3
                                                              Composite✓OAS2,OAS3
                                                              Polymorphism✗OAS2,OAS3
                                                              Union✗OAS3
                                                              allOf✗OAS2,OAS3
                                                              anyOf✗OAS3
                                                              oneOf✗OAS3
                                                              not✗OAS3

                                                              Security Feature​

                                                              NameSupportedDefined By
                                                              BasicAuth✓OAS2,OAS3
                                                              ApiKey✓OAS2,OAS3
                                                              OpenIDConnect✗OAS3
                                                              BearerToken✗OAS3
                                                              OAuth2_Implicit✓OAS2,OAS3
                                                              OAuth2_Password✗OAS2,OAS3
                                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                                              OAuth2_AuthorizationCode✗OAS2,OAS3
                                                              SignatureAuth✗OAS3
                                                              AWSV4Signature✗ToolingExtension

                                                              Wire Format Feature​

                                                              NameSupportedDefined By
                                                              JSON✓OAS2,OAS3
                                                              XML✓OAS2,OAS3
                                                              PROTOBUF✗ToolingExtension
                                                              Custom✗OAS2,OAS3
                                                              - + \ No newline at end of file diff --git a/docs/generators/php/index.html b/docs/generators/php/index.html index 52d0e892811..237c48fd979 100644 --- a/docs/generators/php/index.html +++ b/docs/generators/php/index.html @@ -15,13 +15,13 @@ - +

                                                              Documentation for the php Generator

                                                              METADATA​

                                                              PropertyValueNotes
                                                              generator namephppass this to the generate command after -g
                                                              generator stabilitySTABLE
                                                              generator typeCLIENT
                                                              generator languagePHP
                                                              generator default templating enginemustache
                                                              helpTxtGenerates a PHP client library.

                                                              CONFIG OPTIONS​

                                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                              OptionDescriptionValuesDefault
                                                              allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                              apiPackagepackage for generated api classesnull
                                                              artifactUrlartifact URL in generated pom.xmlnull
                                                              artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                              composerPackageNameThe name to use in the composer package name field. e.g. vendor/project (must be lowercase and consist of words separated by -, . or _).null
                                                              developerOrganizationdeveloper organization in generated pom.xmlnull
                                                              developerOrganizationUrldeveloper organization URL in generated pom.xmlnull
                                                              disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              false
                                                              The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                              true
                                                              Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              		true
                                                              ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                              enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                              false
                                                              No changes to the enum's are made, this is the default option.
                                                              true
                                                              With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                              		false
                                                              hideGenerationTimestampboolean, toggles whether unicode identifiers are allowed in names or not, default is falsetrue
                                                              invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                              legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                              true
                                                              The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                              false
                                                              The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                              		true
                                                              libraryHTTP library template (sub-template) to use
                                                              guzzle
                                                              Guzzle
                                                              psr-18
                                                              psr/http-client-implementation, also known as PSR-18. (beta support)
                                                              		guzzle
                                                              licenseNameThe name of the licensenull
                                                              modelPackagepackage for generated modelsnull
                                                              packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                              prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                              sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                              sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                              srcBasePathThe directory to serve as source root.null
                                                              variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                              IMPORT MAPPING​

                                                              Type/AliasImports

                                                              INSTANTIATION TYPES​

                                                              Type/AliasInstantiated By
                                                              arrayarray
                                                              maparray

                                                              LANGUAGE PRIMITIVES​

                                                              • \DateTime
                                                              • \SplFileObject
                                                              • array
                                                              • bool
                                                              • boolean
                                                              • byte
                                                              • float
                                                              • int
                                                              • integer
                                                              • mixed
                                                              • number
                                                              • object
                                                              • string
                                                              • void

                                                              RESERVED WORDS​

                                                              • __halt_compiler
                                                              • _header_accept
                                                              • _tempbody
                                                              • abstract
                                                              • and
                                                              • array
                                                              • as
                                                              • break
                                                              • callable
                                                              • case
                                                              • catch
                                                              • class
                                                              • clone
                                                              • const
                                                              • continue
                                                              • declare
                                                              • default
                                                              • die
                                                              • do
                                                              • echo
                                                              • else
                                                              • elseif
                                                              • empty
                                                              • enddeclare
                                                              • endfor
                                                              • endforeach
                                                              • endif
                                                              • endswitch
                                                              • endwhile
                                                              • eval
                                                              • exit
                                                              • extends
                                                              • final
                                                              • for
                                                              • foreach
                                                              • formparams
                                                              • function
                                                              • global
                                                              • goto
                                                              • headerparams
                                                              • httpbody
                                                              • if
                                                              • implements
                                                              • include
                                                              • include_once
                                                              • instanceof
                                                              • insteadof
                                                              • interface
                                                              • isset
                                                              • list
                                                              • namespace
                                                              • new
                                                              • or
                                                              • print
                                                              • private
                                                              • protected
                                                              • public
                                                              • queryparams
                                                              • require
                                                              • require_once
                                                              • resourcepath
                                                              • return
                                                              • static
                                                              • switch
                                                              • throw
                                                              • trait
                                                              • try
                                                              • unset
                                                              • use
                                                              • var
                                                              • while
                                                              • xor

                                                              FEATURE SET​

                                                              Client Modification Feature​

                                                              NameSupportedDefined By
                                                              BasePath✗ToolingExtension
                                                              Authorizations✗ToolingExtension
                                                              UserAgent✗ToolingExtension
                                                              MockServer✗ToolingExtension

                                                              Data Type Feature​

                                                              NameSupportedDefined By
                                                              Custom✗OAS2,OAS3
                                                              Int32✓OAS2,OAS3
                                                              Int64✓OAS2,OAS3
                                                              Float✓OAS2,OAS3
                                                              Double✓OAS2,OAS3
                                                              Decimal✓ToolingExtension
                                                              String✓OAS2,OAS3
                                                              Byte✓OAS2,OAS3
                                                              Binary✓OAS2,OAS3
                                                              Boolean✓OAS2,OAS3
                                                              Date✓OAS2,OAS3
                                                              DateTime✓OAS2,OAS3
                                                              Password✓OAS2,OAS3
                                                              File✓OAS2
                                                              Uuid✗
                                                              Array✓OAS2,OAS3
                                                              Null✗OAS3
                                                              AnyType✗OAS2,OAS3
                                                              Object✓OAS2,OAS3
                                                              Maps✓ToolingExtension
                                                              CollectionFormat✓OAS2
                                                              CollectionFormatMulti✓OAS2
                                                              Enum✓OAS2,OAS3
                                                              ArrayOfEnum✓ToolingExtension
                                                              ArrayOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                              ArrayOfCollectionOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                                              MapOfEnum✓ToolingExtension
                                                              MapOfModel✓ToolingExtension
                                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                                              MapOfCollectionOfModel✓ToolingExtension
                                                              MapOfCollectionOfEnum✓ToolingExtension

                                                              Documentation Feature​

                                                              NameSupportedDefined By
                                                              Readme✓ToolingExtension
                                                              Model✓ToolingExtension
                                                              Api✓ToolingExtension

                                                              Global Feature​

                                                              NameSupportedDefined By
                                                              Host✓OAS2,OAS3
                                                              BasePath✓OAS2,OAS3
                                                              Info✓OAS2,OAS3
                                                              Schemes✗OAS2,OAS3
                                                              PartialSchemes✓OAS2,OAS3
                                                              Consumes✓OAS2
                                                              Produces✓OAS2
                                                              ExternalDocumentation✓OAS2,OAS3
                                                              Examples✓OAS2,OAS3
                                                              XMLStructureDefinitions✗OAS2,OAS3
                                                              MultiServer✓OAS3
                                                              ParameterizedServer✗OAS3
                                                              ParameterStyling✗OAS3
                                                              Callbacks✗OAS3
                                                              LinkObjects✗OAS3

                                                              Parameter Feature​

                                                              NameSupportedDefined By
                                                              Path✓OAS2,OAS3
                                                              Query✓OAS2,OAS3
                                                              Header✓OAS2,OAS3
                                                              Body✓OAS2
                                                              FormUnencoded✓OAS2
                                                              FormMultipart✓OAS2
                                                              Cookie✓OAS3

                                                              Schema Support Feature​

                                                              NameSupportedDefined By
                                                              Simple✓OAS2,OAS3
                                                              Composite✓OAS2,OAS3
                                                              Polymorphism✗OAS2,OAS3
                                                              Union✗OAS3
                                                              allOf✗OAS2,OAS3
                                                              anyOf✗OAS3
                                                              oneOf✗OAS3
                                                              not✗OAS3

                                                              Security Feature​

                                                              NameSupportedDefined By
                                                              BasicAuth✓OAS2,OAS3
                                                              ApiKey✓OAS2,OAS3
                                                              OpenIDConnect✗OAS3
                                                              BearerToken✓OAS3
                                                              OAuth2_Implicit✓OAS2,OAS3
                                                              OAuth2_Password✗OAS2,OAS3
                                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                                              OAuth2_AuthorizationCode✗OAS2,OAS3
                                                              SignatureAuth✗OAS3
                                                              AWSV4Signature✗ToolingExtension

                                                              Wire Format Feature​

                                                              NameSupportedDefined By
                                                              JSON✓OAS2,OAS3
                                                              XML✓OAS2,OAS3
                                                              PROTOBUF✗ToolingExtension
                                                              Custom✗OAS2,OAS3
                                                              - + \ No newline at end of file diff --git a/docs/generators/plantuml/index.html b/docs/generators/plantuml/index.html index 145c7c28656..8779acf69cb 100644 --- a/docs/generators/plantuml/index.html +++ b/docs/generators/plantuml/index.html @@ -15,13 +15,13 @@ - +

                                                              Documentation for the plantuml Generator

                                                              METADATA​

                                                              PropertyValueNotes
                                                              generator nameplantumlpass this to the generate command after -g
                                                              generator stabilityBETA
                                                              generator typeDOCUMENTATION
                                                              generator default templating enginemustache
                                                              helpTxtGenerates a plantuml documentation.

                                                              CONFIG OPTIONS​

                                                              These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                              OptionDescriptionValuesDefault
                                                              allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                              disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              false
                                                              The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                              true
                                                              Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                              		true
                                                              ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                              enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                              false
                                                              No changes to the enum's are made, this is the default option.
                                                              true
                                                              With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                              		false
                                                              legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                              true
                                                              The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                              false
                                                              The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                              		true
                                                              prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                              sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                              sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                              IMPORT MAPPING​

                                                              Type/AliasImports

                                                              INSTANTIATION TYPES​

                                                              Type/AliasInstantiated By

                                                              LANGUAGE PRIMITIVES​

                                                                RESERVED WORDS​

                                                                  FEATURE SET​

                                                                  Client Modification Feature​

                                                                  NameSupportedDefined By
                                                                  BasePath✗ToolingExtension
                                                                  Authorizations✗ToolingExtension
                                                                  UserAgent✗ToolingExtension
                                                                  MockServer✗ToolingExtension

                                                                  Data Type Feature​

                                                                  NameSupportedDefined By
                                                                  Custom✗OAS2,OAS3
                                                                  Int32✓OAS2,OAS3
                                                                  Int64✓OAS2,OAS3
                                                                  Float✓OAS2,OAS3
                                                                  Double✓OAS2,OAS3
                                                                  Decimal✓ToolingExtension
                                                                  String✓OAS2,OAS3
                                                                  Byte✓OAS2,OAS3
                                                                  Binary✓OAS2,OAS3
                                                                  Boolean✓OAS2,OAS3
                                                                  Date✓OAS2,OAS3
                                                                  DateTime✓OAS2,OAS3
                                                                  Password✓OAS2,OAS3
                                                                  File✓OAS2
                                                                  Uuid✗
                                                                  Array✓OAS2,OAS3
                                                                  Null✗OAS3
                                                                  AnyType✗OAS2,OAS3
                                                                  Object✓OAS2,OAS3
                                                                  Maps✓ToolingExtension
                                                                  CollectionFormat✓OAS2
                                                                  CollectionFormatMulti✓OAS2
                                                                  Enum✓OAS2,OAS3
                                                                  ArrayOfEnum✓ToolingExtension
                                                                  ArrayOfModel✓ToolingExtension
                                                                  ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                  ArrayOfCollectionOfModel✓ToolingExtension
                                                                  ArrayOfCollectionOfEnum✓ToolingExtension
                                                                  MapOfEnum✓ToolingExtension
                                                                  MapOfModel✓ToolingExtension
                                                                  MapOfCollectionOfPrimitives✓ToolingExtension
                                                                  MapOfCollectionOfModel✓ToolingExtension
                                                                  MapOfCollectionOfEnum✓ToolingExtension

                                                                  Documentation Feature​

                                                                  NameSupportedDefined By
                                                                  Readme✗ToolingExtension
                                                                  Model✓ToolingExtension
                                                                  Api✓ToolingExtension

                                                                  Global Feature​

                                                                  NameSupportedDefined By
                                                                  Host✓OAS2,OAS3
                                                                  BasePath✓OAS2,OAS3
                                                                  Info✓OAS2,OAS3
                                                                  Schemes✗OAS2,OAS3
                                                                  PartialSchemes✓OAS2,OAS3
                                                                  Consumes✓OAS2
                                                                  Produces✓OAS2
                                                                  ExternalDocumentation✓OAS2,OAS3
                                                                  Examples✓OAS2,OAS3
                                                                  XMLStructureDefinitions✗OAS2,OAS3
                                                                  MultiServer✗OAS3
                                                                  ParameterizedServer✗OAS3
                                                                  ParameterStyling✗OAS3
                                                                  Callbacks✓OAS3
                                                                  LinkObjects✗OAS3

                                                                  Parameter Feature​

                                                                  NameSupportedDefined By
                                                                  Path✓OAS2,OAS3
                                                                  Query✓OAS2,OAS3
                                                                  Header✓OAS2,OAS3
                                                                  Body✓OAS2
                                                                  FormUnencoded✓OAS2
                                                                  FormMultipart✓OAS2
                                                                  Cookie✓OAS3

                                                                  Schema Support Feature​

                                                                  NameSupportedDefined By
                                                                  Simple✓OAS2,OAS3
                                                                  Composite✓OAS2,OAS3
                                                                  Polymorphism✓OAS2,OAS3
                                                                  Union✗OAS3
                                                                  allOf✗OAS2,OAS3
                                                                  anyOf✗OAS3
                                                                  oneOf✗OAS3
                                                                  not✗OAS3

                                                                  Security Feature​

                                                                  NameSupportedDefined By
                                                                  BasicAuth✓OAS2,OAS3
                                                                  ApiKey✓OAS2,OAS3
                                                                  OpenIDConnect✗OAS3
                                                                  BearerToken✓OAS3
                                                                  OAuth2_Implicit✓OAS2,OAS3
                                                                  OAuth2_Password✓OAS2,OAS3
                                                                  OAuth2_ClientCredentials✓OAS2,OAS3
                                                                  OAuth2_AuthorizationCode✓OAS2,OAS3
                                                                  SignatureAuth✗OAS3
                                                                  AWSV4Signature✗ToolingExtension

                                                                  Wire Format Feature​

                                                                  NameSupportedDefined By
                                                                  JSON✓OAS2,OAS3
                                                                  XML✓OAS2,OAS3
                                                                  PROTOBUF✗ToolingExtension
                                                                  Custom✗OAS2,OAS3
                                                                  - + \ No newline at end of file diff --git a/docs/generators/postman-collection/index.html b/docs/generators/postman-collection/index.html index c8288fbbb09..18d52721d05 100644 --- a/docs/generators/postman-collection/index.html +++ b/docs/generators/postman-collection/index.html @@ -15,13 +15,13 @@ - +

                                                                  Documentation for the postman-collection Generator

                                                                  METADATA​

                                                                  PropertyValueNotes
                                                                  generator namepostman-collectionpass this to the generate command after -g
                                                                  generator stabilityBETA
                                                                  generator typeSCHEMA
                                                                  generator default templating enginemustache
                                                                  helpTxtGenerates a Postman collection (format v2.1.0) JSON file

                                                                  CONFIG OPTIONS​

                                                                  These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                  OptionDescriptionValuesDefault
                                                                  folderStrategywhether to create folders according to the spec’s paths or tagsnull
                                                                  pathParamsAsVariableswhether to create Postman variables for path parametersfalse
                                                                  postmanGuidwhether to convert placeholders (i.e. {{UNIQUE_REFERENCE}}) into Postman formula {{$guid}}null
                                                                  postmanGuidPlaceholderNamename of the placeholder (i.e. {{UNIQUE_REFERENCE}}) to replace with Postman formula {{$guid}}null
                                                                  postmanIsoTimestampwhether to convert placeholders (i.e. {{ISO_TIMESTAMP}}) into Postman formula {{$isoTimestamp}}null
                                                                  postmanIsoTimestampPlaceholderNamename of the placeholder (i.e. {{ISO_TIMESTAMP}}) to replace with Postman formula {{$isoTimestamp}}null
                                                                  postmanVariableswhether to convert placeholders (i.e. {{VAR_1}}) into Postman variablesnull
                                                                  requestParameterGenerationwhether to generate the request parameters based on the schema or the examplesnull

                                                                  IMPORT MAPPING​

                                                                  Type/AliasImports

                                                                  INSTANTIATION TYPES​

                                                                  Type/AliasInstantiated By

                                                                  LANGUAGE PRIMITIVES​

                                                                    RESERVED WORDS​

                                                                      FEATURE SET​

                                                                      Client Modification Feature​

                                                                      NameSupportedDefined By
                                                                      BasePath✗ToolingExtension
                                                                      Authorizations✗ToolingExtension
                                                                      UserAgent✗ToolingExtension
                                                                      MockServer✗ToolingExtension

                                                                      Data Type Feature​

                                                                      NameSupportedDefined By
                                                                      Custom✗OAS2,OAS3
                                                                      Int32✓OAS2,OAS3
                                                                      Int64✓OAS2,OAS3
                                                                      Float✓OAS2,OAS3
                                                                      Double✓OAS2,OAS3
                                                                      Decimal✓ToolingExtension
                                                                      String✓OAS2,OAS3
                                                                      Byte✓OAS2,OAS3
                                                                      Binary✓OAS2,OAS3
                                                                      Boolean✓OAS2,OAS3
                                                                      Date✓OAS2,OAS3
                                                                      DateTime✓OAS2,OAS3
                                                                      Password✓OAS2,OAS3
                                                                      File✓OAS2
                                                                      Uuid✗
                                                                      Array✓OAS2,OAS3
                                                                      Null✗OAS3
                                                                      AnyType✗OAS2,OAS3
                                                                      Object✓OAS2,OAS3
                                                                      Maps✓ToolingExtension
                                                                      CollectionFormat✓OAS2
                                                                      CollectionFormatMulti✓OAS2
                                                                      Enum✓OAS2,OAS3
                                                                      ArrayOfEnum✓ToolingExtension
                                                                      ArrayOfModel✓ToolingExtension
                                                                      ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                      ArrayOfCollectionOfModel✓ToolingExtension
                                                                      ArrayOfCollectionOfEnum✓ToolingExtension
                                                                      MapOfEnum✓ToolingExtension
                                                                      MapOfModel✓ToolingExtension
                                                                      MapOfCollectionOfPrimitives✓ToolingExtension
                                                                      MapOfCollectionOfModel✓ToolingExtension
                                                                      MapOfCollectionOfEnum✓ToolingExtension

                                                                      Documentation Feature​

                                                                      NameSupportedDefined By
                                                                      Readme✗ToolingExtension
                                                                      Model✓ToolingExtension
                                                                      Api✓ToolingExtension

                                                                      Global Feature​

                                                                      NameSupportedDefined By
                                                                      Host✓OAS2,OAS3
                                                                      BasePath✓OAS2,OAS3
                                                                      Info✓OAS2,OAS3
                                                                      Schemes✗OAS2,OAS3
                                                                      PartialSchemes✓OAS2,OAS3
                                                                      Consumes✓OAS2
                                                                      Produces✓OAS2
                                                                      ExternalDocumentation✓OAS2,OAS3
                                                                      Examples✓OAS2,OAS3
                                                                      XMLStructureDefinitions✗OAS2,OAS3
                                                                      MultiServer✗OAS3
                                                                      ParameterizedServer✗OAS3
                                                                      ParameterStyling✗OAS3
                                                                      Callbacks✓OAS3
                                                                      LinkObjects✗OAS3

                                                                      Parameter Feature​

                                                                      NameSupportedDefined By
                                                                      Path✓OAS2,OAS3
                                                                      Query✓OAS2,OAS3
                                                                      Header✓OAS2,OAS3
                                                                      Body✓OAS2
                                                                      FormUnencoded✓OAS2
                                                                      FormMultipart✓OAS2
                                                                      Cookie✓OAS3

                                                                      Schema Support Feature​

                                                                      NameSupportedDefined By
                                                                      Simple✓OAS2,OAS3
                                                                      Composite✓OAS2,OAS3
                                                                      Polymorphism✓OAS2,OAS3
                                                                      Union✗OAS3
                                                                      allOf✗OAS2,OAS3
                                                                      anyOf✗OAS3
                                                                      oneOf✗OAS3
                                                                      not✗OAS3

                                                                      Security Feature​

                                                                      NameSupportedDefined By
                                                                      BasicAuth✓OAS2,OAS3
                                                                      ApiKey✓OAS2,OAS3
                                                                      OpenIDConnect✗OAS3
                                                                      BearerToken✓OAS3
                                                                      OAuth2_Implicit✓OAS2,OAS3
                                                                      OAuth2_Password✓OAS2,OAS3
                                                                      OAuth2_ClientCredentials✓OAS2,OAS3
                                                                      OAuth2_AuthorizationCode✓OAS2,OAS3
                                                                      SignatureAuth✗OAS3
                                                                      AWSV4Signature✗ToolingExtension

                                                                      Wire Format Feature​

                                                                      NameSupportedDefined By
                                                                      JSON✓OAS2,OAS3
                                                                      XML✓OAS2,OAS3
                                                                      PROTOBUF✗ToolingExtension
                                                                      Custom✗OAS2,OAS3
                                                                      - + \ No newline at end of file diff --git a/docs/generators/postman/index.html b/docs/generators/postman/index.html index 40b34e4af0b..48d3eab89e2 100644 --- a/docs/generators/postman/index.html +++ b/docs/generators/postman/index.html @@ -15,13 +15,13 @@ - +

                                                                      Documentation for the postman Generator

                                                                      METADATA​

                                                                      PropertyValueNotes
                                                                      generator namepostmanpass this to the generate command after -g
                                                                      generator stabilityBETA
                                                                      generator typeDOCUMENTATION
                                                                      generator default templating enginemustache
                                                                      helpTxtGenerates a postman JSON file

                                                                      CONFIG OPTIONS​

                                                                      These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                      OptionDescriptionValuesDefault
                                                                      folderStrategywhether to create folders according to the spec’s paths or tagsnull
                                                                      pathParamsAsVariableswhether to create Postman variables for path parametersfalse
                                                                      postmanGuidwhether to convert placeholders (i.e. {{UNIQUE_REFERENCE}}) into Postman formula {{$guid}}null
                                                                      postmanGuidPlaceholderNamename of the placeholder (i.e. {{UNIQUE_REFERENCE}}) to replace with Postman formula {{$guid}}null
                                                                      postmanIsoTimestampwhether to convert placeholders (i.e. {{ISO_TIMESTAMP}}) into Postman formula {{$isoTimestamp}}null
                                                                      postmanIsoTimestampPlaceholderNamename of the placeholder (i.e. {{ISO_TIMESTAMP}}) to replace with Postman formula {{$isoTimestamp}}null
                                                                      postmanVariableswhether to convert placeholders (i.e. {{VAR_1}}) into Postman variablesnull
                                                                      requestParameterGenerationwhether to generate the request parameters based on the schema or the examplesnull

                                                                      IMPORT MAPPING​

                                                                      Type/AliasImports

                                                                      INSTANTIATION TYPES​

                                                                      Type/AliasInstantiated By

                                                                      LANGUAGE PRIMITIVES​

                                                                        RESERVED WORDS​

                                                                          FEATURE SET​

                                                                          Client Modification Feature​

                                                                          NameSupportedDefined By
                                                                          BasePath✗ToolingExtension
                                                                          Authorizations✗ToolingExtension
                                                                          UserAgent✗ToolingExtension
                                                                          MockServer✗ToolingExtension

                                                                          Data Type Feature​

                                                                          NameSupportedDefined By
                                                                          Custom✗OAS2,OAS3
                                                                          Int32✓OAS2,OAS3
                                                                          Int64✓OAS2,OAS3
                                                                          Float✓OAS2,OAS3
                                                                          Double✓OAS2,OAS3
                                                                          Decimal✓ToolingExtension
                                                                          String✓OAS2,OAS3
                                                                          Byte✓OAS2,OAS3
                                                                          Binary✓OAS2,OAS3
                                                                          Boolean✓OAS2,OAS3
                                                                          Date✓OAS2,OAS3
                                                                          DateTime✓OAS2,OAS3
                                                                          Password✓OAS2,OAS3
                                                                          File✓OAS2
                                                                          Uuid✗
                                                                          Array✓OAS2,OAS3
                                                                          Null✗OAS3
                                                                          AnyType✗OAS2,OAS3
                                                                          Object✓OAS2,OAS3
                                                                          Maps✓ToolingExtension
                                                                          CollectionFormat✓OAS2
                                                                          CollectionFormatMulti✓OAS2
                                                                          Enum✓OAS2,OAS3
                                                                          ArrayOfEnum✓ToolingExtension
                                                                          ArrayOfModel✓ToolingExtension
                                                                          ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                          ArrayOfCollectionOfModel✓ToolingExtension
                                                                          ArrayOfCollectionOfEnum✓ToolingExtension
                                                                          MapOfEnum✓ToolingExtension
                                                                          MapOfModel✓ToolingExtension
                                                                          MapOfCollectionOfPrimitives✓ToolingExtension
                                                                          MapOfCollectionOfModel✓ToolingExtension
                                                                          MapOfCollectionOfEnum✓ToolingExtension

                                                                          Documentation Feature​

                                                                          NameSupportedDefined By
                                                                          Readme✗ToolingExtension
                                                                          Model✓ToolingExtension
                                                                          Api✓ToolingExtension

                                                                          Global Feature​

                                                                          NameSupportedDefined By
                                                                          Host✓OAS2,OAS3
                                                                          BasePath✓OAS2,OAS3
                                                                          Info✓OAS2,OAS3
                                                                          Schemes✗OAS2,OAS3
                                                                          PartialSchemes✓OAS2,OAS3
                                                                          Consumes✓OAS2
                                                                          Produces✓OAS2
                                                                          ExternalDocumentation✓OAS2,OAS3
                                                                          Examples✓OAS2,OAS3
                                                                          XMLStructureDefinitions✗OAS2,OAS3
                                                                          MultiServer✗OAS3
                                                                          ParameterizedServer✗OAS3
                                                                          ParameterStyling✗OAS3
                                                                          Callbacks✓OAS3
                                                                          LinkObjects✗OAS3

                                                                          Parameter Feature​

                                                                          NameSupportedDefined By
                                                                          Path✓OAS2,OAS3
                                                                          Query✓OAS2,OAS3
                                                                          Header✓OAS2,OAS3
                                                                          Body✓OAS2
                                                                          FormUnencoded✓OAS2
                                                                          FormMultipart✓OAS2
                                                                          Cookie✓OAS3

                                                                          Schema Support Feature​

                                                                          NameSupportedDefined By
                                                                          Simple✓OAS2,OAS3
                                                                          Composite✓OAS2,OAS3
                                                                          Polymorphism✓OAS2,OAS3
                                                                          Union✗OAS3
                                                                          allOf✗OAS2,OAS3
                                                                          anyOf✗OAS3
                                                                          oneOf✗OAS3
                                                                          not✗OAS3

                                                                          Security Feature​

                                                                          NameSupportedDefined By
                                                                          BasicAuth✓OAS2,OAS3
                                                                          ApiKey✓OAS2,OAS3
                                                                          OpenIDConnect✗OAS3
                                                                          BearerToken✓OAS3
                                                                          OAuth2_Implicit✓OAS2,OAS3
                                                                          OAuth2_Password✓OAS2,OAS3
                                                                          OAuth2_ClientCredentials✓OAS2,OAS3
                                                                          OAuth2_AuthorizationCode✓OAS2,OAS3
                                                                          SignatureAuth✗OAS3

                                                                          Wire Format Feature​

                                                                          NameSupportedDefined By
                                                                          JSON✓OAS2,OAS3
                                                                          XML✓OAS2,OAS3
                                                                          PROTOBUF✗ToolingExtension
                                                                          Custom✗OAS2,OAS3
                                                                          - + \ No newline at end of file diff --git a/docs/generators/powershell/index.html b/docs/generators/powershell/index.html index dd2ecee3a7b..15502e029f8 100644 --- a/docs/generators/powershell/index.html +++ b/docs/generators/powershell/index.html @@ -15,13 +15,13 @@ - +

                                                                          Documentation for the powershell Generator

                                                                          METADATA​

                                                                          PropertyValueNotes
                                                                          generator namepowershellpass this to the generate command after -g
                                                                          generator stabilityBETA
                                                                          generator typeCLIENT
                                                                          generator languagePowerShell
                                                                          generator default templating enginemustache
                                                                          helpTxtGenerates a PowerShell API client (beta)

                                                                          CONFIG OPTIONS​

                                                                          These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                          OptionDescriptionValuesDefault
                                                                          apiNamePrefixPrefix that will be appended to all PS objects. Default: empty string. e.g. Pet => PSPet.null
                                                                          commonVerbsPS common verb mappings. e.g. Delete=Remove:Patch=Update to map Delete with Remove and Patch with Update accordingly.null
                                                                          disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                          false
                                                                          The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                          true
                                                                          Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                          		true
                                                                          discardReadOnlySet discardReadonly to true to generate the Initialize cmdlet without readonly parametersnull
                                                                          iconUriA URL to an icon representing the generated PowerShell modulenull
                                                                          licenseUriA URL to the license for the generated PowerShell modulenull
                                                                          modelsCmdletVerbVerb to be used when generating the Models cmdlets in the examples.Initialize
                                                                          packageGuidGUID for PowerShell module (e.g. a27b908d-2a20-467f-bc32-af6f3a654ac5). A random GUID will be generated by default.null
                                                                          packageNameClient package name (e.g. PSTwitter).PSOpenAPITools
                                                                          packageVersionPackage version (e.g. 0.1.2).0.1.2
                                                                          powershellGalleryUrlURL to the module in PowerShell Gallery (e.g. https://www.powershellgallery.com/packages/PSTwitter/).null
                                                                          projectUriA URL to the main website for this projectnull
                                                                          releaseNotesRelease notes of the generated PowerShell modulenull
                                                                          skipVerbParsingSet skipVerbParsing to not try get powershell verbs of operation namesnull
                                                                          tagsTags applied to the generated PowerShell module. These help with module discovery in online galleriesnull
                                                                          useClassNameInModelsExamplesUse classname instead of name when generating the Models cmdlets in the examples.true
                                                                          useOneOfDiscriminatorLookupUse the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped.null

                                                                          IMPORT MAPPING​

                                                                          Type/AliasImports

                                                                          INSTANTIATION TYPES​

                                                                          Type/AliasInstantiated By

                                                                          LANGUAGE PRIMITIVES​

                                                                          • Boolean
                                                                          • Byte
                                                                          • Byte[]
                                                                          • Char
                                                                          • Decimal
                                                                          • Double
                                                                          • Guid
                                                                          • Int16
                                                                          • Int32
                                                                          • Int64
                                                                          • ProgressRecord
                                                                          • SByte
                                                                          • SecureString
                                                                          • Single
                                                                          • String
                                                                          • System.DateTime
                                                                          • System.IO.FileInfo
                                                                          • TimeSpan
                                                                          • UInt16
                                                                          • UInt32
                                                                          • UInt64
                                                                          • Uri
                                                                          • Version
                                                                          • XmlDocument

                                                                          RESERVED WORDS​

                                                                          • args
                                                                          • begin
                                                                          • break
                                                                          • catch
                                                                          • consolefilename
                                                                          • continue
                                                                          • data
                                                                          • do
                                                                          • dynamicparam
                                                                          • else
                                                                          • elseif
                                                                          • end
                                                                          • error
                                                                          • event
                                                                          • eventargs
                                                                          • eventsubscriber
                                                                          • executioncontext
                                                                          • exit
                                                                          • false
                                                                          • filter
                                                                          • finally
                                                                          • for
                                                                          • foreach
                                                                          • from
                                                                          • function
                                                                          • home
                                                                          • host
                                                                          • if
                                                                          • in
                                                                          • input
                                                                          • lastexitcode
                                                                          • local
                                                                          • matches
                                                                          • myinvocation
                                                                          • nestedpromptlevel
                                                                          • null
                                                                          • param
                                                                          • pid
                                                                          • private
                                                                          • process
                                                                          • profile
                                                                          • pscmdlet
                                                                          • pscommandpath
                                                                          • psculture
                                                                          • psdebugcontext
                                                                          • pshome
                                                                          • psitem
                                                                          • psscriptroot
                                                                          • pssenderinfo
                                                                          • psuiculture
                                                                          • psversiontable
                                                                          • return
                                                                          • sender
                                                                          • shellid
                                                                          • stacktrace
                                                                          • switch
                                                                          • this
                                                                          • throw
                                                                          • trap
                                                                          • true
                                                                          • try
                                                                          • until
                                                                          • where
                                                                          • while

                                                                          FEATURE SET​

                                                                          Client Modification Feature​

                                                                          NameSupportedDefined By
                                                                          BasePath✗ToolingExtension
                                                                          Authorizations✗ToolingExtension
                                                                          UserAgent✗ToolingExtension
                                                                          MockServer✗ToolingExtension

                                                                          Data Type Feature​

                                                                          NameSupportedDefined By
                                                                          Custom✗OAS2,OAS3
                                                                          Int32✓OAS2,OAS3
                                                                          Int64✓OAS2,OAS3
                                                                          Float✓OAS2,OAS3
                                                                          Double✓OAS2,OAS3
                                                                          Decimal✓ToolingExtension
                                                                          String✓OAS2,OAS3
                                                                          Byte✓OAS2,OAS3
                                                                          Binary✓OAS2,OAS3
                                                                          Boolean✓OAS2,OAS3
                                                                          Date✓OAS2,OAS3
                                                                          DateTime✓OAS2,OAS3
                                                                          Password✓OAS2,OAS3
                                                                          File✓OAS2
                                                                          Uuid✗
                                                                          Array✓OAS2,OAS3
                                                                          Null✗OAS3
                                                                          AnyType✗OAS2,OAS3
                                                                          Object✓OAS2,OAS3
                                                                          Maps✓ToolingExtension
                                                                          CollectionFormat✓OAS2
                                                                          CollectionFormatMulti✓OAS2
                                                                          Enum✓OAS2,OAS3
                                                                          ArrayOfEnum✓ToolingExtension
                                                                          ArrayOfModel✓ToolingExtension
                                                                          ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                          ArrayOfCollectionOfModel✓ToolingExtension
                                                                          ArrayOfCollectionOfEnum✓ToolingExtension
                                                                          MapOfEnum✓ToolingExtension
                                                                          MapOfModel✓ToolingExtension
                                                                          MapOfCollectionOfPrimitives✓ToolingExtension
                                                                          MapOfCollectionOfModel✓ToolingExtension
                                                                          MapOfCollectionOfEnum✓ToolingExtension

                                                                          Documentation Feature​

                                                                          NameSupportedDefined By
                                                                          Readme✓ToolingExtension
                                                                          Model✓ToolingExtension
                                                                          Api✓ToolingExtension

                                                                          Global Feature​

                                                                          NameSupportedDefined By
                                                                          Host✓OAS2,OAS3
                                                                          BasePath✓OAS2,OAS3
                                                                          Info✓OAS2,OAS3
                                                                          Schemes✗OAS2,OAS3
                                                                          PartialSchemes✓OAS2,OAS3
                                                                          Consumes✓OAS2
                                                                          Produces✓OAS2
                                                                          ExternalDocumentation✓OAS2,OAS3
                                                                          Examples✓OAS2,OAS3
                                                                          XMLStructureDefinitions✗OAS2,OAS3
                                                                          MultiServer✗OAS3
                                                                          ParameterizedServer✗OAS3
                                                                          ParameterStyling✗OAS3
                                                                          Callbacks✗OAS3
                                                                          LinkObjects✗OAS3

                                                                          Parameter Feature​

                                                                          NameSupportedDefined By
                                                                          Path✓OAS2,OAS3
                                                                          Query✓OAS2,OAS3
                                                                          Header✓OAS2,OAS3
                                                                          Body✓OAS2
                                                                          FormUnencoded✓OAS2
                                                                          FormMultipart✓OAS2
                                                                          Cookie✗OAS3

                                                                          Schema Support Feature​

                                                                          NameSupportedDefined By
                                                                          Simple✓OAS2,OAS3
                                                                          Composite✓OAS2,OAS3
                                                                          Polymorphism✗OAS2,OAS3
                                                                          Union✗OAS3
                                                                          allOf✗OAS2,OAS3
                                                                          anyOf✗OAS3
                                                                          oneOf✗OAS3
                                                                          not✗OAS3

                                                                          Security Feature​

                                                                          NameSupportedDefined By
                                                                          BasicAuth✓OAS2,OAS3
                                                                          ApiKey✓OAS2,OAS3
                                                                          OpenIDConnect✗OAS3
                                                                          BearerToken✓OAS3
                                                                          OAuth2_Implicit✗OAS2,OAS3
                                                                          OAuth2_Password✗OAS2,OAS3
                                                                          OAuth2_ClientCredentials✗OAS2,OAS3
                                                                          OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                          SignatureAuth✓OAS3
                                                                          AWSV4Signature✗ToolingExtension

                                                                          Wire Format Feature​

                                                                          NameSupportedDefined By
                                                                          JSON✓OAS2,OAS3
                                                                          XML✓OAS2,OAS3
                                                                          PROTOBUF✗ToolingExtension
                                                                          Custom✗OAS2,OAS3
                                                                          - + \ No newline at end of file diff --git a/docs/generators/protobuf-schema/index.html b/docs/generators/protobuf-schema/index.html index ce015ac9686..72c969aee9b 100644 --- a/docs/generators/protobuf-schema/index.html +++ b/docs/generators/protobuf-schema/index.html @@ -15,13 +15,13 @@ - +

                                                                          Documentation for the protobuf-schema Generator

                                                                          METADATA​

                                                                          PropertyValueNotes
                                                                          generator nameprotobuf-schemapass this to the generate command after -g
                                                                          generator stabilityBETA
                                                                          generator typeSCHEMA
                                                                          generator languageProtocol Buffers (Protobuf)
                                                                          generator default templating enginemustache
                                                                          helpTxtGenerates gRPC and protocol buffer schema files (beta)

                                                                          CONFIG OPTIONS​

                                                                          These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                          OptionDescriptionValuesDefault
                                                                          numberedFieldNumberListField numbers in order.false
                                                                          startEnumsWithUnknownIntroduces "UNKNOWN" as the first element of enumerations.false

                                                                          IMPORT MAPPING​

                                                                          Type/AliasImports

                                                                          INSTANTIATION TYPES​

                                                                          Type/AliasInstantiated By
                                                                          arrayrepeat
                                                                          setrepeat

                                                                          LANGUAGE PRIMITIVES​

                                                                          • array
                                                                          • bool
                                                                          • bytes
                                                                          • double
                                                                          • fixed32
                                                                          • fixed64
                                                                          • float
                                                                          • int32
                                                                          • int64
                                                                          • map
                                                                          • set
                                                                          • sfixed32
                                                                          • sfixed64
                                                                          • sint32
                                                                          • sint64
                                                                          • string
                                                                          • uint32
                                                                          • uint64

                                                                          RESERVED WORDS​

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✓OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✗OAS2,OAS3
                                                                            ApiKey✗OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✗OAS2,OAS3
                                                                            XML✗OAS2,OAS3
                                                                            PROTOBUF✓ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/python-aiohttp/index.html b/docs/generators/python-aiohttp/index.html index e8d247ebc6b..37ecb23d79b 100644 --- a/docs/generators/python-aiohttp/index.html +++ b/docs/generators/python-aiohttp/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the python-aiohttp Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namepython-aiohttppass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeSERVER
                                                                            generator languagePython
                                                                            generator language version3.5.2+
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Python server library using the Connexion project. By default, it will also generate service classes -- which you can disable with the -Dnoservice environment variable.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            controllerPackagecontroller packagecontrollers
                                                                            defaultControllerdefault controllerdefault_controller
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            featureCORSuse flask-cors for handling CORS requestsfalse
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            packageNamepython package name (convention: snake_case).openapi_server
                                                                            packageVersionpython package version.1.0.0
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            pythonSrcRootput python sources in this subdirectory of output folder (defaults to "" for). Use this for src/ layout.
                                                                            serverPortTCP port to listen to in app.run8080
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            testsUsePythonSrcRootgenerates test under the pythonSrcRoot folder.false
                                                                            useNoseuse the nose test frameworkfalse
                                                                            usePythonSrcRootInImportsinclude pythonSrcRoot in import namespaces.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Dict
                                                                            • List
                                                                            • bool
                                                                            • bytes
                                                                            • date
                                                                            • datetime
                                                                            • dict
                                                                            • file
                                                                            • float
                                                                            • int
                                                                            • list
                                                                            • object
                                                                            • str

                                                                            RESERVED WORDS​

                                                                            • all_params
                                                                            • and
                                                                            • as
                                                                            • assert
                                                                            • async
                                                                            • auth_settings
                                                                            • await
                                                                            • base64
                                                                            • body_params
                                                                            • break
                                                                            • class
                                                                            • continue
                                                                            • date
                                                                            • def
                                                                            • del
                                                                            • elif
                                                                            • else
                                                                            • except
                                                                            • exec
                                                                            • false
                                                                            • field
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • form_params
                                                                            • from
                                                                            • global
                                                                            • header_params
                                                                            • if
                                                                            • import
                                                                            • in
                                                                            • is
                                                                            • json
                                                                            • lambda
                                                                            • local_var_files
                                                                            • none
                                                                            • nonlocal
                                                                            • not
                                                                            • or
                                                                            • pass
                                                                            • path_params
                                                                            • print
                                                                            • property
                                                                            • query_params
                                                                            • raise
                                                                            • resource_path
                                                                            • return
                                                                            • schema
                                                                            • self
                                                                            • true
                                                                            • try
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/python-blueplanet/index.html b/docs/generators/python-blueplanet/index.html index c22d09b3e00..4e0c52d8993 100644 --- a/docs/generators/python-blueplanet/index.html +++ b/docs/generators/python-blueplanet/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the python-blueplanet Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namepython-blueplanetpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeSERVER
                                                                            generator languagePython
                                                                            generator language version3.5.2+
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Python server library using the Connexion project. By default, it will also generate service classes -- which you can disable with the -Dnoservice environment variable.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            controllerPackagecontroller packagecontrollers
                                                                            defaultControllerdefault controllerdefault_controller
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            featureCORSuse flask-cors for handling CORS requestsfalse
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            packageNamepython package name (convention: snake_case).openapi_server
                                                                            packageVersionpython package version.1.0.0
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            pythonSrcRootput python sources in this subdirectory of output folder (defaults to "" for). Use this for src/ layout.
                                                                            serverPortTCP port to listen to in app.run8080
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            testsUsePythonSrcRootgenerates test under the pythonSrcRoot folder.false
                                                                            useNoseuse the nose test frameworkfalse
                                                                            usePythonSrcRootInImportsinclude pythonSrcRoot in import namespaces.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Dict
                                                                            • List
                                                                            • bool
                                                                            • bytes
                                                                            • date
                                                                            • datetime
                                                                            • dict
                                                                            • file
                                                                            • float
                                                                            • int
                                                                            • list
                                                                            • object
                                                                            • str

                                                                            RESERVED WORDS​

                                                                            • all_params
                                                                            • and
                                                                            • as
                                                                            • assert
                                                                            • async
                                                                            • auth_settings
                                                                            • await
                                                                            • base64
                                                                            • body_params
                                                                            • break
                                                                            • class
                                                                            • continue
                                                                            • date
                                                                            • def
                                                                            • del
                                                                            • elif
                                                                            • else
                                                                            • except
                                                                            • exec
                                                                            • false
                                                                            • field
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • form_params
                                                                            • from
                                                                            • global
                                                                            • header_params
                                                                            • if
                                                                            • import
                                                                            • in
                                                                            • is
                                                                            • json
                                                                            • lambda
                                                                            • local_var_files
                                                                            • none
                                                                            • nonlocal
                                                                            • not
                                                                            • or
                                                                            • pass
                                                                            • path_params
                                                                            • print
                                                                            • property
                                                                            • query_params
                                                                            • raise
                                                                            • resource_path
                                                                            • return
                                                                            • schema
                                                                            • self
                                                                            • true
                                                                            • try
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/python-fastapi/index.html b/docs/generators/python-fastapi/index.html index 0781a502575..5f223865e12 100644 --- a/docs/generators/python-fastapi/index.html +++ b/docs/generators/python-fastapi/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the python-fastapi Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namepython-fastapipass this to the generate command after -g
                                                                            generator stabilityBETA
                                                                            generator typeSERVER
                                                                            generator languagePython
                                                                            generator language version3.7
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Python FastAPI server (beta). Models are defined with the pydantic library

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            fastapiImplementationPackagepython package name for the implementation code (convention: snake_case).impl
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            packageNamepython package name (convention: snake_case).openapi_server
                                                                            packageVersionpython package version.1.0.0
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            serverPortTCP port to listen to in app.run8080
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFolderdirectory for generated python source codesrc

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Dict
                                                                            • List
                                                                            • bool
                                                                            • bytes
                                                                            • date
                                                                            • datetime
                                                                            • dict
                                                                            • file
                                                                            • float
                                                                            • int
                                                                            • list
                                                                            • object
                                                                            • str

                                                                            RESERVED WORDS​

                                                                            • all_params
                                                                            • and
                                                                            • as
                                                                            • assert
                                                                            • async
                                                                            • auth_settings
                                                                            • await
                                                                            • base64
                                                                            • body_params
                                                                            • break
                                                                            • class
                                                                            • continue
                                                                            • date
                                                                            • def
                                                                            • del
                                                                            • elif
                                                                            • else
                                                                            • except
                                                                            • exec
                                                                            • false
                                                                            • field
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • form_params
                                                                            • from
                                                                            • global
                                                                            • header_params
                                                                            • if
                                                                            • import
                                                                            • in
                                                                            • is
                                                                            • json
                                                                            • lambda
                                                                            • local_var_files
                                                                            • none
                                                                            • nonlocal
                                                                            • not
                                                                            • or
                                                                            • pass
                                                                            • path_params
                                                                            • print
                                                                            • property
                                                                            • query_params
                                                                            • raise
                                                                            • resource_path
                                                                            • return
                                                                            • schema
                                                                            • self
                                                                            • true
                                                                            • try
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✗ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✓OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✓OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✓OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/python-flask/index.html b/docs/generators/python-flask/index.html index a8548c1307d..6b687242d53 100644 --- a/docs/generators/python-flask/index.html +++ b/docs/generators/python-flask/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the python-flask Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namepython-flaskpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeSERVER
                                                                            generator languagePython
                                                                            generator language version3.5.2+
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Python server library using the Connexion project. By default, it will also generate service classes -- which you can disable with the -Dnoservice environment variable.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            controllerPackagecontroller packagecontrollers
                                                                            defaultControllerdefault controllerdefault_controller
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            featureCORSuse flask-cors for handling CORS requestsfalse
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            packageNamepython package name (convention: snake_case).openapi_server
                                                                            packageVersionpython package version.1.0.0
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            pythonSrcRootput python sources in this subdirectory of output folder (defaults to "" for). Use this for src/ layout.
                                                                            serverPortTCP port to listen to in app.run8080
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            testsUsePythonSrcRootgenerates test under the pythonSrcRoot folder.false
                                                                            useNoseuse the nose test frameworkfalse
                                                                            usePythonSrcRootInImportsinclude pythonSrcRoot in import namespaces.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Dict
                                                                            • List
                                                                            • bool
                                                                            • bytes
                                                                            • date
                                                                            • datetime
                                                                            • dict
                                                                            • file
                                                                            • float
                                                                            • int
                                                                            • list
                                                                            • object
                                                                            • str

                                                                            RESERVED WORDS​

                                                                            • all_params
                                                                            • and
                                                                            • as
                                                                            • assert
                                                                            • async
                                                                            • auth_settings
                                                                            • await
                                                                            • base64
                                                                            • body_params
                                                                            • break
                                                                            • class
                                                                            • continue
                                                                            • date
                                                                            • def
                                                                            • del
                                                                            • elif
                                                                            • else
                                                                            • except
                                                                            • exec
                                                                            • false
                                                                            • field
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • form_params
                                                                            • from
                                                                            • global
                                                                            • header_params
                                                                            • if
                                                                            • import
                                                                            • in
                                                                            • is
                                                                            • json
                                                                            • lambda
                                                                            • local_var_files
                                                                            • none
                                                                            • nonlocal
                                                                            • not
                                                                            • or
                                                                            • pass
                                                                            • path_params
                                                                            • print
                                                                            • property
                                                                            • query_params
                                                                            • raise
                                                                            • resource_path
                                                                            • return
                                                                            • schema
                                                                            • self
                                                                            • true
                                                                            • try
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✓OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/python-pydantic-v1/index.html b/docs/generators/python-pydantic-v1/index.html index 5d1785ffc73..ed9bdb1379a 100644 --- a/docs/generators/python-pydantic-v1/index.html +++ b/docs/generators/python-pydantic-v1/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the python-pydantic-v1 Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namepython-pydantic-v1pass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languagePython
                                                                            generator language version3.7+
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Python client library.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            dateFormatdate format for query parameters%Y-%m-%d
                                                                            datetimeFormatdatetime format for query parameters%Y-%m-%dT%H:%M:%S%z
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            generateSourceCodeOnlySpecifies that only a library source code is to be generated.false
                                                                            hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                            librarylibrary template (sub-template) to use: asyncio, tornado (deprecated), urllib3urllib3
                                                                            mapNumberToMap number to Union[StrictFloat, StrictInt], StrictStr or float.Union[StrictFloat, StrictInt]
                                                                            packageNamepython package name (convention: snake_case).openapi_client
                                                                            packageUrlpython package URL.null
                                                                            packageVersionpython package version.1.0.0
                                                                            projectNamepython project name in setup.py (e.g. petstore-api).null
                                                                            recursionLimitSet the recursion limit. If not set, use the system default value.null
                                                                            useOneOfDiscriminatorLookupUse the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Dict
                                                                            • List
                                                                            • bool
                                                                            • bytearray
                                                                            • bytes
                                                                            • date
                                                                            • datetime
                                                                            • decimal.Decimal
                                                                            • dict
                                                                            • float
                                                                            • int
                                                                            • list
                                                                            • none_type
                                                                            • object
                                                                            • str

                                                                            RESERVED WORDS​

                                                                            • and
                                                                            • as
                                                                            • assert
                                                                            • async
                                                                            • await
                                                                            • base64
                                                                            • break
                                                                            • class
                                                                            • continue
                                                                            • date
                                                                            • def
                                                                            • del
                                                                            • elif
                                                                            • else
                                                                            • except
                                                                            • exec
                                                                            • false
                                                                            • finally
                                                                            • for
                                                                            • from
                                                                            • global
                                                                            • if
                                                                            • import
                                                                            • in
                                                                            • is
                                                                            • json
                                                                            • lambda
                                                                            • none
                                                                            • nonlocal
                                                                            • not
                                                                            • or
                                                                            • pass
                                                                            • print
                                                                            • property
                                                                            • raise
                                                                            • return
                                                                            • schema
                                                                            • self
                                                                            • true
                                                                            • try
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✓OAS2,OAS3
                                                                            anyOf✓OAS3
                                                                            oneOf✓OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✓OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/python/index.html b/docs/generators/python/index.html index fedf3a8476b..2a80e758e2c 100644 --- a/docs/generators/python/index.html +++ b/docs/generators/python/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the python Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namepythonpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languagePython
                                                                            generator language version3.7+
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Python client library.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            dateFormatdate format for query parameters%Y-%m-%d
                                                                            datetimeFormatdatetime format for query parameters%Y-%m-%dT%H:%M:%S%z
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            generateSourceCodeOnlySpecifies that only a library source code is to be generated.false
                                                                            hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                            librarylibrary template (sub-template) to use: asyncio, tornado (deprecated), urllib3urllib3
                                                                            mapNumberToMap number to Union[StrictFloat, StrictInt], StrictStr or float.Union[StrictFloat, StrictInt]
                                                                            packageNamepython package name (convention: snake_case).openapi_client
                                                                            packageUrlpython package URL.null
                                                                            packageVersionpython package version.1.0.0
                                                                            projectNamepython project name in setup.py (e.g. petstore-api).null
                                                                            recursionLimitSet the recursion limit. If not set, use the system default value.null
                                                                            setEnsureAsciiToFalseWhen set to true, add ensure_ascii=False in json.dumps when creating the HTTP request body.false
                                                                            useOneOfDiscriminatorLookupUse the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Dict
                                                                            • List
                                                                            • bool
                                                                            • bytearray
                                                                            • bytes
                                                                            • date
                                                                            • datetime
                                                                            • decimal.Decimal
                                                                            • dict
                                                                            • float
                                                                            • int
                                                                            • list
                                                                            • none_type
                                                                            • object
                                                                            • str

                                                                            RESERVED WORDS​

                                                                            • all_params
                                                                            • and
                                                                            • as
                                                                            • assert
                                                                            • async
                                                                            • auth_settings
                                                                            • await
                                                                            • base64
                                                                            • body_params
                                                                            • break
                                                                            • class
                                                                            • continue
                                                                            • date
                                                                            • def
                                                                            • del
                                                                            • elif
                                                                            • else
                                                                            • except
                                                                            • exec
                                                                            • false
                                                                            • field
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • form_params
                                                                            • from
                                                                            • global
                                                                            • header_params
                                                                            • if
                                                                            • import
                                                                            • in
                                                                            • is
                                                                            • json
                                                                            • lambda
                                                                            • local_var_files
                                                                            • none
                                                                            • nonlocal
                                                                            • not
                                                                            • or
                                                                            • pass
                                                                            • path_params
                                                                            • print
                                                                            • property
                                                                            • query_params
                                                                            • raise
                                                                            • resource_path
                                                                            • return
                                                                            • schema
                                                                            • self
                                                                            • true
                                                                            • try
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✓OAS2,OAS3
                                                                            anyOf✓OAS3
                                                                            oneOf✓OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✓OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/r/index.html b/docs/generators/r/index.html index f82654d32fa..9f9f7b99efc 100644 --- a/docs/generators/r/index.html +++ b/docs/generators/r/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the r Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namerpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageR
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a R client library (beta).

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            errorObjectTypeError object type.null
                                                                            exceptionPackageSpecify the exception handling package
                                                                            default
                                                                            Use stop() for raising exceptions.
                                                                            rlang
                                                                            Use rlang package for exceptions.
                                                                            		default
                                                                            generateWrapperGenerate a wrapper class (single point of access) for the R client. This option only works with httr2 library.false
                                                                            hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                            libraryHTTP library template (sub-template) to use
                                                                            httr2
                                                                            httr2 (https://httr2.r-lib.org/)
                                                                            httr
                                                                            httr (https://cran.r-project.org/web/packages/httr/index.html)
                                                                            		httr
                                                                            operationIdNamingNaming convention for operationId (function name in the API)
                                                                            PascalCase
                                                                            Pascal case (default)
                                                                            snake_case
                                                                            Snake case
                                                                            camelCase
                                                                            Camel case
                                                                            		null
                                                                            packageNameR package name (convention: lowercase).openapi
                                                                            packageVersionR package version.1.0.0
                                                                            returnExceptionOnFailureThrow an exception on non success response codesfalse

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By

                                                                            LANGUAGE PRIMITIVES​

                                                                            • character
                                                                            • data.frame
                                                                            • integer
                                                                            • numeric
                                                                            • object

                                                                            RESERVED WORDS​

                                                                            • apiresponse
                                                                            • break
                                                                            • data_file
                                                                            • else
                                                                            • false
                                                                            • for
                                                                            • function
                                                                            • if
                                                                            • in
                                                                            • inf
                                                                            • na
                                                                            • na_character_
                                                                            • na_complex_
                                                                            • na_integer_
                                                                            • na_real_
                                                                            • nan
                                                                            • next
                                                                            • null
                                                                            • repeat
                                                                            • true
                                                                            • while

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✓ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/ruby-on-rails/index.html b/docs/generators/ruby-on-rails/index.html index 67de6be37ba..e480fa32ea8 100644 --- a/docs/generators/ruby-on-rails/index.html +++ b/docs/generators/ruby-on-rails/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the ruby-on-rails Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nameruby-on-railspass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeSERVER
                                                                            generator languageRuby
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Ruby on Rails (v5) server library.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            databaseAdapterThe adapter for database (e.g. mysql, sqlite). Default: sqlitesqlite

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray
                                                                            mapHash
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Boolean
                                                                            • Date
                                                                            • File
                                                                            • Float
                                                                            • Hash
                                                                            • Integer
                                                                            • Object
                                                                            • String
                                                                            • Time

                                                                            RESERVED WORDS​

                                                                            • __file__
                                                                            • __line__
                                                                            • alias
                                                                            • and
                                                                            • begin
                                                                            • break
                                                                            • case
                                                                            • class
                                                                            • def
                                                                            • defined?
                                                                            • do
                                                                            • else
                                                                            • elsif
                                                                            • end
                                                                            • ensure
                                                                            • false
                                                                            • for
                                                                            • if
                                                                            • in
                                                                            • module
                                                                            • next
                                                                            • nil
                                                                            • not
                                                                            • or
                                                                            • redo
                                                                            • rescue
                                                                            • retry
                                                                            • return
                                                                            • self
                                                                            • super
                                                                            • then
                                                                            • true
                                                                            • undef
                                                                            • unless
                                                                            • until
                                                                            • when
                                                                            • while
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✗OAS2,OAS3
                                                                            ApiKey✗OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/ruby-sinatra/index.html b/docs/generators/ruby-sinatra/index.html index 0ae2d583b47..acbff8470bd 100644 --- a/docs/generators/ruby-sinatra/index.html +++ b/docs/generators/ruby-sinatra/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the ruby-sinatra Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nameruby-sinatrapass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeSERVER
                                                                            generator languageRuby
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Ruby Sinatra server library.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray
                                                                            mapHash
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Boolean
                                                                            • Date
                                                                            • File
                                                                            • Float
                                                                            • Hash
                                                                            • Integer
                                                                            • Object
                                                                            • String
                                                                            • Time

                                                                            RESERVED WORDS​

                                                                            • __file__
                                                                            • __line__
                                                                            • alias
                                                                            • and
                                                                            • begin
                                                                            • break
                                                                            • case
                                                                            • class
                                                                            • def
                                                                            • defined?
                                                                            • do
                                                                            • else
                                                                            • elsif
                                                                            • end
                                                                            • ensure
                                                                            • false
                                                                            • for
                                                                            • if
                                                                            • in
                                                                            • module
                                                                            • next
                                                                            • nil
                                                                            • not
                                                                            • or
                                                                            • redo
                                                                            • rescue
                                                                            • retry
                                                                            • return
                                                                            • self
                                                                            • super
                                                                            • then
                                                                            • true
                                                                            • undef
                                                                            • unless
                                                                            • until
                                                                            • when
                                                                            • while
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✗OAS2,OAS3
                                                                            ApiKey✗OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/ruby/index.html b/docs/generators/ruby/index.html index b57281910a8..ce141658822 100644 --- a/docs/generators/ruby/index.html +++ b/docs/generators/ruby/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the ruby Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namerubypass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageRuby
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Ruby client library.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            gemAuthorgem author (only one is supported).OpenAPI-Generator
                                                                            gemAuthorEmailgem author email (only one is supported).null
                                                                            gemDescriptiongem description.This gem maps to a REST API
                                                                            gemHomepagegem homepage.https://openapi-generator.tech
                                                                            gemLicensegem license.unlicense
                                                                            gemMetadatagem metadata.{}
                                                                            gemNamegem name (convention: underscore_case).openapi_client
                                                                            gemRequiredRubyVersiongem required Ruby version.>= 2.4
                                                                            gemSummarygem summary.A ruby wrapper for the REST APIs
                                                                            gemVersiongem version.1.0.0
                                                                            hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            libraryHTTP library template (sub-template) to use
                                                                            faraday
                                                                            Faraday >= 1.0.1 (https://github.com/lostisland/faraday)
                                                                            httpx
                                                                            HTTPX >= 1.0.0 (https://gitlab.com/os85/httpx)
                                                                            typhoeus
                                                                            Typhoeus >= 1.0.1 (https://github.com/typhoeus/typhoeus)
                                                                            		typhoeus
                                                                            moduleNametop module name (convention: CamelCase, usually corresponding to gem name).OpenAPIClient
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            useAutoloadUse autoload instead of require to load modules.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray
                                                                            mapHash
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Boolean
                                                                            • Date
                                                                            • File
                                                                            • Float
                                                                            • Hash
                                                                            • Integer
                                                                            • Object
                                                                            • String
                                                                            • Time
                                                                            • array
                                                                            • int
                                                                            • map
                                                                            • string

                                                                            RESERVED WORDS​

                                                                            • __file__
                                                                            • __line__
                                                                            • _header_accept
                                                                            • _header_accept_result
                                                                            • _header_content_type
                                                                            • alias
                                                                            • and
                                                                            • auth_names
                                                                            • begin
                                                                            • break
                                                                            • case
                                                                            • class
                                                                            • def
                                                                            • defined?
                                                                            • do
                                                                            • else
                                                                            • elsif
                                                                            • end
                                                                            • ensure
                                                                            • false
                                                                            • for
                                                                            • form_params
                                                                            • header_params
                                                                            • if
                                                                            • in
                                                                            • local_var_path
                                                                            • module
                                                                            • next
                                                                            • nil
                                                                            • not
                                                                            • or
                                                                            • post_body
                                                                            • query_params
                                                                            • redo
                                                                            • rescue
                                                                            • retry
                                                                            • return
                                                                            • self
                                                                            • send
                                                                            • super
                                                                            • then
                                                                            • true
                                                                            • undef
                                                                            • unless
                                                                            • until
                                                                            • when
                                                                            • while
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✓ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/rust-axum/index.html b/docs/generators/rust-axum/index.html index d3055025918..15dddad37e2 100644 --- a/docs/generators/rust-axum/index.html +++ b/docs/generators/rust-axum/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the rust-axum Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namerust-axumpass this to the generate command after -g
                                                                            generator stabilityBETA
                                                                            generator typeSERVER
                                                                            generator languageRust
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Rust server library which bases on Axum.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowBlockingResponseSerializeBy default, json/form-urlencoded response serialization, which might perform a lot of compute in a future without yielding, is executed on a blocking thread via tokio::task::spawn_blocking. Set this option to true will override this behaviour and allow blocking call to happen. It helps to improve the performance when response serialization (e.g. returns tiny data) is low cost.false
                                                                            allowBlockingValidatorBy default, validation process, which might perform a lot of compute in a future without yielding, is executed on a blocking thread via tokio::task::spawn_blocking. Set this option to true will override this behaviour and allow blocking call to happen. It helps to improve the performance when validating request-data (header, path, query, body) is low cost.false
                                                                            disableValidatorDisable validating request-data (header, path, query, body) against OpenAPI Schema Specification.false
                                                                            packageNameRust crate name (convention: snake_case).openapi
                                                                            packageVersionRust crate version.null

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayVec
                                                                            mapstd::collections::HashMap

                                                                            LANGUAGE PRIMITIVES​

                                                                            • String
                                                                            • bool
                                                                            • char
                                                                            • f32
                                                                            • f64
                                                                            • i16
                                                                            • i32
                                                                            • i64
                                                                            • i8
                                                                            • isize
                                                                            • str
                                                                            • u16
                                                                            • u32
                                                                            • u64
                                                                            • u8
                                                                            • usize

                                                                            RESERVED WORDS​

                                                                            • Self
                                                                            • abstract
                                                                            • as
                                                                            • async
                                                                            • await
                                                                            • become
                                                                            • box
                                                                            • break
                                                                            • const
                                                                            • continue
                                                                            • crate
                                                                            • do
                                                                            • dyn
                                                                            • else
                                                                            • enum
                                                                            • extern
                                                                            • false
                                                                            • final
                                                                            • fn
                                                                            • for
                                                                            • if
                                                                            • impl
                                                                            • in
                                                                            • let
                                                                            • loop
                                                                            • macro
                                                                            • match
                                                                            • mod
                                                                            • move
                                                                            • mut
                                                                            • override
                                                                            • priv
                                                                            • pub
                                                                            • ref
                                                                            • return
                                                                            • self
                                                                            • static
                                                                            • struct
                                                                            • super
                                                                            • trait
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • typeof
                                                                            • unsafe
                                                                            • unsized
                                                                            • use
                                                                            • virtual
                                                                            • where
                                                                            • while
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✗ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✗OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✗OAS2,OAS3
                                                                            Examples✗OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✗OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✗OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/rust-server/index.html b/docs/generators/rust-server/index.html index 0702d5329f4..36d359f9056 100644 --- a/docs/generators/rust-server/index.html +++ b/docs/generators/rust-server/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the rust-server Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namerust-serverpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeSERVER
                                                                            generator languageRust
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Rust Hyper/Tower server library. Also generates a matching Hyper client library within the same crate that implements the same trait.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            packageNameRust crate name (convention: snake_case).openapi_client
                                                                            packageVersionRust crate version.null

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayVec
                                                                            mapstd::collections::HashMap

                                                                            LANGUAGE PRIMITIVES​

                                                                            • String
                                                                            • bool
                                                                            • char
                                                                            • f32
                                                                            • f64
                                                                            • i16
                                                                            • i32
                                                                            • i64
                                                                            • i8
                                                                            • isize
                                                                            • str
                                                                            • u16
                                                                            • u32
                                                                            • u64
                                                                            • u8
                                                                            • usize

                                                                            RESERVED WORDS​

                                                                            • Self
                                                                            • abstract
                                                                            • as
                                                                            • async
                                                                            • await
                                                                            • become
                                                                            • box
                                                                            • break
                                                                            • const
                                                                            • continue
                                                                            • crate
                                                                            • do
                                                                            • dyn
                                                                            • else
                                                                            • enum
                                                                            • extern
                                                                            • false
                                                                            • final
                                                                            • fn
                                                                            • for
                                                                            • if
                                                                            • impl
                                                                            • in
                                                                            • let
                                                                            • loop
                                                                            • macro
                                                                            • match
                                                                            • mod
                                                                            • move
                                                                            • mut
                                                                            • override
                                                                            • priv
                                                                            • pub
                                                                            • ref
                                                                            • return
                                                                            • self
                                                                            • static
                                                                            • struct
                                                                            • super
                                                                            • trait
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • typeof
                                                                            • unsafe
                                                                            • unsized
                                                                            • use
                                                                            • virtual
                                                                            • where
                                                                            • while
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✓OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/rust/index.html b/docs/generators/rust/index.html index 52a74385548..1ab014b9831 100644 --- a/docs/generators/rust/index.html +++ b/docs/generators/rust/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the rust Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namerustpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageRust
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Rust client library (beta).

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            avoidBoxedModelsIf set, Box&lt;T&gt; will not be used for modelsfalse
                                                                            bestFitIntUse best fitting integer type where minimum or maximum is setfalse
                                                                            enumNameSuffixSuffix that will be appended to all enum names.
                                                                            hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                            librarylibrary template (sub-template) to use.
                                                                            hyper
                                                                            HTTP client: Hyper (v1.x).
                                                                            hyper0x
                                                                            HTTP client: Hyper (v0.x).
                                                                            reqwest
                                                                            HTTP client: Reqwest.
                                                                            reqwest-trait
                                                                            HTTP client: Reqwest (trait based).
                                                                            		reqwest
                                                                            mockallAdds #[automock] from the mockall crate to api traits. This option is for 'reqwest-trait' library onlyfalse
                                                                            packageNameRust package name (convention: lowercase).openapi
                                                                            packageVersionRust package version.1.0.0
                                                                            preferUnsignedIntPrefer unsigned integers where minimum value is >= 0false
                                                                            supportAsyncIf set, generate async function call instead. This option is for 'reqwest' library onlytrue
                                                                            supportMiddlewareIf set, add support for reqwest-middleware. This option is for 'reqwest' and 'reqwest-trait' library onlyfalse
                                                                            supportMultipleResponsesIf set, return type wraps an enum of all possible 2xx schemas. This option is for 'reqwest' and 'reqwest-trait' library onlyfalse
                                                                            supportTokenSourceIf set, add support for google-cloud-token. This option is for 'reqwest' and 'reqwest-trait' library only and requires the 'supportAsync' optionfalse
                                                                            topLevelApiClientCreates a top level Api trait and ApiClient struct that contain all Apis. This option is for 'reqwest-trait' library onlyfalse
                                                                            useBonBuilderUse the bon crate for building parameter types. This option is for the 'reqwest-trait' library onlyfalse
                                                                            useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.false
                                                                            withAWSV4Signaturewhether to include AWS v4 signature supportfalse

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By

                                                                            LANGUAGE PRIMITIVES​

                                                                            • String
                                                                            • bool
                                                                            • char
                                                                            • f32
                                                                            • f64
                                                                            • i16
                                                                            • i32
                                                                            • i64
                                                                            • i8
                                                                            • isize
                                                                            • str
                                                                            • u16
                                                                            • u32
                                                                            • u64
                                                                            • u8
                                                                            • usize

                                                                            RESERVED WORDS​

                                                                            • Self
                                                                            • abstract
                                                                            • as
                                                                            • async
                                                                            • await
                                                                            • become
                                                                            • box
                                                                            • break
                                                                            • const
                                                                            • continue
                                                                            • crate
                                                                            • do
                                                                            • dyn
                                                                            • else
                                                                            • enum
                                                                            • extern
                                                                            • false
                                                                            • final
                                                                            • fn
                                                                            • for
                                                                            • if
                                                                            • impl
                                                                            • in
                                                                            • let
                                                                            • loop
                                                                            • macro
                                                                            • match
                                                                            • mod
                                                                            • move
                                                                            • mut
                                                                            • override
                                                                            • priv
                                                                            • pub
                                                                            • ref
                                                                            • return
                                                                            • self
                                                                            • static
                                                                            • struct
                                                                            • super
                                                                            • trait
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • typeof
                                                                            • unsafe
                                                                            • unsized
                                                                            • use
                                                                            • virtual
                                                                            • where
                                                                            • while
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✓ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✓OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✓ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scala-akka-http-server/index.html b/docs/generators/scala-akka-http-server/index.html index c22e7bcfb25..af7851bd924 100644 --- a/docs/generators/scala-akka-http-server/index.html +++ b/docs/generators/scala-akka-http-server/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scala-akka-http-server Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescala-akka-http-serverpass this to the generate command after -g
                                                                            generator stabilityBETA
                                                                            generator typeSERVER
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a scala-akka-http server (beta).

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            akkaHttpVersionThe version of akka-http10.1.10
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiPackagepackage for generated api classesnull
                                                                            artifactIdartifactIdopenapi-scala-akka-http-server
                                                                            artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                            asManagedSourcesResulting files cab be used as managed resources. No build files or default controllers will be generatedfalse
                                                                            dateLibraryOption. Date library to use
                                                                            joda
                                                                            Joda (for legacy app)
                                                                            java8
                                                                            Java 8 native JSR310 (preferred for JDK 1.8+)
                                                                            		java8
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            groupIdgroupId in generated pom.xmlorg.openapitools
                                                                            invokerPackageroot package for generated codeorg.openapitools.server
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            modelPackagepackage for generated modelsnull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFoldersource folder for generated codenull
                                                                            useApachePekkoUse apache pekko-http instead of akka-http.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            Arrayjava.util.List
                                                                            ArrayListjava.util.ArrayList
                                                                            Datejava.util.Date
                                                                            DateTimeorg.joda.time.*
                                                                            Filejava.io.File
                                                                            HashMapjava.util.HashMap
                                                                            ListBufferscala.collection.mutable.ListBuffer
                                                                            ListSetscala.collection.immutable.ListSet
                                                                            LocalDateorg.joda.time.*
                                                                            LocalDateTimeorg.joda.time.*
                                                                            LocalTimeorg.joda.time.*
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayListBuffer
                                                                            mapMap
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • Array
                                                                            • Boolean
                                                                            • Byte
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • List
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • Seq
                                                                            • String
                                                                            • boolean

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • case
                                                                            • catch
                                                                            • class
                                                                            • def
                                                                            • do
                                                                            • else
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • for
                                                                            • forsome
                                                                            • if
                                                                            • implicit
                                                                            • import
                                                                            • lazy
                                                                            • match
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • override
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • return
                                                                            • sealed
                                                                            • super
                                                                            • this
                                                                            • throw
                                                                            • trait
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • val
                                                                            • var
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scala-akka/index.html b/docs/generators/scala-akka/index.html index 5e14e9a39c3..6942e11280a 100644 --- a/docs/generators/scala-akka/index.html +++ b/docs/generators/scala-akka/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scala-akka Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescala-akkapass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Scala client library (beta) base on Akka/Spray.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiPackagepackage for generated api classesnull
                                                                            dateLibraryOption. Date library to use
                                                                            joda
                                                                            Joda (for legacy app)
                                                                            java8
                                                                            Java 8 native JSR310 (preferred for JDK 1.8+)
                                                                            		java8
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            mainPackageTop-level package name, which defines 'apiPackage', 'modelPackage', 'invokerPackage'org.openapitools.client
                                                                            modelPackagepackage for generated modelsnull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFoldersource folder for generated codenull

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            Arrayjava.util.List
                                                                            ArrayListjava.util.ArrayList
                                                                            BigDecimaljava.math.BigDecimal
                                                                            Datejava.util.Date
                                                                            DateTimeorg.joda.time.*
                                                                            Filejava.io.File
                                                                            HashMapjava.util.HashMap
                                                                            ListBufferscala.collection.mutable.ListBuffer
                                                                            ListSetscala.collection.immutable.ListSet
                                                                            LocalDateorg.joda.time.*
                                                                            LocalDateTimeorg.joda.time.*
                                                                            LocalTimeorg.joda.time.*
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayListBuffer
                                                                            mapMap
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • Array
                                                                            • Boolean
                                                                            • Byte
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • List
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • Seq
                                                                            • String
                                                                            • boolean

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • case
                                                                            • catch
                                                                            • class
                                                                            • def
                                                                            • do
                                                                            • else
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • for
                                                                            • forsome
                                                                            • if
                                                                            • implicit
                                                                            • import
                                                                            • lazy
                                                                            • match
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • override
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • return
                                                                            • sealed
                                                                            • super
                                                                            • this
                                                                            • throw
                                                                            • trait
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • val
                                                                            • var
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✓ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scala-cask/index.html b/docs/generators/scala-cask/index.html index 8a5d0938b53..4655834c894 100644 --- a/docs/generators/scala-cask/index.html +++ b/docs/generators/scala-cask/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scala-cask Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescala-caskpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeSERVER
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a scala-cask server.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiPackagepackage for generated api classesnull
                                                                            artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                                                                            artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.null
                                                                            dateLibraryOption. Date library to use
                                                                            joda
                                                                            Joda (for legacy app)
                                                                            java8
                                                                            Java 8 native JSR310 (preferred for JDK 1.8+)
                                                                            		java8
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            gitRepoIdGit repo ID, e.g. openapi-generator.null
                                                                            gitUserIdGit user ID, e.g. openapitools.null
                                                                            groupIdgroupId in generated pom.xmlnull
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            modelPackagepackage for generated modelsnull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            packageNamepackageDescriptionnull
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFoldersource folder for generated codenull

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            Arrayjava.util.List
                                                                            ArrayListjava.util.ArrayList
                                                                            Datejava.util.Date
                                                                            DateTimeorg.joda.time.*
                                                                            Filejava.io.File
                                                                            HashMapjava.util.HashMap
                                                                            ListBufferscala.collection.mutable.ListBuffer
                                                                            ListSetscala.collection.immutable.ListSet
                                                                            LocalDateorg.joda.time.*
                                                                            LocalDateTimeorg.joda.time.*
                                                                            LocalTimeorg.joda.time.*
                                                                            Seqscala.collection.immutable.Seq
                                                                            Setscala.collection.immutable.Set
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • Array
                                                                            • Boolean
                                                                            • Byte
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • List
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • Seq
                                                                            • String
                                                                            • boolean

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • assert
                                                                            • boolean
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • const
                                                                            • continue
                                                                            • default
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • extends
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • goto
                                                                            • if
                                                                            • implements
                                                                            • import
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • long
                                                                            • native
                                                                            • new
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • return
                                                                            • short
                                                                            • static
                                                                            • strictfp
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • throws
                                                                            • transient
                                                                            • try
                                                                            • type
                                                                            • void
                                                                            • volatile
                                                                            • while

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✗ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✓OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✓OAS2,OAS3
                                                                            OAuth2_ClientCredentials✓OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✓OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scala-finch/index.html b/docs/generators/scala-finch/index.html index df1e0422d61..bb6b58e88ab 100644 --- a/docs/generators/scala-finch/index.html +++ b/docs/generators/scala-finch/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scala-finch Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescala-finchpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeSERVER
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Scala server application with Finch.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            apiPackagepackage for generated api classesnull
                                                                            modelPackagepackage for generated modelsnull
                                                                            packageNameFinch package name (e.g. org.openapitools).org.openapitools

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            ArrayBufferscala.collection.mutable.ArrayBuffer
                                                                            Datejava.util.Date
                                                                            DateTimejava.time.LocalDateTime
                                                                            Filejava.io.File
                                                                            HashMapscala.collection.immutable.HashMap
                                                                            LocalDatejava.time.LocalDate
                                                                            LocalDateTimejava.time.LocalDateTime
                                                                            LocalTimejava.time.LocalTime
                                                                            Mapscala.collection.immutable.Map
                                                                            Seqscala.collection.immutable.Seq
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID
                                                                            ZonedDateTimejava.time.ZonedDateTime

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArrayList
                                                                            mapHashMap

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • AnyRef
                                                                            • AnyVal
                                                                            • Boolean
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • Integer
                                                                            • Long
                                                                            • Object
                                                                            • String

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • assert
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • const
                                                                            • continue
                                                                            • def
                                                                            • default
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • forsome
                                                                            • goto
                                                                            • if
                                                                            • implements
                                                                            • implicit
                                                                            • import
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • lazy
                                                                            • long
                                                                            • match
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • override
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • return
                                                                            • sealed
                                                                            • short
                                                                            • static
                                                                            • strictfp
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • throws
                                                                            • trait
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • val
                                                                            • var
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✗OAS2,OAS3
                                                                            ApiKey✗OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scala-gatling/index.html b/docs/generators/scala-gatling/index.html index a1a0c39b844..e3e864a71f6 100644 --- a/docs/generators/scala-gatling/index.html +++ b/docs/generators/scala-gatling/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scala-gatling Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescala-gatlingpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a gatling simulation library (beta).

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiPackagepackage for generated api classesnull
                                                                            dateLibraryOption. Date library to use
                                                                            joda
                                                                            Joda (for legacy app)
                                                                            java8
                                                                            Java 8 native JSR310 (preferred for JDK 1.8+)
                                                                            		java8
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            modelPackagepackage for generated modelsnull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFoldersource folder for generated codenull

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            Arrayjava.util.List
                                                                            ArrayListjava.util.ArrayList
                                                                            Datejava.util.Date
                                                                            DateTimeorg.joda.time.*
                                                                            Filejava.io.File
                                                                            HashMapjava.util.HashMap
                                                                            ListBufferscala.collection.mutable.ListBuffer
                                                                            ListSetscala.collection.immutable.ListSet
                                                                            LocalDateorg.joda.time.*
                                                                            LocalDateTimeorg.joda.time.*
                                                                            LocalTimeorg.joda.time.*
                                                                            Seqscala.collection.immutable.Seq
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayListBuffer
                                                                            mapHashMap
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • Array
                                                                            • Boolean
                                                                            • Byte
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • List
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • Seq
                                                                            • String
                                                                            • boolean

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • apiinvoker
                                                                            • basepath
                                                                            • case
                                                                            • catch
                                                                            • class
                                                                            • contenttype
                                                                            • contenttypes
                                                                            • def
                                                                            • do
                                                                            • else
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • for
                                                                            • formparams
                                                                            • forsome
                                                                            • headerparams
                                                                            • if
                                                                            • implicit
                                                                            • import
                                                                            • lazy
                                                                            • match
                                                                            • mp
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • override
                                                                            • package
                                                                            • path
                                                                            • postbody
                                                                            • private
                                                                            • protected
                                                                            • queryparams
                                                                            • return
                                                                            • sealed
                                                                            • super
                                                                            • this
                                                                            • throw
                                                                            • trait
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • val
                                                                            • var
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✗OAS2,OAS3
                                                                            ApiKey✗OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scala-http4s-server/index.html b/docs/generators/scala-http4s-server/index.html index fc14b1b9738..75be2aab7bb 100644 --- a/docs/generators/scala-http4s-server/index.html +++ b/docs/generators/scala-http4s-server/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scala-http4s-server Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescala-http4s-serverpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeSERVER
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Scala http4s server bindings.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            excludeSbtexclude sbt from generationnull
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceSubfoldername of subfolder, for example to generate code in src/scala/generatednull

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            Andeu.timepit.refined.boolean.And
                                                                            ArrayBufferscala.collection.mutable.ArrayBuffer
                                                                            Datejava.util.Date
                                                                            DateTimejava.time.LocalDateTime
                                                                            Filejava.io.File
                                                                            Greatereu.timepit.refined.numeric.Greater
                                                                            GreaterEqualeu.timepit.refined.numeric.GreaterEqual
                                                                            HashMapscala.collection.immutable.HashMap
                                                                            Lesseu.timepit.refined.numeric.Less
                                                                            LessEqualeu.timepit.refined.numeric.LessEqual
                                                                            LocalDatejava.time.LocalDate
                                                                            LocalDateTimejava.time.LocalDateTime
                                                                            LocalTimejava.time.LocalTime
                                                                            Mapscala.collection.immutable.Map
                                                                            MatchesRegexeu.timepit.refined.string.MatchesRegex
                                                                            MaxSizeeu.timepit.refined.collection.MaxSize
                                                                            MinSizeeu.timepit.refined.collection.MinSize
                                                                            OffsetDateTimejava.time.OffsetDateTime
                                                                            Refinedeu.timepit.refined.api.Refined
                                                                            Seqscala.collection.immutable.Seq
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID
                                                                            ZonedDateTimejava.time.ZonedDateTime

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArrayList
                                                                            mapHashMap

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • AnyRef
                                                                            • AnyVal
                                                                            • BigDecimal
                                                                            • Boolean
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • Integer
                                                                            • Long
                                                                            • Object
                                                                            • String

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • assert
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • const
                                                                            • continue
                                                                            • def
                                                                            • default
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • forsome
                                                                            • goto
                                                                            • if
                                                                            • implements
                                                                            • implicit
                                                                            • import
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • lazy
                                                                            • long
                                                                            • match
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • override
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • return
                                                                            • sealed
                                                                            • short
                                                                            • static
                                                                            • strictfp
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • throws
                                                                            • trait
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • val
                                                                            • var
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✗ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✗OAS2,OAS3
                                                                            ApiKey✗OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scala-http4s/index.html b/docs/generators/scala-http4s/index.html index 93c34e8256a..6b9c6b99b08 100644 --- a/docs/generators/scala-http4s/index.html +++ b/docs/generators/scala-http4s/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scala-http4s Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescala-http4spass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a scala-http4s client.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiPackagepackage for generated api classesnull
                                                                            dateLibraryOption. Date library to use
                                                                            joda
                                                                            Joda (for legacy app)
                                                                            java8
                                                                            Java 8 native JSR310 (preferred for JDK 1.8+)
                                                                            		java8
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            modelPackagepackage for generated modelsnull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFoldersource folder for generated codenull

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            ArrayBufferscala.collection.mutable.ArrayBuffer
                                                                            Datejava.util.Date
                                                                            Filejava.io.File
                                                                            HashMapscala.collection.immutable.HashMap
                                                                            Instantjava.time.Instant
                                                                            Jsonio.circe.Json
                                                                            LocalDatejava.time.LocalDate
                                                                            LocalDateTimejava.time.LocalDateTime
                                                                            LocalTimejava.time.LocalTime
                                                                            Mapscala.collection.immutable.Map
                                                                            OffsetDateTimejava.time.OffsetDateTime
                                                                            Seqscala.collection.immutable.Seq
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID
                                                                            ZonedDateTimejava.time.ZonedDateTime

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arraySeq
                                                                            listList
                                                                            mapMap
                                                                            seqSeq
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • AnyRef
                                                                            • AnyVal
                                                                            • BigDecimal
                                                                            • Boolean
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • Integer
                                                                            • Long
                                                                            • Object
                                                                            • String

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • assert
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • const
                                                                            • continue
                                                                            • def
                                                                            • default
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • forsome
                                                                            • goto
                                                                            • if
                                                                            • implements
                                                                            • implicit
                                                                            • import
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • lazy
                                                                            • long
                                                                            • match
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • override
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • return
                                                                            • sealed
                                                                            • short
                                                                            • static
                                                                            • strictfp
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • throws
                                                                            • trait
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • val
                                                                            • var
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✗ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✗OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scala-lagom-server/index.html b/docs/generators/scala-lagom-server/index.html index eece2967b69..964c2c4578e 100644 --- a/docs/generators/scala-lagom-server/index.html +++ b/docs/generators/scala-lagom-server/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scala-lagom-server Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescala-lagom-serverpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeSERVER
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Lagom API server (Beta) in scala

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiPackagepackage for generated api classesnull
                                                                            dateLibraryOption. Date library to use
                                                                            joda
                                                                            Joda (for legacy app)
                                                                            java8
                                                                            Java 8 native JSR310 (preferred for JDK 1.8+)
                                                                            		java8
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            modelPackagepackage for generated modelsnull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFoldersource folder for generated codenull

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            Arrayjava.util.List
                                                                            ArrayListjava.util.ArrayList
                                                                            Datejava.util.Date
                                                                            DateTimeorg.joda.time.DateTime
                                                                            Filejava.io.File
                                                                            HashMapjava.util.HashMap
                                                                            ListBufferscala.collection.mutable.ListBuffer
                                                                            ListSetscala.collection.immutable.ListSet
                                                                            LocalDateorg.joda.time.*
                                                                            LocalDateTimeorg.joda.time.*
                                                                            LocalTimeorg.joda.time.*
                                                                            Seqscala.collection.immutable.Seq
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayListBuffer
                                                                            mapHashMap
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • Array
                                                                            • Boolean
                                                                            • Byte
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • List
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • Seq
                                                                            • String
                                                                            • boolean

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • apiinvoker
                                                                            • basepath
                                                                            • case
                                                                            • catch
                                                                            • class
                                                                            • contenttype
                                                                            • contenttypes
                                                                            • def
                                                                            • do
                                                                            • else
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • for
                                                                            • formparams
                                                                            • forsome
                                                                            • headerparams
                                                                            • if
                                                                            • implicit
                                                                            • import
                                                                            • lazy
                                                                            • match
                                                                            • mp
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • override
                                                                            • package
                                                                            • path
                                                                            • postbody
                                                                            • private
                                                                            • protected
                                                                            • queryparams
                                                                            • return
                                                                            • sealed
                                                                            • super
                                                                            • this
                                                                            • throw
                                                                            • trait
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • val
                                                                            • var
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✗OAS2,OAS3
                                                                            ApiKey✗OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scala-pekko/index.html b/docs/generators/scala-pekko/index.html index d203b305886..42ce353d7e2 100644 --- a/docs/generators/scala-pekko/index.html +++ b/docs/generators/scala-pekko/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scala-pekko Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescala-pekkopass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Scala client library (beta) base on pekko/Spray.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiPackagepackage for generated api classesnull
                                                                            dateLibraryOption. Date library to use
                                                                            joda
                                                                            Joda (for legacy app)
                                                                            java8
                                                                            Java 8 native JSR310 (preferred for JDK 1.8+)
                                                                            		java8
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            mainPackageTop-level package name, which defines 'apiPackage', 'modelPackage', 'invokerPackage'org.openapitools.client
                                                                            modelPackagepackage for generated modelsnull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFoldersource folder for generated codenull

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            Arrayjava.util.List
                                                                            ArrayListjava.util.ArrayList
                                                                            BigDecimaljava.math.BigDecimal
                                                                            Datejava.util.Date
                                                                            DateTimeorg.joda.time.*
                                                                            Filejava.io.File
                                                                            HashMapjava.util.HashMap
                                                                            ListBufferscala.collection.mutable.ListBuffer
                                                                            ListSetscala.collection.immutable.ListSet
                                                                            LocalDateorg.joda.time.*
                                                                            LocalDateTimeorg.joda.time.*
                                                                            LocalTimeorg.joda.time.*
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayListBuffer
                                                                            mapMap
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • Array
                                                                            • Boolean
                                                                            • Byte
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • List
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • Seq
                                                                            • String
                                                                            • boolean

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • case
                                                                            • catch
                                                                            • class
                                                                            • def
                                                                            • do
                                                                            • else
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • for
                                                                            • forsome
                                                                            • if
                                                                            • implicit
                                                                            • import
                                                                            • lazy
                                                                            • match
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • override
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • return
                                                                            • sealed
                                                                            • super
                                                                            • this
                                                                            • throw
                                                                            • trait
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • val
                                                                            • var
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✓ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scala-play-server/index.html b/docs/generators/scala-play-server/index.html index d0f863c6e5d..66201da2ced 100644 --- a/docs/generators/scala-play-server/index.html +++ b/docs/generators/scala-play-server/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scala-play-server Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescala-play-serverpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeSERVER
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Scala server application (beta) with Play Framework.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiPackagepackage for generated api classesnull
                                                                            basePackageBase package in which supporting classes are generated.org.openapitools
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            generateCustomExceptionsIf set, generates custom exception types.true
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            modelPackagepackage for generated modelsnull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            routesFileNameName of the routes file to generate.routes
                                                                            skipStubsIf set, skips generation of stub classes.false
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFoldersource folder for generated codenull
                                                                            supportAsyncIf set, wraps API return types with Futures and generates async actions.false
                                                                            useSwaggerUIAdd a route to /api which show your documentation in swagger-ui. Will also import needed dependenciestrue

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            Arrayjava.util.List
                                                                            ArrayListjava.util.ArrayList
                                                                            Datejava.util.Date
                                                                            DateTimeorg.joda.time.*
                                                                            Filejava.io.File
                                                                            HashMapjava.util.HashMap
                                                                            ListBufferscala.collection.mutable.ListBuffer
                                                                            ListSetscala.collection.immutable.ListSet
                                                                            LocalDatejava.time.LocalDate
                                                                            LocalDateTimeorg.joda.time.*
                                                                            LocalTimeorg.joda.time.*
                                                                            OffsetDateTimejava.time.OffsetDateTime
                                                                            Seqscala.collection.immutable.Seq
                                                                            Setscala.collection.immutable.Set
                                                                            TemporaryFileplay.api.libs.Files.TemporaryFile
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayList
                                                                            mapMap
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • Array
                                                                            • Boolean
                                                                            • Byte
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • List
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • Seq
                                                                            • String
                                                                            • boolean

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • case
                                                                            • catch
                                                                            • class
                                                                            • clone
                                                                            • def
                                                                            • do
                                                                            • else
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • for
                                                                            • forSome
                                                                            • if
                                                                            • implicit
                                                                            • import
                                                                            • lazy
                                                                            • match
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • override
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • return
                                                                            • sealed
                                                                            • super
                                                                            • this
                                                                            • throw
                                                                            • trait
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • val
                                                                            • var
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✗OAS2,OAS3
                                                                            ApiKey✗OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scala-sttp/index.html b/docs/generators/scala-sttp/index.html index 6303b3f22c3..76c79f7309e 100644 --- a/docs/generators/scala-sttp/index.html +++ b/docs/generators/scala-sttp/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scala-sttp Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescala-sttppass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Scala client library based on Sttp.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiPackagepackage for generated api classesnull
                                                                            dateLibraryOption. Date library to use
                                                                            joda
                                                                            Joda (for legacy app)
                                                                            java8
                                                                            Java 8 native JSR310 (preferred for JDK 1.8+)
                                                                            		java8
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            jodaTimeVersionThe version of joda-time library2.10.13
                                                                            json4sVersionThe version of json4s library3.6.11
                                                                            jsonLibraryJson library to use. Possible values are: json4s and circe.json4s
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            mainPackageTop-level package name, which defines 'apiPackage', 'modelPackage', 'invokerPackage'org.openapitools.client
                                                                            modelPackagepackage for generated modelsnull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            separateErrorChannelWhether to return response as F[Either[ResponseError[ErrorType], ReturnType]]] or to flatten response's error raising them through enclosing monad (F[ReturnType]).true
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFoldersource folder for generated codenull
                                                                            sttpClientVersionThe version of sttp client3.3.18

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            Arrayjava.util.List
                                                                            ArrayListjava.util.ArrayList
                                                                            Datejava.util.Date
                                                                            DateTimeorg.joda.time.*
                                                                            Filejava.io.File
                                                                            HashMapjava.util.HashMap
                                                                            ListBufferscala.collection.mutable.ListBuffer
                                                                            ListSetscala.collection.immutable.ListSet
                                                                            LocalDateorg.joda.time.*
                                                                            LocalDateTimeorg.joda.time.*
                                                                            LocalTimeorg.joda.time.*
                                                                            Seqscala.collection.immutable.Seq
                                                                            Setscala.collection.immutable.Set
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayListBuffer
                                                                            mapMap
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • Array
                                                                            • Boolean
                                                                            • Byte
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • List
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • Seq
                                                                            • String
                                                                            • boolean

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • case
                                                                            • catch
                                                                            • class
                                                                            • clone
                                                                            • def
                                                                            • do
                                                                            • else
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • for
                                                                            • forSome
                                                                            • if
                                                                            • implicit
                                                                            • import
                                                                            • lazy
                                                                            • match
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • override
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • return
                                                                            • sealed
                                                                            • super
                                                                            • this
                                                                            • throw
                                                                            • trait
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • val
                                                                            • var
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✓ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scala-sttp4/index.html b/docs/generators/scala-sttp4/index.html index 2916331ef59..833f3a595fc 100644 --- a/docs/generators/scala-sttp4/index.html +++ b/docs/generators/scala-sttp4/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scala-sttp4 Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescala-sttp4pass this to the generate command after -g
                                                                            generator stabilityBETA
                                                                            generator typeCLIENT
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Scala client library (beta) based on Sttp4.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiPackagepackage for generated api classesnull
                                                                            dateLibraryOption. Date library to use
                                                                            joda
                                                                            Joda (for legacy app)
                                                                            java8
                                                                            Java 8 native JSR310 (preferred for JDK 1.8+)
                                                                            		java8
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            jodaTimeVersionThe version of joda-time library2.10.13
                                                                            json4sVersionThe version of json4s library4.0.6
                                                                            jsonLibraryJson library to use. Possible values are: json4s and circe.json4s
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            mainPackageTop-level package name, which defines 'apiPackage', 'modelPackage', 'invokerPackage'org.openapitools.client
                                                                            modelPackagepackage for generated modelsnull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            separateErrorChannelWhether to return response as F[Either[ResponseError[ErrorType], ReturnType]]] or to flatten response's error raising them through enclosing monad (F[ReturnType]).true
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFoldersource folder for generated codenull
                                                                            sttpClientVersionThe version of sttp client4.0.0-M1

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            Arrayjava.util.List
                                                                            ArrayListjava.util.ArrayList
                                                                            Datejava.util.Date
                                                                            DateTimeorg.joda.time.*
                                                                            Filejava.io.File
                                                                            HashMapjava.util.HashMap
                                                                            ListBufferscala.collection.mutable.ListBuffer
                                                                            ListSetscala.collection.immutable.ListSet
                                                                            LocalDateorg.joda.time.*
                                                                            LocalDateTimeorg.joda.time.*
                                                                            LocalTimeorg.joda.time.*
                                                                            Seqscala.collection.immutable.Seq
                                                                            Setscala.collection.immutable.Set
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayListBuffer
                                                                            mapMap
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • Array
                                                                            • Boolean
                                                                            • Byte
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • List
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • Seq
                                                                            • String
                                                                            • boolean

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • case
                                                                            • catch
                                                                            • class
                                                                            • clone
                                                                            • def
                                                                            • do
                                                                            • else
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • for
                                                                            • forSome
                                                                            • if
                                                                            • implicit
                                                                            • import
                                                                            • lazy
                                                                            • match
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • override
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • return
                                                                            • sealed
                                                                            • super
                                                                            • this
                                                                            • throw
                                                                            • trait
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • val
                                                                            • var
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✓ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scalatra/index.html b/docs/generators/scalatra/index.html index 04bbc9d0b15..b0be9174090 100644 --- a/docs/generators/scalatra/index.html +++ b/docs/generators/scalatra/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scalatra Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescalatrapass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeSERVER
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Scala server application with Scalatra.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiPackagepackage for generated api classesnull
                                                                            dateLibraryOption. Date library to use
                                                                            joda
                                                                            Joda (for legacy app)
                                                                            java8
                                                                            Java 8 native JSR310 (preferred for JDK 1.8+)
                                                                            		java8
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            modelPackagepackage for generated modelsnull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFoldersource folder for generated codenull

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            Arrayjava.util.List
                                                                            ArrayListjava.util.ArrayList
                                                                            Datejava.util.Date
                                                                            DateTimeorg.joda.time.DateTime
                                                                            Filejava.io.File
                                                                            HashMapjava.util.HashMap
                                                                            ListBufferscala.collection.mutable.ListBuffer
                                                                            ListSetscala.collection.immutable.ListSet
                                                                            LocalDateorg.joda.time.LocalDate
                                                                            LocalDateTimeorg.joda.time.LocalDateTime
                                                                            LocalTimeorg.joda.time.LocalTime
                                                                            Mapjava.util.Map
                                                                            Setscala.collection.immutable.Set
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayList
                                                                            mapHashMap
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • Array
                                                                            • Boolean
                                                                            • Byte
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • List
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • Seq
                                                                            • String
                                                                            • boolean

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • case
                                                                            • catch
                                                                            • class
                                                                            • clone
                                                                            • def
                                                                            • do
                                                                            • else
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • for
                                                                            • forSome
                                                                            • if
                                                                            • implicit
                                                                            • import
                                                                            • lazy
                                                                            • match
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • override
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • return
                                                                            • sealed
                                                                            • super
                                                                            • this
                                                                            • throw
                                                                            • trait
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • val
                                                                            • var
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✗OAS2,OAS3
                                                                            ApiKey✗OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/scalaz/index.html b/docs/generators/scalaz/index.html index 5a4a053026f..05e5a0180da 100644 --- a/docs/generators/scalaz/index.html +++ b/docs/generators/scalaz/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the scalaz Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namescalazpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageScala
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Scalaz client library (beta) that uses http4s

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiPackagepackage for generated api classesnull
                                                                            dateLibraryOption. Date library to use
                                                                            joda
                                                                            Joda (for legacy app)
                                                                            java8
                                                                            Java 8 native JSR310 (preferred for JDK 1.8+)
                                                                            		java8
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            modelPackagepackage for generated modelsnull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFoldersource folder for generated codenull

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            Arrayjava.util.List
                                                                            ArrayListjava.util.ArrayList
                                                                            Datejava.util.Date
                                                                            DateTimeorg.joda.time.DateTime
                                                                            Filejava.io.File
                                                                            HashMapjava.util.HashMap
                                                                            ListBufferscala.collection.mutable.ListBuffer
                                                                            ListSetscala.collection.immutable.ListSet
                                                                            LocalDateorg.joda.time.LocalDate
                                                                            LocalDateTimeorg.joda.time.LocalDateTime
                                                                            LocalTimeorg.joda.time.LocalTime
                                                                            Seqscala.collection.immutable.Seq
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayListBuffer
                                                                            mapHashMap
                                                                            setSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • Array
                                                                            • Boolean
                                                                            • Byte
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • List
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • Seq
                                                                            • String
                                                                            • boolean

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • apiinvoker
                                                                            • basepath
                                                                            • case
                                                                            • catch
                                                                            • class
                                                                            • contenttype
                                                                            • contenttypes
                                                                            • def
                                                                            • do
                                                                            • else
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • for
                                                                            • formparams
                                                                            • forsome
                                                                            • headerparams
                                                                            • if
                                                                            • implicit
                                                                            • import
                                                                            • lazy
                                                                            • match
                                                                            • mp
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • override
                                                                            • package
                                                                            • path
                                                                            • postbody
                                                                            • private
                                                                            • protected
                                                                            • queryparams
                                                                            • return
                                                                            • sealed
                                                                            • super
                                                                            • this
                                                                            • throw
                                                                            • trait
                                                                            • true
                                                                            • try
                                                                            • type
                                                                            • val
                                                                            • var
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✗ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✗OAS2,OAS3
                                                                            ApiKey✗OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✗OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/spring/index.html b/docs/generators/spring/index.html index ce41cda5219..1078d359abb 100644 --- a/docs/generators/spring/index.html +++ b/docs/generators/spring/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the spring Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namespringpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeSERVER
                                                                            generator languageJava
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Java SpringBoot Server application using the SpringDoc integration.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            additionalEnumTypeAnnotationsAdditional annotations for enum type(class level annotations)null
                                                                            additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                                                            additionalOneOfTypeAnnotationsAdditional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)null
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            annotationLibrarySelect the complementary documentation annotation library.
                                                                            none
                                                                            Do not annotate Model and Api with complementary annotations.
                                                                            swagger1
                                                                            Annotate Model and Api using the Swagger Annotations 1.x library.
                                                                            swagger2
                                                                            Annotate Model and Api using the Swagger Annotations 2.x library.
                                                                            		swagger2
                                                                            apiFirstGenerate the API from the OAI spec at server compile time (API first approach)false
                                                                            apiPackagepackage for generated api classesorg.openapitools.api
                                                                            artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                            artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-spring
                                                                            artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                            artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.1.0.0
                                                                            asyncuse async Callable controllersfalse
                                                                            basePackagebase package (invokerPackage) for generated codeorg.openapitools
                                                                            bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                            booleanGetterPrefixSet booleanGetterPrefixget
                                                                            camelCaseDollarSignFix camelCase when starting with $ sign. when true : $Value when false : $valuefalse
                                                                            configPackageconfiguration package for generated codeorg.openapitools.configuration
                                                                            containerDefaultToNullSet containers (array, set, map) default to nullfalse
                                                                            dateLibraryOption. Date library to use
                                                                            joda
                                                                            Joda (for legacy app only)
                                                                            legacy
                                                                            Legacy java.util.Date
                                                                            java8-localdatetime
                                                                            Java 8 using LocalDateTime (for legacy app only)
                                                                            java8
                                                                            Java 8 native JSR310 (preferred for jdk 1.8+)
                                                                            		java8
                                                                            delegatePatternWhether to generate the server files using the delegate patternfalse
                                                                            developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                            developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                            developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                            developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                            disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            discriminatorCaseSensitiveWhether the discriminator value lookup should be case-sensitive or not. This option only works for Java API clienttrue
                                                                            documentationProviderSelect the OpenAPI documentation provider.
                                                                            none
                                                                            Do not publish an OpenAPI specification.
                                                                            source
                                                                            Publish the original input OpenAPI specification.
                                                                            springfox
                                                                            Generate an OpenAPI 2 (fka Swagger RESTful API Documentation Specification) specification using SpringFox 2.x. Deprecated (for removal); use springdoc instead.
                                                                            springdoc
                                                                            Generate an OpenAPI 3 specification using SpringDoc.
                                                                            		springdoc
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            generateBuildersWhether to generate builders for modelsfalse
                                                                            generateConstructorWithAllArgswhether to generate a constructor for all argumentsfalse
                                                                            generatedConstructorWithRequiredArgsWhether to generate constructors with required args for modelstrue
                                                                            groupIdgroupId in generated pom.xmlorg.openapitools
                                                                            hateoasUse Spring HATEOAS library to allow adding HATEOAS linksfalse
                                                                            hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                            ignoreAnyOfInEnumIgnore anyOf keyword in enumfalse
                                                                            implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                                                            implicitHeadersRegexSkip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=truenull
                                                                            interfaceOnlyWhether to generate only API interface stubs without the server files.false
                                                                            invokerPackageroot package for generated codeorg.openapitools.api
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            librarylibrary template (sub-template)
                                                                            spring-boot
                                                                            Spring-boot Server application.
                                                                            spring-cloud
                                                                            Spring-Cloud-Feign client with Spring-Boot auto-configured settings.
                                                                            spring-http-interface
                                                                            Spring 6 HTTP interfaces (testing)
                                                                            		spring-boot
                                                                            licenseNameThe name of the licenseUnlicense
                                                                            licenseUrlThe URL of the licensehttp://unlicense.org
                                                                            modelPackagepackage for generated modelsorg.openapitools.model
                                                                            openApiNullableEnable OpenAPI Jackson Nullable librarytrue
                                                                            parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                            parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                            parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                            performBeanValidationUse Bean Validation Impl. to perform BeanValidationfalse
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            reactivewrap responses in Mono/Flux Reactor types (spring-boot only)false
                                                                            requestMappingModeWhere to generate the class level @RequestMapping annotation.
                                                                            api_interface
                                                                            Generate the @RequestMapping annotation on the generated Api Interface.
                                                                            controller
                                                                            Generate the @RequestMapping annotation on the generated Api Controller Implementation.
                                                                            none
                                                                            Do not add a class level @RequestMapping annotation.
                                                                            		controller
                                                                            resourceFolderresource folder for generated resourcessrc/main/resources
                                                                            responseWrapperwrap the responses in given type (Future, Callable, CompletableFuture,ListenableFuture, DeferredResult, RxObservable, RxSingle or fully qualified type)null
                                                                            returnSuccessCodeGenerated server returns 2xx codefalse
                                                                            scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                            scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                            scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                            serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                            singleContentTypesWhether to select only one produces/consumes content-type by operation.false
                                                                            skipDefaultInterfaceWhether to skip generation of default implementations for java8 interfacesfalse
                                                                            snapshotVersionUses a SNAPSHOT version.
                                                                            true
                                                                            Use a SnapShot Version
                                                                            false
                                                                            Use a Release Version
                                                                            		null
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            sourceFoldersource folder for generated codesrc/main/java
                                                                            testOutputSet output folder for models and APIs tests${project.build.directory}/generated-test-sources/openapi
                                                                            titleserver title name or client service nameOpenAPI Spring
                                                                            unhandledExceptionDeclare operation methods to throw a generic exception and allow unhandled exceptions (useful for Spring @ControllerAdvice directives).false
                                                                            useBeanValidationUse BeanValidation API annotationstrue
                                                                            useEnumCaseInsensitiveUse equalsIgnoreCase when String for enum comparisonfalse
                                                                            useFeignClientUrlWhether to generate Feign client with url parameter.true
                                                                            useJakartaEewhether to use Jakarta EE namespace instead of javaxfalse
                                                                            useOneOfInterfaceswhether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interfacefalse
                                                                            useOptionalUse Optional container for optional parametersfalse
                                                                            useResponseEntityUse the ResponseEntity type to wrap return values of generated API methods. If disabled, method are annotated using a @ResponseStatus annotation, which has the status of the first response declared in the Api definitiontrue
                                                                            useSpringBoot3Generate code and provide dependencies for use with Spring Boot 3.x. (Use jakarta instead of javax in imports). Enabling this option will also enable useJakartaEe.false
                                                                            useSpringControllerAnnotate the generated API as a Spring Controllerfalse
                                                                            useSwaggerUIOpen the OpenApi specification in swagger-ui. Will also import and configure needed dependenciestrue
                                                                            useTagsuse tags for creating interface and controller classnamesfalse
                                                                            virtualServiceGenerates the virtual service. For more details refer - https://github.com/virtualansoftware/virtualan/wikifalse
                                                                            withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false

                                                                            SUPPORTED VENDOR EXTENSIONS​

                                                                            Extension nameDescriptionApplicable forDefault value
                                                                            x-discriminator-valueUsed with model inheritance to specify value for discriminator that identifies current modelMODEL
                                                                            x-implementsAbility to specify interfaces that model must implementsMODELempty array
                                                                            x-setter-extra-annotationCustom annotation that can be specified over java setter for specific fieldFIELDWhen field is array & uniqueItems, then this extension is used to add @JsonDeserialize(as = LinkedHashSet.class) over setter, otherwise no value
                                                                            x-tagsSpecify multiple swagger tags for operationOPERATIONnull
                                                                            x-acceptsSpecify custom value for 'Accept' header for operationOPERATIONnull
                                                                            x-content-typeSpecify custom value for 'Content-Type' header for operationOPERATIONnull
                                                                            x-class-extra-annotationList of custom annotations to be added to modelMODELnull
                                                                            x-field-extra-annotationList of custom annotations to be added to propertyFIELD, OPERATION_PARAMETERnull
                                                                            x-operation-extra-annotationList of custom annotations to be added to operationOPERATIONnull
                                                                            x-spring-paginatedAdd org.springframework.data.domain.Pageable to controller method. Can be used to handle page & size query parametersOPERATIONfalse
                                                                            x-version-paramMarker property that tells that this parameter would be used for endpoint versioning. Applicable for headers & query params. true/falseOPERATION_PARAMETERnull
                                                                            x-pattern-messageAdd this property whenever you need to customize the invalidation error message for the regex pattern of a variableFIELD, OPERATION_PARAMETERnull

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports
                                                                            Arrayjava.util.List
                                                                            ArrayListjava.util.ArrayList
                                                                            BigDecimaljava.math.BigDecimal
                                                                            Datejava.util.Date
                                                                            DateTimeorg.joda.time.*
                                                                            Filejava.io.File
                                                                            HashMapjava.util.HashMap
                                                                            LinkedHashSetjava.util.LinkedHashSet
                                                                            Listjava.util.*
                                                                            LocalDateorg.joda.time.*
                                                                            LocalDateTimeorg.joda.time.*
                                                                            LocalTimeorg.joda.time.*
                                                                            Mapjava.util.Map
                                                                            Setjava.util.*
                                                                            Timestampjava.sql.Timestamp
                                                                            URIjava.net.URI
                                                                            UUIDjava.util.UUID

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArrayList
                                                                            mapHashMap
                                                                            setLinkedHashSet

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Boolean
                                                                            • Double
                                                                            • Float
                                                                            • Integer
                                                                            • Long
                                                                            • Object
                                                                            • String
                                                                            • boolean
                                                                            • byte[]

                                                                            RESERVED WORDS​

                                                                            • _
                                                                            • abstract
                                                                            • apiclient
                                                                            • apiexception
                                                                            • apiresponse
                                                                            • assert
                                                                            • boolean
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • configuration
                                                                            • const
                                                                            • continue
                                                                            • default
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • extends
                                                                            • file
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • goto
                                                                            • if
                                                                            • implements
                                                                            • import
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • list
                                                                            • localdate
                                                                            • localreturntype
                                                                            • localtime
                                                                            • localvaraccept
                                                                            • localvaraccepts
                                                                            • localvarauthnames
                                                                            • localvarcollectionqueryparams
                                                                            • localvarcontenttype
                                                                            • localvarcontenttypes
                                                                            • localvarcookieparams
                                                                            • localvarformparams
                                                                            • localvarheaderparams
                                                                            • localvarpath
                                                                            • localvarpostbody
                                                                            • localvarqueryparams
                                                                            • long
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • object
                                                                            • offsetdatetime
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • return
                                                                            • short
                                                                            • static
                                                                            • strictfp
                                                                            • stringutil
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • throws
                                                                            • transient
                                                                            • try
                                                                            • void
                                                                            • volatile
                                                                            • while

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✓OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✓OAS2,OAS3
                                                                            OAuth2_ClientCredentials✓OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✓OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            Edit this page
                                                                            Last updated on by Rodrigo de Almeida - RMA3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/swift-combine/index.html b/docs/generators/swift-combine/index.html index 42502b6ec17..82608430afc 100644 --- a/docs/generators/swift-combine/index.html +++ b/docs/generators/swift-combine/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the swift-combine Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nameswift-combinepass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageSwift
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Swift Combine client library.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiNamePrefixPrefix that will be appended to all API names ('tags'). Default: empty string. e.g. Pet => Pet.null
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            mapFileBinaryToDataMap File and Binary to Data (default: true)true
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            projectNameProject name in Xcodenull
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray
                                                                            listArray

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • AnyObject
                                                                            • Bool
                                                                            • Character
                                                                            • Data
                                                                            • Date
                                                                            • Decimal
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • Int32
                                                                            • Int64
                                                                            • String
                                                                            • URL
                                                                            • UUID
                                                                            • Void
                                                                            • [String: Any]

                                                                            RESERVED WORDS​

                                                                            • #available
                                                                            • #colorLiteral
                                                                            • #column
                                                                            • #else
                                                                            • #elseif
                                                                            • #endif
                                                                            • #file
                                                                            • #fileLiteral
                                                                            • #function
                                                                            • #if
                                                                            • #imageLiteral
                                                                            • #line
                                                                            • #selector
                                                                            • #sourceLocation
                                                                            • Any
                                                                            • AnyObject
                                                                            • Array
                                                                            • Bool
                                                                            • COLUMN
                                                                            • Character
                                                                            • Class
                                                                            • ClosedRange
                                                                            • Codable
                                                                            • CountableClosedRange
                                                                            • CountableRange
                                                                            • Data
                                                                            • Decodable
                                                                            • Dictionary
                                                                            • Double
                                                                            • Encodable
                                                                            • Error
                                                                            • FILE
                                                                            • FUNCTION
                                                                            • Float
                                                                            • Float32
                                                                            • Float64
                                                                            • Float80
                                                                            • Int
                                                                            • Int16
                                                                            • Int32
                                                                            • Int64
                                                                            • Int8
                                                                            • LINE
                                                                            • OptionSet
                                                                            • Optional
                                                                            • Protocol
                                                                            • Range
                                                                            • Result
                                                                            • Self
                                                                            • Set
                                                                            • StaticString
                                                                            • String
                                                                            • Type
                                                                            • UInt
                                                                            • UInt16
                                                                            • UInt32
                                                                            • UInt64
                                                                            • UInt8
                                                                            • URL
                                                                            • Unicode
                                                                            • Void
                                                                            • _
                                                                            • as
                                                                            • associatedtype
                                                                            • associativity
                                                                            • break
                                                                            • case
                                                                            • catch
                                                                            • class
                                                                            • continue
                                                                            • convenience
                                                                            • default
                                                                            • defer
                                                                            • deinit
                                                                            • didSet
                                                                            • do
                                                                            • dynamic
                                                                            • dynamicType
                                                                            • else
                                                                            • enum
                                                                            • extension
                                                                            • fallthrough
                                                                            • false
                                                                            • fileprivate
                                                                            • final
                                                                            • for
                                                                            • func
                                                                            • get
                                                                            • guard
                                                                            • if
                                                                            • import
                                                                            • in
                                                                            • indirect
                                                                            • infix
                                                                            • init
                                                                            • inout
                                                                            • internal
                                                                            • is
                                                                            • lazy
                                                                            • left
                                                                            • let
                                                                            • mutating
                                                                            • nil
                                                                            • none
                                                                            • nonmutating
                                                                            • open
                                                                            • operator
                                                                            • optional
                                                                            • override
                                                                            • postfix
                                                                            • precedence
                                                                            • prefix
                                                                            • private
                                                                            • protocol
                                                                            • public
                                                                            • repeat
                                                                            • required
                                                                            • rethrows
                                                                            • return
                                                                            • right
                                                                            • self
                                                                            • set
                                                                            • static
                                                                            • struct
                                                                            • subscript
                                                                            • super
                                                                            • switch
                                                                            • throw
                                                                            • throws
                                                                            • true
                                                                            • try
                                                                            • typealias
                                                                            • unowned
                                                                            • var
                                                                            • weak
                                                                            • where
                                                                            • while
                                                                            • willSet

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✗ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✓OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✓OAS2,OAS3
                                                                            OAuth2_ClientCredentials✓OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✓OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/swift5/index.html b/docs/generators/swift5/index.html index 76cacb605f0..5c3e91e2184 100644 --- a/docs/generators/swift5/index.html +++ b/docs/generators/swift5/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the swift5 Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nameswift5pass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageSwift
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Swift 5.x client library.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiNamePrefixPrefix that will be appended to all API names ('tags'). Default: empty string. e.g. Pet => Pet.null
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            generateModelAdditionalPropertiesGenerate model additional properties (default: true)true
                                                                            hashableModelsMake hashable models (default: true)true
                                                                            hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            libraryLibrary template (sub-template) to use
                                                                            urlsession
                                                                            [DEFAULT] HTTP client: URLSession
                                                                            alamofire
                                                                            HTTP client: Alamofire
                                                                            vapor
                                                                            HTTP client: Vapor
                                                                            		urlsession
                                                                            mapFileBinaryToData[WARNING] This option will be removed and enabled by default in the future once we've enhanced the code to work with Data in all the different situations. Map File and Binary to Data (default: false)false
                                                                            nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.(default: false)null
                                                                            objcCompatibleAdd additional properties and methods for Objective-C compatibility (default: false)null
                                                                            oneOfUnknownDefaultCaseAdd unknownDefault case to oneOf enum (default: false)false
                                                                            podAuthorsAuthors used for Podspecnull
                                                                            podDescriptionDescription used for Podspecnull
                                                                            podDocumentationURLDocumentation URL used for Podspecnull
                                                                            podHomepageHomepage used for Podspecnull
                                                                            podLicenseLicense used for Podspecnull
                                                                            podScreenshotsScreenshots used for Podspecnull
                                                                            podSocialMediaURLSocial Media URL used for Podspecnull
                                                                            podSourceSource information used for Podspecnull
                                                                            podSummarySummary used for Podspecnull
                                                                            podVersionVersion used for Podspecnull
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            projectNameProject name in Xcodenull
                                                                            readonlyPropertiesMake properties readonly (default: false)null
                                                                            responseAsOptionally use libraries to manage response. Currently PromiseKit, RxSwift, Result, Combine, AsyncAwait are available.null
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            swiftPackagePathSet a custom source path instead of OpenAPIClient/Classes/OpenAPIs.null
                                                                            swiftUseApiNamespaceFlag to make all the API classes inner-class of {{projectName}}APInull
                                                                            useBacktickEscapesEscape reserved words using backticks (default: false)false
                                                                            useClassesUse final classes for models instead of structs (default: false)false
                                                                            useCustomDateWithoutTimeUses a custom type to decode and encode dates without time information to support OpenAPIs date format (default: false)false
                                                                            useJsonEncodableMake models conform to JSONEncodable protocol (default: true)true
                                                                            useSPMFileStructureUse SPM file structure and set the source path to Sources/{{projectName}} (default: false).null
                                                                            validatableMake validation rules and validator for model properies (default: true)true

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • AnyCodable
                                                                            • AnyObject
                                                                            • Bool
                                                                            • Character
                                                                            • Data
                                                                            • Date
                                                                            • Decimal
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • Int32
                                                                            • Int64
                                                                            • OpenAPIDateWithoutTime
                                                                            • String
                                                                            • URL
                                                                            • UUID
                                                                            • Void

                                                                            RESERVED WORDS​

                                                                            • #available
                                                                            • #colorLiteral
                                                                            • #column
                                                                            • #else
                                                                            • #elseif
                                                                            • #endif
                                                                            • #file
                                                                            • #fileLiteral
                                                                            • #function
                                                                            • #if
                                                                            • #imageLiteral
                                                                            • #line
                                                                            • #selector
                                                                            • #sourceLocation
                                                                            • Any
                                                                            • AnyObject
                                                                            • Array
                                                                            • Bool
                                                                            • COLUMN
                                                                            • Character
                                                                            • Class
                                                                            • ClosedRange
                                                                            • Codable
                                                                            • CountableClosedRange
                                                                            • CountableRange
                                                                            • Data
                                                                            • Decodable
                                                                            • Dictionary
                                                                            • Double
                                                                            • Encodable
                                                                            • Error
                                                                            • ErrorResponse
                                                                            • FILE
                                                                            • FUNCTION
                                                                            • Float
                                                                            • Float32
                                                                            • Float64
                                                                            • Float80
                                                                            • Int
                                                                            • Int16
                                                                            • Int32
                                                                            • Int64
                                                                            • Int8
                                                                            • LINE
                                                                            • OptionSet
                                                                            • Optional
                                                                            • Protocol
                                                                            • Range
                                                                            • Response
                                                                            • Self
                                                                            • Set
                                                                            • StaticString
                                                                            • String
                                                                            • Type
                                                                            • UInt
                                                                            • UInt16
                                                                            • UInt32
                                                                            • UInt64
                                                                            • UInt8
                                                                            • URL
                                                                            • Unicode
                                                                            • Void
                                                                            • _
                                                                            • as
                                                                            • associatedtype
                                                                            • associativity
                                                                            • break
                                                                            • case
                                                                            • catch
                                                                            • class
                                                                            • continue
                                                                            • convenience
                                                                            • default
                                                                            • defer
                                                                            • deinit
                                                                            • didSet
                                                                            • do
                                                                            • dynamic
                                                                            • dynamicType
                                                                            • else
                                                                            • enum
                                                                            • extension
                                                                            • fallthrough
                                                                            • false
                                                                            • fileprivate
                                                                            • final
                                                                            • for
                                                                            • func
                                                                            • get
                                                                            • guard
                                                                            • if
                                                                            • import
                                                                            • in
                                                                            • indirect
                                                                            • infix
                                                                            • init
                                                                            • inout
                                                                            • internal
                                                                            • is
                                                                            • lazy
                                                                            • left
                                                                            • let
                                                                            • mutating
                                                                            • nil
                                                                            • none
                                                                            • nonmutating
                                                                            • open
                                                                            • operator
                                                                            • optional
                                                                            • override
                                                                            • postfix
                                                                            • precedence
                                                                            • prefix
                                                                            • private
                                                                            • protocol
                                                                            • public
                                                                            • repeat
                                                                            • required
                                                                            • rethrows
                                                                            • return
                                                                            • right
                                                                            • self
                                                                            • set
                                                                            • static
                                                                            • struct
                                                                            • subscript
                                                                            • super
                                                                            • switch
                                                                            • throw
                                                                            • throws
                                                                            • true
                                                                            • try
                                                                            • typealias
                                                                            • unowned
                                                                            • var
                                                                            • weak
                                                                            • where
                                                                            • while
                                                                            • willSet

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✗ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✓OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✓OAS2,OAS3
                                                                            OAuth2_ClientCredentials✓OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✓OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/swift6/index.html b/docs/generators/swift6/index.html index 68401f95dfb..1d812982d1e 100644 --- a/docs/generators/swift6/index.html +++ b/docs/generators/swift6/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the swift6 Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nameswift6pass this to the generate command after -g
                                                                            generator stabilityBETA
                                                                            generator typeCLIENT
                                                                            generator languageSwift
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a Swift 6.x client library.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiNamePrefixPrefix that will be appended to all API names ('tags'). Default: empty string. e.g. Pet => Pet.null
                                                                            apiStaticMethodMake api calls using a static method (default: true)true
                                                                            combineDeferredMake combine usages deferred (default: true)true
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            generateModelAdditionalPropertiesGenerate model additional properties (default: true)true
                                                                            hashableModelsMake hashable models (default: true)true
                                                                            hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            libraryLibrary template (sub-template) to use
                                                                            urlsession
                                                                            [DEFAULT] HTTP client: URLSession
                                                                            alamofire
                                                                            HTTP client: Alamofire
                                                                            vapor
                                                                            HTTP client: Vapor
                                                                            		urlsession
                                                                            mapFileBinaryToDataMap File and Binary to Data (default: false)false
                                                                            nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.(default: false)null
                                                                            objcCompatibleAdd additional properties and methods for Objective-C compatibility (default: false)null
                                                                            oneOfUnknownDefaultCaseAdd unknownDefault case to oneOf enum (default: false)false
                                                                            podAuthorsAuthors used for Podspecnull
                                                                            podDescriptionDescription used for Podspecnull
                                                                            podDocumentationURLDocumentation URL used for Podspecnull
                                                                            podHomepageHomepage used for Podspecnull
                                                                            podLicenseLicense used for Podspecnull
                                                                            podScreenshotsScreenshots used for Podspecnull
                                                                            podSocialMediaURLSocial Media URL used for Podspecnull
                                                                            podSourceSource information used for Podspecnull
                                                                            podSummarySummary used for Podspecnull
                                                                            podVersionVersion used for Podspecnull
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            projectNameProject name in Xcodenull
                                                                            readonlyPropertiesMake properties readonly (default: false)null
                                                                            responseAsOptionally use libraries to manage response. Currently AsyncAwait, Combine, Result, RxSwift, ObjcBlock, PromiseKit are available.null
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            swiftPackagePathSet a custom source path instead of Sources/{{projectName}}.null
                                                                            swiftUseApiNamespaceFlag to make all the API classes inner-class of {{projectName}}APInull
                                                                            useBacktickEscapesEscape reserved words using backticks (default: false)false
                                                                            useClassesUse final classes for models instead of structs (default: false)false
                                                                            useCustomDateWithoutTimeUses a custom type to decode and encode dates without time information to support OpenAPIs date format (default: false)false
                                                                            useJsonEncodableMake models conform to JSONEncodable protocol (default: true)true
                                                                            useSPMFileStructureUse SPM file structure and set the source path to Sources/{{projectName}} (default: true).null
                                                                            validatableMake validation rules and validator for model properies (default: true)true

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Any
                                                                            • AnyObject
                                                                            • Bool
                                                                            • Character
                                                                            • Data
                                                                            • Date
                                                                            • Decimal
                                                                            • Double
                                                                            • Float
                                                                            • Int
                                                                            • Int32
                                                                            • Int64
                                                                            • JSONValue
                                                                            • OpenAPIDateWithoutTime
                                                                            • String
                                                                            • URL
                                                                            • UUID
                                                                            • Void

                                                                            RESERVED WORDS​

                                                                            • #available
                                                                            • #colorLiteral
                                                                            • #column
                                                                            • #else
                                                                            • #elseif
                                                                            • #endif
                                                                            • #file
                                                                            • #fileLiteral
                                                                            • #function
                                                                            • #if
                                                                            • #imageLiteral
                                                                            • #line
                                                                            • #selector
                                                                            • #sourceLocation
                                                                            • Any
                                                                            • AnyObject
                                                                            • Array
                                                                            • Bool
                                                                            • COLUMN
                                                                            • Character
                                                                            • Class
                                                                            • ClosedRange
                                                                            • Codable
                                                                            • CountableClosedRange
                                                                            • CountableRange
                                                                            • Data
                                                                            • Decodable
                                                                            • Dictionary
                                                                            • Double
                                                                            • Encodable
                                                                            • Error
                                                                            • ErrorResponse
                                                                            • FILE
                                                                            • FUNCTION
                                                                            • Float
                                                                            • Float32
                                                                            • Float64
                                                                            • Float80
                                                                            • Int
                                                                            • Int16
                                                                            • Int32
                                                                            • Int64
                                                                            • Int8
                                                                            • LINE
                                                                            • OptionSet
                                                                            • Optional
                                                                            • Protocol
                                                                            • Range
                                                                            • Response
                                                                            • Self
                                                                            • Set
                                                                            • StaticString
                                                                            • String
                                                                            • Type
                                                                            • UInt
                                                                            • UInt16
                                                                            • UInt32
                                                                            • UInt64
                                                                            • UInt8
                                                                            • URL
                                                                            • Unicode
                                                                            • Void
                                                                            • _
                                                                            • as
                                                                            • associatedtype
                                                                            • associativity
                                                                            • break
                                                                            • case
                                                                            • catch
                                                                            • class
                                                                            • continue
                                                                            • convenience
                                                                            • default
                                                                            • defer
                                                                            • deinit
                                                                            • didSet
                                                                            • do
                                                                            • dynamic
                                                                            • dynamicType
                                                                            • else
                                                                            • enum
                                                                            • extension
                                                                            • fallthrough
                                                                            • false
                                                                            • fileprivate
                                                                            • final
                                                                            • for
                                                                            • func
                                                                            • get
                                                                            • guard
                                                                            • if
                                                                            • import
                                                                            • in
                                                                            • indirect
                                                                            • infix
                                                                            • init
                                                                            • inout
                                                                            • internal
                                                                            • is
                                                                            • lazy
                                                                            • left
                                                                            • let
                                                                            • mutating
                                                                            • nil
                                                                            • none
                                                                            • nonmutating
                                                                            • open
                                                                            • operator
                                                                            • optional
                                                                            • override
                                                                            • postfix
                                                                            • precedence
                                                                            • prefix
                                                                            • private
                                                                            • protocol
                                                                            • public
                                                                            • repeat
                                                                            • required
                                                                            • rethrows
                                                                            • return
                                                                            • right
                                                                            • self
                                                                            • set
                                                                            • static
                                                                            • struct
                                                                            • subscript
                                                                            • super
                                                                            • switch
                                                                            • throw
                                                                            • throws
                                                                            • true
                                                                            • try
                                                                            • typealias
                                                                            • unowned
                                                                            • var
                                                                            • weak
                                                                            • where
                                                                            • while
                                                                            • willSet

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✗ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✓OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✓OAS2,OAS3
                                                                            OAuth2_ClientCredentials✓OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✓OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/tiny-cpp/index.html b/docs/generators/tiny-cpp/index.html index c9dfa294acf..45a06a83835 100644 --- a/docs/generators/tiny-cpp/index.html +++ b/docs/generators/tiny-cpp/index.html @@ -15,13 +15,13 @@ - +

                                                                            Config Options for tiny-cpp

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            controllername of microcontroller (e.g esp32 or esp8266)esp32
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C#have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            reservedWordPrefixPrefix to prepend to reserved words in order to avoid conflictsr_
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            variableNameFirstCharacterUppercaseMake first character of variable name uppercase (eg. value -> Value)true

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By

                                                                            LANGUAGE PRIMITIVES​

                                                                            • bool
                                                                            • double
                                                                            • float
                                                                            • int
                                                                            • long
                                                                            • std::string

                                                                            RESERVED WORDS​

                                                                            • alignas
                                                                            • alignof
                                                                            • and
                                                                            • and_eq
                                                                            • asm
                                                                            • auto
                                                                            • bitand
                                                                            • bitor
                                                                            • bool
                                                                            • break
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • char16_t
                                                                            • char32_t
                                                                            • class
                                                                            • compl
                                                                            • concept
                                                                            • const
                                                                            • const_cast
                                                                            • constexpr
                                                                            • continue
                                                                            • decltype
                                                                            • default
                                                                            • delete
                                                                            • do
                                                                            • double
                                                                            • dynamic_cast
                                                                            • else
                                                                            • enum
                                                                            • explicit
                                                                            • export
                                                                            • extern
                                                                            • false
                                                                            • float
                                                                            • for
                                                                            • friend
                                                                            • goto
                                                                            • if
                                                                            • inline
                                                                            • int
                                                                            • linux
                                                                            • long
                                                                            • mutable
                                                                            • namespace
                                                                            • new
                                                                            • noexcept
                                                                            • not
                                                                            • not_eq
                                                                            • nullptr
                                                                            • operator
                                                                            • or
                                                                            • or_eq
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • register
                                                                            • reinterpret_cast
                                                                            • requires
                                                                            • return
                                                                            • short
                                                                            • signed
                                                                            • sizeof
                                                                            • static
                                                                            • static_assert
                                                                            • static_cast
                                                                            • struct
                                                                            • switch
                                                                            • template
                                                                            • this
                                                                            • thread_local
                                                                            • throw
                                                                            • true
                                                                            • try
                                                                            • typedef
                                                                            • typeid
                                                                            • typename
                                                                            • union
                                                                            • unsigned
                                                                            • using
                                                                            • virtual
                                                                            • void
                                                                            • volatile
                                                                            • wchar_t
                                                                            • while
                                                                            • xor
                                                                            • xor_eq

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Array✓OAS2,OAS3
                                                                            Maps✗ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✗OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✗ToolingExtension
                                                                            MapOfModel✗ToolingExtension
                                                                            MapOfCollectionOfPrimitives✗ToolingExtension
                                                                            MapOfCollectionOfModel✗ToolingExtension
                                                                            MapOfCollectionOfEnum✗ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✗OAS2,OAS3
                                                                            Header✗OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✗OAS2
                                                                            FormMultipart✗OAS2
                                                                            Cookie✗OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✗OAS2,OAS3
                                                                            Union✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✓OAS2,OAS3
                                                                            OAuth2_ClientCredentials✓OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✓OAS2,OAS3
                                                                            SignatureAuth✗OAS3

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✗OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            - + \ No newline at end of file diff --git a/docs/generators/typescript-angular/index.html b/docs/generators/typescript-angular/index.html index df8b1d38fba..9a5a53b2552 100644 --- a/docs/generators/typescript-angular/index.html +++ b/docs/generators/typescript-angular/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the typescript-angular Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nametypescript-angularpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageTypescript
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a TypeScript Angular (9.x - 18.x) client library.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiModulePrefixThe prefix of the generated ApiModule.null
                                                                            configurationPrefixThe prefix of the generated Configuration.null
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumNameSuffixSuffix that will be appended to all enum names.Enum
                                                                            enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                            enumPropertyNamingReplaceSpecialCharSet to true to replace '-' and '+' symbols with 'minus' and 'plus' in enum of type stringfalse
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            fileNamingNaming convention for the output files: 'camelCase', 'kebab-case'.camelCase
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            licenseNameThe name of the licenseUnlicense
                                                                            modelFileSuffixThe suffix of the file of the generated model (model<suffix>.ts).null
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name. Only change it if you provide your own run-time code for (de-)serialization of modelsoriginal
                                                                            modelSuffixThe suffix of the generated model.null
                                                                            ngVersionThe version of Angular. (At least 9.0.0)18.0.0
                                                                            npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                            npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                            npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                            nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                            paramNamingNaming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            providedInUse this property to provide Injectables in wanted level.
                                                                            root
                                                                            The application-level injector in most apps.
                                                                            none
                                                                            No providedIn)
                                                                            any
                                                                            Provides a unique instance in each lazy loaded module while all eagerly loaded modules share one instance.
                                                                            platform
                                                                            A special singleton platform injector shared by all applications on the page.
                                                                            		root
                                                                            queryParamObjectFormatThe format for query param objects: 'dot', 'json', 'key'.dot
                                                                            serviceFileSuffixThe suffix of the file of the generated service (service<suffix>.ts)..service
                                                                            serviceSuffixThe suffix of the generated service.Service
                                                                            snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            stringEnumsGenerate string enums instead of objects for enum values.false
                                                                            supportsES6Generate code that conforms to ES6.false
                                                                            taggedUnionsUse discriminators to create tagged unions instead of extending interfaces.false
                                                                            useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.false
                                                                            useSquareBracketsInArrayNamesSetting this property to true will add brackets to array attribute names, e.g. my_values[].false
                                                                            withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Blob
                                                                            • Boolean
                                                                            • Date
                                                                            • Double
                                                                            • Error
                                                                            • File
                                                                            • Float
                                                                            • Integer
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • ReadonlyArray
                                                                            • Set
                                                                            • String
                                                                            • any
                                                                            • boolean
                                                                            • number
                                                                            • object
                                                                            • string

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • await
                                                                            • boolean
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • const
                                                                            • continue
                                                                            • debugger
                                                                            • default
                                                                            • delete
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • export
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • formParams
                                                                            • function
                                                                            • goto
                                                                            • headerParams
                                                                            • if
                                                                            • implements
                                                                            • import
                                                                            • in
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • let
                                                                            • long
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • queryParameters
                                                                            • requestOptions
                                                                            • return
                                                                            • short
                                                                            • static
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • typeof
                                                                            • useFormData
                                                                            • var
                                                                            • varLocalDeferred
                                                                            • varLocalPath
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✓OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            Edit this page
                                                                            Last updated on by David Riddervold Marconis
                                                                            - + \ No newline at end of file diff --git a/docs/generators/typescript-aurelia/index.html b/docs/generators/typescript-aurelia/index.html index 4debef8bc02..a749b979944 100644 --- a/docs/generators/typescript-aurelia/index.html +++ b/docs/generators/typescript-aurelia/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the typescript-aurelia Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nametypescript-aureliapass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageTypescript
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a TypeScript client library for the Aurelia framework (beta).

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumNameSuffixSuffix that will be appended to all enum names.Enum
                                                                            enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                            enumPropertyNamingReplaceSpecialCharSet to true to replace '-' and '+' symbols with 'minus' and 'plus' in enum of type stringfalse
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            licenseNameThe name of the licenseUnlicense
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name. Only change it if you provide your own run-time code for (de-)serialization of modelsoriginal
                                                                            npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                            npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                            nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                            paramNamingNaming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            supportsES6Generate code that conforms to ES6.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Boolean
                                                                            • Date
                                                                            • Double
                                                                            • Error
                                                                            • File
                                                                            • Float
                                                                            • Integer
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • ReadonlyArray
                                                                            • Set
                                                                            • String
                                                                            • any
                                                                            • boolean
                                                                            • number
                                                                            • object
                                                                            • string

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • await
                                                                            • boolean
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • const
                                                                            • continue
                                                                            • debugger
                                                                            • default
                                                                            • delete
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • export
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • formParams
                                                                            • function
                                                                            • goto
                                                                            • headerParams
                                                                            • if
                                                                            • implements
                                                                            • import
                                                                            • in
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • let
                                                                            • long
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • queryParameters
                                                                            • requestOptions
                                                                            • return
                                                                            • short
                                                                            • static
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • typeof
                                                                            • useFormData
                                                                            • var
                                                                            • varLocalDeferred
                                                                            • varLocalPath
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✗OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            Edit this page
                                                                            Last updated on by David Riddervold Marconis
                                                                            - + \ No newline at end of file diff --git a/docs/generators/typescript-axios/index.html b/docs/generators/typescript-axios/index.html index 99ca5dae251..2ad7671130a 100644 --- a/docs/generators/typescript-axios/index.html +++ b/docs/generators/typescript-axios/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the typescript-axios Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nametypescript-axiospass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageTypescript
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a TypeScript client library using axios.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            apiPackagepackage for generated api classesnull
                                                                            axiosVersionUse this property to override the axios version in package.json^1.6.1
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumNameSuffixSuffix that will be appended to all enum names.Enum
                                                                            enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                            enumPropertyNamingReplaceSpecialCharSet to true to replace '-' and '+' symbols with 'minus' and 'plus' in enum of type stringfalse
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            licenseNameThe name of the licenseUnlicense
                                                                            modelPackagepackage for generated modelsnull
                                                                            npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                            npmRepositoryUse this property to set an url of your private npmRepo in the package.jsonnull
                                                                            npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                            nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                            paramNamingNaming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            stringEnumsGenerate string enums instead of objects for enum values.false
                                                                            supportsES6Generate code that conforms to ES6.false
                                                                            useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.false
                                                                            useSquareBracketsInArrayNamesSetting this property to true will add brackets to array attribute names, e.g. my_values[].false
                                                                            withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false
                                                                            withNodeImportsSetting this property to true adds imports for NodeJSfalse
                                                                            withSeparateModelsAndApiPut the model and api in separate folders and in separate classes. This requires in addition a value for 'apiPackage' and 'modelPackage'false
                                                                            withoutPrefixEnumsDon't prefix enum names with class namesfalse

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Boolean
                                                                            • Date
                                                                            • Double
                                                                            • Error
                                                                            • File
                                                                            • Float
                                                                            • Integer
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • ReadonlyArray
                                                                            • Set
                                                                            • String
                                                                            • any
                                                                            • boolean
                                                                            • number
                                                                            • object
                                                                            • string

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • await
                                                                            • boolean
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • const
                                                                            • continue
                                                                            • debugger
                                                                            • default
                                                                            • delete
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • export
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • formParams
                                                                            • function
                                                                            • goto
                                                                            • headerParams
                                                                            • if
                                                                            • implements
                                                                            • import
                                                                            • in
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • let
                                                                            • long
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • options
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • queryParameters
                                                                            • requestOptions
                                                                            • return
                                                                            • short
                                                                            • static
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • typeof
                                                                            • useFormData
                                                                            • var
                                                                            • varLocalDeferred
                                                                            • varLocalPath
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            Edit this page
                                                                            Last updated on by David Riddervold Marconis
                                                                            - + \ No newline at end of file diff --git a/docs/generators/typescript-fetch/index.html b/docs/generators/typescript-fetch/index.html index 8cfd8dda66b..15101e15eb1 100644 --- a/docs/generators/typescript-fetch/index.html +++ b/docs/generators/typescript-fetch/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the typescript-fetch Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nametypescript-fetchpass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageTypescript
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a TypeScript client library using Fetch API (beta).

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumNameSuffixSuffix that will be appended to all enum names.Enum
                                                                            enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                            enumPropertyNamingReplaceSpecialCharSet to true to replace '-' and '+' symbols with 'minus' and 'plus' in enum of type stringfalse
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            fileNamingNaming convention for the output files: 'PascalCase', 'camelCase', 'kebab-case'.PascalCase
                                                                            importFileExtensionFile extension to use with relative imports. Set it to '.js' or '.mjs' when using ESM.
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            licenseNameThe name of the licensenull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                            npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                            npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                            nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                            paramNamingNaming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prefixParameterInterfacesSetting this property to true will generate parameter interface declarations prefixed with API class name to avoid name conflicts.false
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            sagasAndRecordsSetting this property to true will generate additional files for use with redux-saga and immutablejs.false
                                                                            snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            stringEnumsGenerate string enums instead of objects for enum values.false
                                                                            supportsES6Generate code that conforms to ES6.false
                                                                            useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.true
                                                                            useSquareBracketsInArrayNamesSetting this property to true will add brackets to array attribute names, e.g. my_values[].false
                                                                            validationAttributesSetting this property to true will generate the validation attributes of model properties.false
                                                                            withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false
                                                                            withoutRuntimeChecksSetting this property to true will remove any runtime checks on the request and response payloads. Payloads will be casted to their expected types.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Boolean
                                                                            • Date
                                                                            • Double
                                                                            • Error
                                                                            • File
                                                                            • Float
                                                                            • Integer
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • ReadonlyArray
                                                                            • Set
                                                                            • String
                                                                            • any
                                                                            • boolean
                                                                            • number
                                                                            • object
                                                                            • string

                                                                            RESERVED WORDS​

                                                                            • ApiResponse
                                                                            • BASE_PATH
                                                                            • BaseAPI
                                                                            • BlobApiResponse
                                                                            • COLLECTION_FORMATS
                                                                            • Configuration
                                                                            • ConfigurationParameters
                                                                            • FetchAPI
                                                                            • FetchParams
                                                                            • HTTPBody
                                                                            • HTTPHeaders
                                                                            • HTTPMethod
                                                                            • HTTPQuery
                                                                            • Index
                                                                            • JSONApiResponse
                                                                            • Middleware
                                                                            • ModelPropertyNaming
                                                                            • RequestContext
                                                                            • RequestOpts
                                                                            • RequiredError
                                                                            • ResponseContext
                                                                            • ResponseTransformer
                                                                            • TextApiResponse
                                                                            • VoidApiResponse
                                                                            • abstract
                                                                            • await
                                                                            • boolean
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • configuration
                                                                            • const
                                                                            • continue
                                                                            • debugger
                                                                            • default
                                                                            • delete
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • exists
                                                                            • export
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • formParams
                                                                            • function
                                                                            • goto
                                                                            • headerParams
                                                                            • if
                                                                            • implements
                                                                            • import
                                                                            • in
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • let
                                                                            • long
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • queryParameters
                                                                            • requestOptions
                                                                            • return
                                                                            • short
                                                                            • static
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • typeof
                                                                            • useFormData
                                                                            • var
                                                                            • varLocalDeferred
                                                                            • varLocalPath
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            Edit this page
                                                                            Last updated on by David Riddervold Marconis
                                                                            - + \ No newline at end of file diff --git a/docs/generators/typescript-inversify/index.html b/docs/generators/typescript-inversify/index.html index fcda2d6c60e..c37389b4e4b 100644 --- a/docs/generators/typescript-inversify/index.html +++ b/docs/generators/typescript-inversify/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the typescript-inversify Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nametypescript-inversifypass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageTypescript
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates Typescript services using Inversify IOC

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumNameSuffixSuffix that will be appended to all enum names.Enum
                                                                            enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                            enumPropertyNamingReplaceSpecialCharSet to true to replace '-' and '+' symbols with 'minus' and 'plus' in enum of type stringfalse
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            licenseNameThe name of the licenseUnlicense
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name. Only change it if you provide your own run-time code for (de-)serialization of modelsoriginal
                                                                            npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                            npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                            npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                            nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                            paramNamingNaming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            supportsES6Generate code that conforms to ES6.false
                                                                            taggedUnionsUse discriminators to create tagged unions instead of extending interfaces.false
                                                                            usePromiseSetting this property to use promise instead of observable inside every service.false
                                                                            useRxJS6Setting this property to use rxjs 6 instead of rxjs 5.false
                                                                            withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Blob
                                                                            • Boolean
                                                                            • Date
                                                                            • Double
                                                                            • Error
                                                                            • File
                                                                            • Float
                                                                            • Integer
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • ReadonlyArray
                                                                            • Set
                                                                            • String
                                                                            • any
                                                                            • boolean
                                                                            • number
                                                                            • object
                                                                            • string

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • await
                                                                            • boolean
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • const
                                                                            • continue
                                                                            • debugger
                                                                            • default
                                                                            • delete
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • export
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • formParams
                                                                            • function
                                                                            • goto
                                                                            • headerParams
                                                                            • if
                                                                            • implements
                                                                            • import
                                                                            • in
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • let
                                                                            • long
                                                                            • map
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • queryParameters
                                                                            • requestOptions
                                                                            • return
                                                                            • short
                                                                            • static
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • typeof
                                                                            • useFormData
                                                                            • var
                                                                            • varLocalDeferred
                                                                            • varLocalPath
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            Edit this page
                                                                            Last updated on by David Riddervold Marconis
                                                                            - + \ No newline at end of file diff --git a/docs/generators/typescript-jquery/index.html b/docs/generators/typescript-jquery/index.html index 9ea7c30bd78..b3015f669ed 100644 --- a/docs/generators/typescript-jquery/index.html +++ b/docs/generators/typescript-jquery/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the typescript-jquery Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nametypescript-jquerypass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageTypescript
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a TypeScript jquery client library.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumNameSuffixSuffix that will be appended to all enum names.Enum
                                                                            enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                            enumPropertyNamingReplaceSpecialCharSet to true to replace '-' and '+' symbols with 'minus' and 'plus' in enum of type stringfalse
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            jqueryAlreadyImportedWhen using this in legacy app using mix of typescript and javascript, this will only declare jquery and not import itfalse
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            licenseNameThe name of the licenseMIT
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name. Only change it if you provide your own run-time code for (de-)serialization of modelsoriginal
                                                                            npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                            npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                            npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                            nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                            paramNamingNaming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            supportsES6Generate code that conforms to ES6.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Boolean
                                                                            • Date
                                                                            • Double
                                                                            • Error
                                                                            • File
                                                                            • Float
                                                                            • Integer
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • ReadonlyArray
                                                                            • Set
                                                                            • String
                                                                            • any
                                                                            • boolean
                                                                            • number
                                                                            • object
                                                                            • string

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • await
                                                                            • boolean
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • const
                                                                            • continue
                                                                            • debugger
                                                                            • default
                                                                            • delete
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • export
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • formParams
                                                                            • function
                                                                            • goto
                                                                            • headerParams
                                                                            • if
                                                                            • implements
                                                                            • import
                                                                            • in
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • let
                                                                            • long
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • queryParameters
                                                                            • requestOptions
                                                                            • return
                                                                            • short
                                                                            • static
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • typeof
                                                                            • useFormData
                                                                            • var
                                                                            • varLocalDeferred
                                                                            • varLocalPath
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            Edit this page
                                                                            Last updated on by David Riddervold Marconis
                                                                            - + \ No newline at end of file diff --git a/docs/generators/typescript-nestjs/index.html b/docs/generators/typescript-nestjs/index.html index dd2e06e091a..96ae6d408f1 100644 --- a/docs/generators/typescript-nestjs/index.html +++ b/docs/generators/typescript-nestjs/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the typescript-nestjs Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nametypescript-nestjspass this to the generate command after -g
                                                                            generator stabilityEXPERIMENTAL
                                                                            generator typeCLIENT
                                                                            generator languageTypescript
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a TypeScript Nestjs 8.x or 6.x client library.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumNameSuffixSuffix that will be appended to all enum names.Enum
                                                                            enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                            enumPropertyNamingReplaceSpecialCharSet to true to replace '-' and '+' symbols with 'minus' and 'plus' in enum of type stringfalse
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            fileNamingNaming convention for the output files: 'camelCase', 'kebab-case'.camelCase
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            licenseNameThe name of the licenseUnlicense
                                                                            modelFileSuffixThe suffix of the file of the generated model (model<suffix>.ts).null
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name. Only change it if you provide your own run-time code for (de-)serialization of modelsoriginal
                                                                            modelSuffixThe suffix of the generated model.null
                                                                            nestVersionThe version of Nestjs.
                                                                            8.0.0
                                                                            Use new HttpModule and HttpService from @nestjs/axios.
                                                                            6.0.0
                                                                            Use old HttpModule and HttpService from @nestjs/common.
                                                                            		8.0.0
                                                                            npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                            npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                            npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                            nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                            paramNamingNaming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            serviceFileSuffixThe suffix of the file of the generated service (service<suffix>.ts)..service
                                                                            serviceSuffixThe suffix of the generated service.Service
                                                                            snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            stringEnumsGenerate string enums instead of objects for enum values.false
                                                                            supportsES6Generate code that conforms to ES6.false
                                                                            taggedUnionsUse discriminators to create tagged unions instead of extending interfaces.false
                                                                            useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.false
                                                                            withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Blob
                                                                            • Boolean
                                                                            • Date
                                                                            • Double
                                                                            • Error
                                                                            • File
                                                                            • Float
                                                                            • Integer
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • ReadonlyArray
                                                                            • Set
                                                                            • String
                                                                            • any
                                                                            • boolean
                                                                            • number
                                                                            • object
                                                                            • string

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • await
                                                                            • boolean
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • const
                                                                            • continue
                                                                            • debugger
                                                                            • default
                                                                            • delete
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • export
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • formParams
                                                                            • function
                                                                            • goto
                                                                            • headerParams
                                                                            • if
                                                                            • implements
                                                                            • import
                                                                            • in
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • let
                                                                            • long
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • queryParameters
                                                                            • requestOptions
                                                                            • return
                                                                            • short
                                                                            • static
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • typeof
                                                                            • useFormData
                                                                            • var
                                                                            • varLocalDeferred
                                                                            • varLocalPath
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            Edit this page
                                                                            Last updated on by David Riddervold Marconis
                                                                            - + \ No newline at end of file diff --git a/docs/generators/typescript-node/index.html b/docs/generators/typescript-node/index.html index 67fe829aa69..e87de4b471c 100644 --- a/docs/generators/typescript-node/index.html +++ b/docs/generators/typescript-node/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the typescript-node Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nametypescript-nodepass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageTypescript
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a TypeScript NodeJS client library.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumNameSuffixSuffix that will be appended to all enum names.Enum
                                                                            enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                            enumPropertyNamingReplaceSpecialCharSet to true to replace '-' and '+' symbols with 'minus' and 'plus' in enum of type stringfalse
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            licenseNameThe name of the licenseUnlicense
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                            npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                            npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                            nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                            paramNamingNaming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            supportsES6Generate code that conforms to ES6.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Boolean
                                                                            • Buffer
                                                                            • Date
                                                                            • Double
                                                                            • Error
                                                                            • File
                                                                            • Float
                                                                            • Integer
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • ReadStream
                                                                            • ReadonlyArray
                                                                            • RequestDetailedFile
                                                                            • RequestFile
                                                                            • Set
                                                                            • String
                                                                            • any
                                                                            • boolean
                                                                            • number
                                                                            • object
                                                                            • string

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • await
                                                                            • boolean
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • const
                                                                            • continue
                                                                            • debugger
                                                                            • default
                                                                            • delete
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • export
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • formParams
                                                                            • function
                                                                            • goto
                                                                            • headerParams
                                                                            • if
                                                                            • implements
                                                                            • import
                                                                            • in
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • let
                                                                            • long
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • queryParameters
                                                                            • requestOptions
                                                                            • return
                                                                            • short
                                                                            • static
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • typeof
                                                                            • useFormData
                                                                            • var
                                                                            • varLocalDeferred
                                                                            • varLocalPath
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            Edit this page
                                                                            Last updated on by David Riddervold Marconis
                                                                            - + \ No newline at end of file diff --git a/docs/generators/typescript-redux-query/index.html b/docs/generators/typescript-redux-query/index.html index e19a1555ecd..ecf69d5d6e2 100644 --- a/docs/generators/typescript-redux-query/index.html +++ b/docs/generators/typescript-redux-query/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the typescript-redux-query Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nametypescript-redux-querypass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageTypescript
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a TypeScript client library using redux-query API (beta).

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumNameSuffixSuffix that will be appended to all enum names.Enum
                                                                            enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                            enumPropertyNamingReplaceSpecialCharSet to true to replace '-' and '+' symbols with 'minus' and 'plus' in enum of type stringfalse
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            licenseNameThe name of the licensenull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                            npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                            npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                            nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                            paramNamingNaming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            supportsES6Generate code that conforms to ES6.false
                                                                            useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.true
                                                                            withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Boolean
                                                                            • Date
                                                                            • Double
                                                                            • Error
                                                                            • File
                                                                            • Float
                                                                            • Integer
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • ReadonlyArray
                                                                            • Set
                                                                            • String
                                                                            • any
                                                                            • boolean
                                                                            • number
                                                                            • object
                                                                            • string

                                                                            RESERVED WORDS​

                                                                            • ApiResponse
                                                                            • BASE_PATH
                                                                            • BaseAPI
                                                                            • BlobApiResponse
                                                                            • COLLECTION_FORMATS
                                                                            • Configuration
                                                                            • ConfigurationParameters
                                                                            • HTTPBody
                                                                            • HTTPHeaders
                                                                            • HTTPMethod
                                                                            • HTTPQuery
                                                                            • JSONApiResponse
                                                                            • Middleware
                                                                            • ModelPropertyNaming
                                                                            • RequestContext
                                                                            • RequestOpts
                                                                            • RequiredError
                                                                            • ResponseContext
                                                                            • ResponseTransformer
                                                                            • TextApiResponse
                                                                            • VoidApiResponse
                                                                            • abstract
                                                                            • await
                                                                            • boolean
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • configuration
                                                                            • const
                                                                            • continue
                                                                            • debugger
                                                                            • default
                                                                            • delete
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • exists
                                                                            • export
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • formParams
                                                                            • function
                                                                            • goto
                                                                            • headerParams
                                                                            • if
                                                                            • implements
                                                                            • import
                                                                            • in
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • let
                                                                            • long
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • queryParameters
                                                                            • requestOptions
                                                                            • return
                                                                            • short
                                                                            • static
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • typeof
                                                                            • useFormData
                                                                            • var
                                                                            • varLocalDeferred
                                                                            • varLocalPath
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            Edit this page
                                                                            Last updated on by David Riddervold Marconis
                                                                            - + \ No newline at end of file diff --git a/docs/generators/typescript-rxjs/index.html b/docs/generators/typescript-rxjs/index.html index 7ec7ba181cc..7a40142dbad 100644 --- a/docs/generators/typescript-rxjs/index.html +++ b/docs/generators/typescript-rxjs/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the typescript-rxjs Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nametypescript-rxjspass this to the generate command after -g
                                                                            generator stabilitySTABLE
                                                                            generator typeCLIENT
                                                                            generator languageTypescript
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a TypeScript client library using Rxjs API.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumNameSuffixSuffix that will be appended to all enum names.Enum
                                                                            enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                            enumPropertyNamingReplaceSpecialCharSet to true to replace '-' and '+' symbols with 'minus' and 'plus' in enum of type stringfalse
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            licenseNameThe name of the licensenull
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name. Only change it if you provide your own run-time code for (de-)serialization of modelsoriginal
                                                                            npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                            npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                            npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                            nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                            paramNamingNaming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            supportsES6Generate code that conforms to ES6.false
                                                                            withProgressSubscriberSetting this property to true will generate API controller methods with support for subscribing to request progress.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Blob
                                                                            • Boolean
                                                                            • Date
                                                                            • Double
                                                                            • Error
                                                                            • File
                                                                            • Float
                                                                            • Integer
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • ReadonlyArray
                                                                            • Set
                                                                            • String
                                                                            • any
                                                                            • boolean
                                                                            • number
                                                                            • object
                                                                            • string

                                                                            RESERVED WORDS​

                                                                            • AjaxRequest
                                                                            • AjaxResponse
                                                                            • BASE_PATH
                                                                            • BaseAPI
                                                                            • COLLECTION_FORMATS
                                                                            • Configuration
                                                                            • ConfigurationParameters
                                                                            • HttpBody
                                                                            • HttpHeaders
                                                                            • HttpMethod
                                                                            • HttpQuery
                                                                            • Middleware
                                                                            • RequestArgs
                                                                            • RequestOpts
                                                                            • ResponseArgs
                                                                            • abstract
                                                                            • await
                                                                            • boolean
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • const
                                                                            • continue
                                                                            • debugger
                                                                            • default
                                                                            • delete
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • export
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • formParams
                                                                            • function
                                                                            • goto
                                                                            • headerParams
                                                                            • if
                                                                            • implements
                                                                            • import
                                                                            • in
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • let
                                                                            • long
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • queryParameters
                                                                            • requestOptions
                                                                            • return
                                                                            • servers
                                                                            • short
                                                                            • static
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • typeof
                                                                            • useFormData
                                                                            • var
                                                                            • varLocalDeferred
                                                                            • varLocalPath
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✗OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            Edit this page
                                                                            Last updated on by David Riddervold Marconis
                                                                            - + \ No newline at end of file diff --git a/docs/generators/typescript/index.html b/docs/generators/typescript/index.html index f0bbaece51c..70534c05b42 100644 --- a/docs/generators/typescript/index.html +++ b/docs/generators/typescript/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the typescript Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator nametypescriptpass this to the generate command after -g
                                                                            generator stabilityEXPERIMENTAL
                                                                            generator typeCLIENT
                                                                            generator languageTypescript
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates a TypeScript client library using Fetch API (beta).

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumNameSuffixSuffix that will be appended to all enum names.Enum
                                                                            enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                            enumPropertyNamingReplaceSpecialCharSet to true to replace '-' and '+' symbols with 'minus' and 'plus' in enum of type stringfalse
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            fileContentDataTypeSpecifies the type to use for the content of a file - i.e. Blob (Browser, Deno) / Buffer (node)Buffer
                                                                            frameworkSpecify the framework which should be used in the client code.
                                                                            fetch-api
                                                                            fetch-api
                                                                            jquery
                                                                            jquery
                                                                            		fetch-api
                                                                            importFileExtensionFile extension to use with relative imports. Set it to '.js' or '.mjs' when using ESM. Defaults to '.ts' when 'platform' is set to 'deno'.null
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            licenseNameThe name of the licenseUnlicense
                                                                            modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                            npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                            npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                            nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                            paramNamingNaming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                            platformSpecifies the platform the code should run on. The default is 'node' for the 'request' framework and 'browser' otherwise.
                                                                            browser
                                                                            browser
                                                                            node
                                                                            node
                                                                            deno
                                                                            deno
                                                                            		browser
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            supportsES6Generate code that conforms to ES6.false
                                                                            useInversifyEnable this to generate decorators and service identifiers for the InversifyJS inversion of control container. If you set 'deno' as 'platform', the generator will process this value as 'disable'.false
                                                                            useObjectParametersUse aggregate parameter objects as function arguments for api operations instead of passing each parameter as a separate function argument.false
                                                                            useRxJSEnable this to internally use rxjs observables. If disabled, a stub is used instead. This is required for the 'angular' framework.false

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By
                                                                            arrayArray

                                                                            LANGUAGE PRIMITIVES​

                                                                            • Array
                                                                            • Boolean
                                                                            • Date
                                                                            • Double
                                                                            • Error
                                                                            • File
                                                                            • Float
                                                                            • Integer
                                                                            • Long
                                                                            • Map
                                                                            • Object
                                                                            • ReadonlyArray
                                                                            • Set
                                                                            • String
                                                                            • any
                                                                            • boolean
                                                                            • number
                                                                            • object
                                                                            • string

                                                                            RESERVED WORDS​

                                                                            • abstract
                                                                            • await
                                                                            • boolean
                                                                            • break
                                                                            • byte
                                                                            • case
                                                                            • catch
                                                                            • char
                                                                            • class
                                                                            • const
                                                                            • constructor
                                                                            • continue
                                                                            • debugger
                                                                            • default
                                                                            • delete
                                                                            • do
                                                                            • double
                                                                            • else
                                                                            • enum
                                                                            • export
                                                                            • extends
                                                                            • false
                                                                            • final
                                                                            • finally
                                                                            • float
                                                                            • for
                                                                            • formParams
                                                                            • from
                                                                            • function
                                                                            • goto
                                                                            • headerParams
                                                                            • if
                                                                            • implements
                                                                            • import
                                                                            • in
                                                                            • instanceof
                                                                            • int
                                                                            • interface
                                                                            • let
                                                                            • long
                                                                            • native
                                                                            • new
                                                                            • null
                                                                            • package
                                                                            • private
                                                                            • protected
                                                                            • public
                                                                            • queryParameters
                                                                            • requestOptions
                                                                            • return
                                                                            • short
                                                                            • static
                                                                            • super
                                                                            • switch
                                                                            • synchronized
                                                                            • this
                                                                            • throw
                                                                            • transient
                                                                            • true
                                                                            • try
                                                                            • typeof
                                                                            • useFormData
                                                                            • var
                                                                            • varLocalDeferred
                                                                            • varLocalPath
                                                                            • void
                                                                            • volatile
                                                                            • while
                                                                            • with
                                                                            • yield

                                                                            FEATURE SET​

                                                                            Client Modification Feature​

                                                                            NameSupportedDefined By
                                                                            BasePath✓ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension
                                                                            MockServer✗ToolingExtension

                                                                            Data Type Feature​

                                                                            NameSupportedDefined By
                                                                            Custom✗OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Uuid✗
                                                                            Array✓OAS2,OAS3
                                                                            Null✗OAS3
                                                                            AnyType✗OAS2,OAS3
                                                                            Object✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature​

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature​

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✗OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                            MultiServer✗OAS3
                                                                            ParameterizedServer✗OAS3
                                                                            ParameterStyling✗OAS3
                                                                            Callbacks✗OAS3
                                                                            LinkObjects✗OAS3

                                                                            Parameter Feature​

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature​

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✗OAS3
                                                                            allOf✗OAS2,OAS3
                                                                            anyOf✗OAS3
                                                                            oneOf✗OAS3
                                                                            not✗OAS3

                                                                            Security Feature​

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✗OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✗OAS2,OAS3
                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3
                                                                            SignatureAuth✗OAS3
                                                                            AWSV4Signature✗ToolingExtension

                                                                            Wire Format Feature​

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✗ToolingExtension
                                                                            Custom✗OAS2,OAS3
                                                                            Edit this page
                                                                            Last updated on by David Riddervold Marconis
                                                                            - + \ No newline at end of file diff --git a/docs/generators/wsdl-schema/index.html b/docs/generators/wsdl-schema/index.html index e496c142f7c..3fe92a2110e 100644 --- a/docs/generators/wsdl-schema/index.html +++ b/docs/generators/wsdl-schema/index.html @@ -15,13 +15,13 @@ - +

                                                                            Documentation for the wsdl-schema Generator

                                                                            METADATA​

                                                                            PropertyValueNotes
                                                                            generator namewsdl-schemapass this to the generate command after -g
                                                                            generator stabilityBETA
                                                                            generator typeSCHEMA
                                                                            generator languageWeb Services Description Language (WSDL)
                                                                            generator default templating enginemustache
                                                                            helpTxtGenerates WSDL files.

                                                                            CONFIG OPTIONS​

                                                                            These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            contentTypeVersiongenerate WSDL with parameters/responses of the specified content-typenull
                                                                            disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            false
                                                                            The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                            true
                                                                            Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                            		true
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                            false
                                                                            No changes to the enum's are made, this is the default option.
                                                                            true
                                                                            With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                            		false
                                                                            hostnamethe hostname of the servicenull
                                                                            legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                            true
                                                                            The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                            false
                                                                            The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                            		true
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            serviceNameservice name for the wsdlnull
                                                                            soapPathbasepath of the soap servicesnull
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                            useSpecifiedOperationIdwhether to use autogenerated operationId's (default) or those specified in openapi specnull

                                                                            IMPORT MAPPING​

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES​

                                                                            Type/AliasInstantiated By

                                                                            LANGUAGE PRIMITIVES​

                                                                              RESERVED WORDS​

                                                                                FEATURE SET​

                                                                                Client Modification Feature​

                                                                                NameSupportedDefined By
                                                                                BasePath✗ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension
                                                                                MockServer✗ToolingExtension

                                                                                Data Type Feature​

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Uuid✗
                                                                                Array✓OAS2,OAS3
                                                                                Null✗OAS3
                                                                                AnyType✗OAS2,OAS3
                                                                                Object✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature​

                                                                                NameSupportedDefined By
                                                                                Readme✗ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature​

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✓OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature​

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature​

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✓OAS2,OAS3
                                                                                Union✗OAS3
                                                                                allOf✗OAS2,OAS3
                                                                                anyOf✗OAS3
                                                                                oneOf✗OAS3
                                                                                not✗OAS3

                                                                                Security Feature​

                                                                                NameSupportedDefined By
                                                                                BasicAuth✓OAS2,OAS3
                                                                                ApiKey✓OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✓OAS3
                                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                                OAuth2_Password✓OAS2,OAS3
                                                                                OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✓OAS2,OAS3
                                                                                SignatureAuth✗OAS3
                                                                                AWSV4Signature✗ToolingExtension

                                                                                Wire Format Feature​

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                - + \ No newline at end of file diff --git a/docs/generators/xojo-client/index.html b/docs/generators/xojo-client/index.html index f5dd2394ae4..fd4802e784b 100644 --- a/docs/generators/xojo-client/index.html +++ b/docs/generators/xojo-client/index.html @@ -15,13 +15,13 @@ - +

                                                                                Documentation for the xojo-client Generator

                                                                                METADATA​

                                                                                PropertyValueNotes
                                                                                generator namexojo-clientpass this to the generate command after -g
                                                                                generator stabilitySTABLE
                                                                                generator typeCLIENT
                                                                                generator languageXojo
                                                                                generator default templating enginemustache
                                                                                helpTxtGenerates a Xojo client module.

                                                                                CONFIG OPTIONS​

                                                                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                                OptionDescriptionValuesDefault
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiNamePrefixPrefix that will be appended to all API classes. Default: empty string.null
                                                                                apiPackagepackage for generated api classesnull
                                                                                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                                false
                                                                                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                                true
                                                                                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                                		true
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                                false
                                                                                No changes to the enum's are made, this is the default option.
                                                                                true
                                                                                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                                		false
                                                                                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                                true
                                                                                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                                false
                                                                                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                                		true
                                                                                librarylibrary template (sub-template)
                                                                                httpsocket
                                                                                [DEFAULT] HTTP client: HTTPSocket
                                                                                		httpsocket
                                                                                modelPackagepackage for generated modelsnull
                                                                                nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.null
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                projectNameProject name in Xojonull
                                                                                serializationLibraryWhat serialization library to use: 'xoson' (default).xoson
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                supportsAsyncGenerate code that supports async operations.null

                                                                                IMPORT MAPPING​

                                                                                Type/AliasImports

                                                                                INSTANTIATION TYPES​

                                                                                Type/AliasInstantiated By

                                                                                LANGUAGE PRIMITIVES​

                                                                                • Boolean
                                                                                • Color
                                                                                • Currency
                                                                                • Double
                                                                                • Int16
                                                                                • Int32
                                                                                • Int64
                                                                                • Int8
                                                                                • Integer
                                                                                • Single
                                                                                • String
                                                                                • UInt16
                                                                                • UInt32
                                                                                • UInt64
                                                                                • UInt8
                                                                                • UInteger

                                                                                RESERVED WORDS​

                                                                                • #bad
                                                                                • #else
                                                                                • #elseif
                                                                                • #endif
                                                                                • #if
                                                                                • #pragma
                                                                                • #tag
                                                                                • addhandler
                                                                                • addressof
                                                                                • aggregates
                                                                                • and
                                                                                • apis
                                                                                • array
                                                                                • as
                                                                                • assigns
                                                                                • async
                                                                                • attributes
                                                                                • await
                                                                                • break
                                                                                • byref
                                                                                • byval
                                                                                • call
                                                                                • case
                                                                                • catch
                                                                                • class
                                                                                • column
                                                                                • const
                                                                                • continue
                                                                                • ctype
                                                                                • declare
                                                                                • delegate
                                                                                • dim
                                                                                • do
                                                                                • downto
                                                                                • each
                                                                                • else
                                                                                • elseif
                                                                                • end
                                                                                • enum
                                                                                • event
                                                                                • exception
                                                                                • exit
                                                                                • extends
                                                                                • false
                                                                                • file
                                                                                • finally
                                                                                • for
                                                                                • function
                                                                                • global
                                                                                • goto
                                                                                • handles
                                                                                • if
                                                                                • implements
                                                                                • in
                                                                                • inherits
                                                                                • interface
                                                                                • is
                                                                                • isa
                                                                                • lib
                                                                                • line
                                                                                • loop
                                                                                • me
                                                                                • mod
                                                                                • models
                                                                                • module
                                                                                • namespace
                                                                                • new
                                                                                • next
                                                                                • nil
                                                                                • not
                                                                                • of
                                                                                • optional
                                                                                • or
                                                                                • paramarray
                                                                                • private
                                                                                • property
                                                                                • protected
                                                                                • public
                                                                                • raise
                                                                                • raiseevent
                                                                                • redim
                                                                                • rem
                                                                                • removehandler
                                                                                • return
                                                                                • select
                                                                                • self
                                                                                • shared
                                                                                • soft
                                                                                • static
                                                                                • step
                                                                                • structure
                                                                                • sub
                                                                                • super
                                                                                • then
                                                                                • to
                                                                                • true
                                                                                • try
                                                                                • until
                                                                                • using
                                                                                • var
                                                                                • void
                                                                                • weakaddressof
                                                                                • wend
                                                                                • while
                                                                                • with
                                                                                • xor

                                                                                FEATURE SET​

                                                                                Client Modification Feature​

                                                                                NameSupportedDefined By
                                                                                BasePath✗ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension
                                                                                MockServer✗ToolingExtension

                                                                                Data Type Feature​

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Uuid✗
                                                                                Array✓OAS2,OAS3
                                                                                Null✗OAS3
                                                                                AnyType✗OAS2,OAS3
                                                                                Object✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature​

                                                                                NameSupportedDefined By
                                                                                Readme✗ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature​

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✓OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature​

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature​

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✓OAS2,OAS3
                                                                                Union✗OAS3
                                                                                allOf✗OAS2,OAS3
                                                                                anyOf✗OAS3
                                                                                oneOf✗OAS3
                                                                                not✗OAS3

                                                                                Security Feature​

                                                                                NameSupportedDefined By
                                                                                BasicAuth✓OAS2,OAS3
                                                                                ApiKey✓OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✓OAS3
                                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                                OAuth2_Password✓OAS2,OAS3
                                                                                OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✓OAS2,OAS3
                                                                                SignatureAuth✗OAS3
                                                                                AWSV4Signature✗ToolingExtension

                                                                                Wire Format Feature​

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                - + \ No newline at end of file diff --git a/docs/generators/zapier/index.html b/docs/generators/zapier/index.html index 7be0749048c..8d0e130a21f 100644 --- a/docs/generators/zapier/index.html +++ b/docs/generators/zapier/index.html @@ -15,13 +15,13 @@ - +

                                                                                Documentation for the zapier Generator

                                                                                METADATA​

                                                                                PropertyValueNotes
                                                                                generator namezapierpass this to the generate command after -g
                                                                                generator stabilityBETA
                                                                                generator typeCLIENT
                                                                                generator default templating enginemustache
                                                                                helpTxtGenerates a zapier client.

                                                                                CONFIG OPTIONS​

                                                                                These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

                                                                                OptionDescriptionValuesDefault
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                                false
                                                                                The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
                                                                                true
                                                                                Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
                                                                                		true
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                enumUnknownDefaultCaseIf the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
                                                                                false
                                                                                No changes to the enum's are made, this is the default option.
                                                                                true
                                                                                With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
                                                                                		false
                                                                                legacyDiscriminatorBehaviorSet to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
                                                                                true
                                                                                The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
                                                                                false
                                                                                The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
                                                                                		true
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                IMPORT MAPPING​

                                                                                Type/AliasImports

                                                                                INSTANTIATION TYPES​

                                                                                Type/AliasInstantiated By
                                                                                arrayarray
                                                                                listarray
                                                                                mapobject
                                                                                setarray

                                                                                LANGUAGE PRIMITIVES​

                                                                                • array
                                                                                • boolean
                                                                                • file
                                                                                • integer
                                                                                • number
                                                                                • object
                                                                                • string

                                                                                RESERVED WORDS​

                                                                                  FEATURE SET​

                                                                                  Client Modification Feature​

                                                                                  NameSupportedDefined By
                                                                                  BasePath✗ToolingExtension
                                                                                  Authorizations✗ToolingExtension
                                                                                  UserAgent✗ToolingExtension
                                                                                  MockServer✗ToolingExtension

                                                                                  Data Type Feature​

                                                                                  NameSupportedDefined By
                                                                                  Custom✗OAS2,OAS3
                                                                                  Int32✓OAS2,OAS3
                                                                                  Int64✓OAS2,OAS3
                                                                                  Float✓OAS2,OAS3
                                                                                  Double✓OAS2,OAS3
                                                                                  Decimal✓ToolingExtension
                                                                                  String✓OAS2,OAS3
                                                                                  Byte✓OAS2,OAS3
                                                                                  Binary✓OAS2,OAS3
                                                                                  Boolean✓OAS2,OAS3
                                                                                  Date✓OAS2,OAS3
                                                                                  DateTime✓OAS2,OAS3
                                                                                  Password✓OAS2,OAS3
                                                                                  File✓OAS2
                                                                                  Uuid✗
                                                                                  Array✓OAS2,OAS3
                                                                                  Null✗OAS3
                                                                                  AnyType✗OAS2,OAS3
                                                                                  Object✓OAS2,OAS3
                                                                                  Maps✓ToolingExtension
                                                                                  CollectionFormat✓OAS2
                                                                                  CollectionFormatMulti✓OAS2
                                                                                  Enum✓OAS2,OAS3
                                                                                  ArrayOfEnum✓ToolingExtension
                                                                                  ArrayOfModel✓ToolingExtension
                                                                                  ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                  ArrayOfCollectionOfModel✓ToolingExtension
                                                                                  ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                  MapOfEnum✓ToolingExtension
                                                                                  MapOfModel✓ToolingExtension
                                                                                  MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                  MapOfCollectionOfModel✓ToolingExtension
                                                                                  MapOfCollectionOfEnum✓ToolingExtension

                                                                                  Documentation Feature​

                                                                                  NameSupportedDefined By
                                                                                  Readme✗ToolingExtension
                                                                                  Model✓ToolingExtension
                                                                                  Api✓ToolingExtension

                                                                                  Global Feature​

                                                                                  NameSupportedDefined By
                                                                                  Host✓OAS2,OAS3
                                                                                  BasePath✓OAS2,OAS3
                                                                                  Info✓OAS2,OAS3
                                                                                  Schemes✗OAS2,OAS3
                                                                                  PartialSchemes✓OAS2,OAS3
                                                                                  Consumes✓OAS2
                                                                                  Produces✓OAS2
                                                                                  ExternalDocumentation✓OAS2,OAS3
                                                                                  Examples✓OAS2,OAS3
                                                                                  XMLStructureDefinitions✗OAS2,OAS3
                                                                                  MultiServer✗OAS3
                                                                                  ParameterizedServer✗OAS3
                                                                                  ParameterStyling✗OAS3
                                                                                  Callbacks✓OAS3
                                                                                  LinkObjects✗OAS3

                                                                                  Parameter Feature​

                                                                                  NameSupportedDefined By
                                                                                  Path✓OAS2,OAS3
                                                                                  Query✓OAS2,OAS3
                                                                                  Header✓OAS2,OAS3
                                                                                  Body✓OAS2
                                                                                  FormUnencoded✓OAS2
                                                                                  FormMultipart✓OAS2
                                                                                  Cookie✓OAS3

                                                                                  Schema Support Feature​

                                                                                  NameSupportedDefined By
                                                                                  Simple✓OAS2,OAS3
                                                                                  Composite✓OAS2,OAS3
                                                                                  Polymorphism✓OAS2,OAS3
                                                                                  Union✗OAS3
                                                                                  allOf✗OAS2,OAS3
                                                                                  anyOf✗OAS3
                                                                                  oneOf✗OAS3
                                                                                  not✗OAS3

                                                                                  Security Feature​

                                                                                  NameSupportedDefined By
                                                                                  BasicAuth✓OAS2,OAS3
                                                                                  ApiKey✓OAS2,OAS3
                                                                                  OpenIDConnect✗OAS3
                                                                                  BearerToken✓OAS3
                                                                                  OAuth2_Implicit✓OAS2,OAS3
                                                                                  OAuth2_Password✓OAS2,OAS3
                                                                                  OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                  OAuth2_AuthorizationCode✓OAS2,OAS3
                                                                                  SignatureAuth✗OAS3
                                                                                  AWSV4Signature✗ToolingExtension

                                                                                  Wire Format Feature​

                                                                                  NameSupportedDefined By
                                                                                  JSON✓OAS2,OAS3
                                                                                  XML✓OAS2,OAS3
                                                                                  PROTOBUF✗ToolingExtension
                                                                                  Custom✗OAS2,OAS3
                                                                                  - + \ No newline at end of file diff --git a/docs/globals/index.html b/docs/globals/index.html index 405cd25d302..37061ee41b9 100644 --- a/docs/globals/index.html +++ b/docs/globals/index.html @@ -15,13 +15,13 @@ - +

                                                                                  Global Properties

                                                                                  Available Global Properties​

                                                                                  PropertyDescriptionAcceptable value
                                                                                  debugOpenAPIDumps JSON formatted and fully parsed OpenAPI document during generationnone
                                                                                  debugModelsDumps JSON formatted template-bound model information during generationnone
                                                                                  debugOperationsDumps JSON formatted template-bound operation information during generationnone
                                                                                  debugSupportingFilesDumps JSON formatted Supporting File information during generationnone
                                                                                  verboseDefines the verbositytrue or false
                                                                                  generateAliasAsModelDefines whether primitive types defined at the model/schema level will be wrapped in a modeltrue or false
                                                                                  org.openapitools.codegen.utils.oncelogger.enabledEnable/disable the "OnceLogger" which reduces noise for select repeated logstrue or false
                                                                                  supportingFilesAllows the user to define which supporting files will be generated. Prefer using the more robust .openapi-generator-ignore.no value, or a colon-separated string of file names
                                                                                  modelsAllows the user to define which models will be generated. Prefer using the more robust .openapi-generator-ignore.no value, or a colon-separated string of model names
                                                                                  apisAllows the user to define which apis will be generated. Prefer using the more robust .openapi-generator-ignore.no value, or a colon-separated string of api names
                                                                                  apiDocsAllows the user to define if api docs will be generated. Prefer using the more robust .openapi-generator-ignore.true or false
                                                                                  modelDocsAllows the user to define if model docs will be generated. Prefer using the more robust .openapi-generator-ignore.true or false
                                                                                  apiTestsAllows the user to define if api tests will be generated. Prefer using the more robust .openapi-generator-ignore.true or false
                                                                                  modelTestsAllows the user to define if model tests will be generated. Prefer using the more robust .openapi-generator-ignore.true or false

                                                                                  Note on Global Property declaration​

                                                                                  There are two ways to provide selective generation properties or "global properties". First, these can be passed as Java System Properties. Second, these can be passed via the global property tooling option (--global-property in CLI and globalProperty in Maven and Gradle configurations). This differentiation is new in version 5.0 with the removal of the -D CLI option and the renaming of systemProperties. If you're upgrading to OpenAPI Generator 5.0+

                                                                                  While the examples seen in Customization use the Java System Property syntax, keep in mind that the following are equivalent:

                                                                                  java -Dmodels {jar} generate {opts}

                                                                                  and

                                                                                  java {jar} generate {opts} --global-property=models

                                                                                  Why the two differing ways to provide the same properties? We previously accepted a -D tooling option which resembled Java System Property declaration. In older versions of OpenAPI Generator, the option modified the SystemProperties collection directly and was truly a "system property". This option changed during the 4.x release in an effort to make OpenAPI Generator thread-safe and isolate its configuration via thread locals. We no longer mutate System Properties. In the 4.x release and earlier, specifying the tooling -D option with system properties intended for other tools like swagger-parser rather than passing them as true Java System Properties would lead to unexpected behavior for the user; if our tool set the system property after invoking certain code, it would seem to the user like Java System Properties weren't working!

                                                                                  - + \ No newline at end of file diff --git a/docs/installation/index.html b/docs/installation/index.html index b9875eb033f..68f093a4552 100644 --- a/docs/installation/index.html +++ b/docs/installation/index.html @@ -15,7 +15,7 @@ - + @@ -25,7 +25,7 @@ Installing OpenAPI Generator's CLI tool allows users to generate all availa Install the latest version of the tool globally, exposing the CLI on the command line:

                                                                                  npm install @openapitools/openapi-generator-cli -g

                                                                                  To install a specific version of the tool, pass the version during installation:

                                                                                  openapi-generator-cli version-manager set 7.9.0

                                                                                  To install the tool as a dev dependency in your current project:

                                                                                  npm install @openapitools/openapi-generator-cli -D

                                                                                  Then, generate a ruby client from a valid petstore.yaml doc:

                                                                                  npx @openapitools/openapi-generator-cli generate -i petstore.yaml -g ruby -o /tmp/test/

                                                                                  npx will execute a globally available openapi-generator, and if not found it will fall back to project-local commands. The result is that the above command will work regardless of which installation method you've chosen.

                                                                                  Homebrew​

                                                                                  Platform(s): macOS

                                                                                  Install via homebrew:

                                                                                  brew install openapi-generator

                                                                                  Then, generate a ruby client from a valid petstore.yaml doc:

                                                                                  openapi-generator generate -i petstore.yaml -g ruby -o /tmp/test/

                                                                                  Scoop​

                                                                                  Platform(s): Windows

                                                                                  Install via scoop:

                                                                                  scoop install openapi-generator-cli

                                                                                  If you don't have java installed, you can also install it via scoop java bucket:

                                                                                  scoop bucket add java
                                                                                  scoop install openjdk

                                                                                  Then, generate a ruby client from a valid petstore.yaml doc:

                                                                                  openapi-generator-cli generate -i petstore.yaml -g ruby

                                                                                  Docker​

                                                                                  Platform(s): Linux, macOS, Windows

                                                                                  The OpenAPI Generator Docker image acts as a standalone executable. It can be used as an alternative to installing via homebrew, or for developers who are unable to install Java or upgrade the installed version.

                                                                                  To generate code from a valid petstore.yaml doc with this image, you'll need to mount a local location as a volume. You'll then need to output the generated code to this mapped volume. Everything else works the same as if you ran the command on your host machine.

                                                                                  Here's an example generating a Go client:

                                                                                  docker run --rm \
                                                                                    -v ${PWD}:/local openapitools/openapi-generator-cli generate \
                                                                                    -i /local/petstore.yaml \
                                                                                    -g go \
                                                                                    -o /local/out/go

                                                                                  JAR​

                                                                                  Platform(s): Linux, macOS, Windows

                                                                                  If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 11 runtime at a minimum):

                                                                                  JAR location: https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.9.0/openapi-generator-cli-7.9.0.jar

                                                                                  For Mac/Linux users:

                                                                                  wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.9.0/openapi-generator-cli-7.9.0.jar -O openapi-generator-cli.jar

                                                                                  For Windows users, you will need to install wget or you can use Invoke-WebRequest in PowerShell (3.0+), e.g.

                                                                                  Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.9.0/openapi-generator-cli-7.9.0.jar

                                                                                  After downloading the JAR, run java -jar openapi-generator-cli.jar help to show the usage.

                                                                                  For Mac users, please make sure Java 11 is installed (Tips: run java -version to check the version), and export JAVA_HOME in order to use the supported Java version:

                                                                                  export JAVA_HOME=`/usr/libexec/java_home -v 1.11`
                                                                                  export PATH=${JAVA_HOME}/bin:$PATH

                                                                                  Bash Launcher Script​

                                                                                  Platform(s): Linux, macOS, Windows (variable)

                                                                                  One downside to manual JAR downloads is that you don't keep up-to-date with the latest released version. We have a Bash launcher script at bin/utils/openapi-generator-cli.sh which solves this problem.

                                                                                  To install the launcher script, copy the contents of the script to a location on your path and make the script executable.

                                                                                  An example of setting this up (NOTE: Always evaluate scripts curled from external systems before executing them).

                                                                                  mkdir -p ~/bin/openapitools
                                                                                  curl https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/bin/utils/openapi-generator-cli.sh > ~/bin/openapitools/openapi-generator-cli
                                                                                  chmod u+x ~/bin/openapitools/openapi-generator-cli
                                                                                  export PATH=$PATH:~/bin/openapitools/

                                                                                  Now, openapi-generator-cli is "installed". On invocation, it will query the GitHub repository for the most recently released version. If this matches the last downloaded jar, it will execute as normal. If a newer version is found, the script will download the latest release and execute it.

                                                                                  If you need to invoke an older version of the generator, you can define the variable OPENAPI_GENERATOR_VERSION either ad hoc or globally. You can export this variable if you'd like to persist a specific release version.

                                                                                  Examples:

                                                                                  # Execute latest released openapi-generator-cli
                                                                                  openapi-generator-cli version

                                                                                  # Execute version 3.1.0 for the current invocation, regardless of the latest released version
                                                                                  OPENAPI_GENERATOR_VERSION=3.1.0 openapi-generator-cli version

                                                                                  # Execute version 3.1.0-SNAPSHOT for the current invocation
                                                                                  OPENAPI_GENERATOR_VERSION=3.1.0-SNAPSHOT openapi-generator-cli version

                                                                                  # Execute version 3.0.2 for every invocation in the current shell session
                                                                                  export OPENAPI_GENERATOR_VERSION=3.0.2
                                                                                  openapi-generator-cli version # is 3.0.2
                                                                                  openapi-generator-cli version # is also 3.0.2

                                                                                  # To "install" a specific version, set the variable in .bashrc/.bash_profile
                                                                                  echo "export OPENAPI_GENERATOR_VERSION=3.0.2" >> ~/.bashrc
                                                                                  source ~/.bashrc
                                                                                  openapi-generator-cli version # is always 3.0.2, unless any of the above overrides are done ad hoc
                                                                                  - + \ No newline at end of file diff --git a/docs/integrations/index.html b/docs/integrations/index.html index 52f69c3075c..c9cd2911cd4 100644 --- a/docs/integrations/index.html +++ b/docs/integrations/index.html @@ -15,13 +15,13 @@ - +

                                                                                  Workflow Integrations

                                                                                  Workflow Integration (Gradle, Maven, GitHub, CI/CD)​

                                                                                  Gradle Integration​

                                                                                  See the openapi-generator-gradle-plugin README for details related to configuring and using the Gradle Plugin.

                                                                                  Supported tasks include:

                                                                                  • Listing generators
                                                                                  • Validation of Open API 2.0 and 3.0 Specs
                                                                                  • Generating "Meta" generators
                                                                                  • Generating all generators supported by OpenAPI Generator

                                                                                  Maven Integration​

                                                                                  See the openapi-generator-maven-plugin README for details related to configuring and using the Maven Plugin.

                                                                                  sbt Integration​

                                                                                  Please refer to https://github.com/OpenAPITools/sbt-openapi-generator

                                                                                  Bazel Integration​

                                                                                  Please refer to https://github.com/OpenAPITools/openapi-generator-bazel

                                                                                  Cake Addin​

                                                                                  3rd-party Cake Addin provided by Lukas Körfer: https://github.com/lukoerfer/cake-openapi-generator

                                                                                  GitHub Integration​

                                                                                  To push the auto-generated SDK to GitHub, we provide git_push.sh to streamline the process. For example:

                                                                                  1) Create a new repository in GitHub (Ref: https://help.github.com/articles/creating-a-new-repository/)

                                                                                  2) Generate the SDK

                                                                                   java -jar openapi-generator-cli.jar generate \
                                                                                   -i modules/openapi-generator/src/test/resources/3_0/petstore.json -g perl \
                                                                                   --git-user-id "wing328" \
                                                                                   --git-repo-id "petstore-perl" \
                                                                                   --release-note "GitHub integration demo" \
                                                                                   -o /var/tmp/perl/petstore

                                                                                  3) Push the SDK to GitHub

                                                                                  cd /var/tmp/perl/petstore
                                                                                  /bin/sh ./git_push.sh

                                                                                  To use openapi-generator as part of Github workflows, the blog post "Autogenerating Clients with FastAPI and Github Actions" by Andrew Israel is a good starting point.

                                                                                  CI/CD​

                                                                                  Some generators also generate CI/CD configuration files (.travis.yml) so that the output will be ready to be tested by the CI (e.g. Travis)

                                                                                  If you're looking for the configuration files of a particular CI that is not yet supported, please open an issue to let us know.

                                                                                  - + \ No newline at end of file diff --git a/docs/new-generator/index.html b/docs/new-generator/index.html index 6edc7fcdf6d..ac481381c8f 100644 --- a/docs/new-generator/index.html +++ b/docs/new-generator/index.html @@ -15,13 +15,13 @@ - +

                                                                                  Create a New Generator

                                                                                  Creating a new generator which will become a part of the officially supported generators in OpenAPI Generator is pretty simple. We've created a helper script to bootstrap the operation. Let's look at the files necessary to create a new generator, then an example of bootstrapping a generator using the new.sh script in the root of the repository.

                                                                                  Required Files​

                                                                                  The minimum set of files required to create a new generator are:

                                                                                  • A "Codegen" file
                                                                                    • exists under modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/
                                                                                    • defines language options
                                                                                    • defines framework options
                                                                                    • determines OpenAPI feature set
                                                                                    • extends the generation workflow
                                                                                  • SPI registration
                                                                                    • Above class must be referenced in modules/openapi-generator/src/main/resources/META-INF/services/org.openapitools.codegen.CodegenConfig
                                                                                    • Tells the generator that this class exists
                                                                                    • Allows for classpath extension (addition) of generators
                                                                                  • A minimal template
                                                                                    • Should include a README explaining usage
                                                                                    • Must include an api.mustache
                                                                                    • Exists under modules/openapi-generator/src/main/resources/ (plus embeddedTemplate dir value, see below)
                                                                                  • Config file under ./bin/configs
                                                                                    • Gives users a "real life" example of generated output
                                                                                    • Samples are used by CI to verify generators and test for regressions in some cases

                                                                                  Now, let's generate an example generator and then walk through the pieces. At the end, we'll touch on some known sticking points for new generator authors and provide some suggestions.

                                                                                  new.sh​

                                                                                  The new.sh script in the root of the project is meant to simplify this process. Run ./new.sh --help.

                                                                                  Stubs out files for new generators

                                                                                  Usage:
                                                                                  ./new.sh [options]
                                                                                      Options:
                                                                                      -n  Required. Specify generator name, should be kebab-cased.
                                                                                      -c  Create a client generator
                                                                                      -s  Create a server generator
                                                                                      -d  Create a documentation generator
                                                                                      -H  Create a schema generator
                                                                                      -f  Create a config generator
                                                                                      -t  When specified, creates test file(s) for the generator.
                                                                                      -h  Display help.

                                                                                  Examples:
                                                                                    Create a server generator for ktor:
                                                                                    ./new.sh -n kotlin -s

                                                                                      Creates:
                                                                                      modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinServerCodegen.java
                                                                                      modules/openapi-generator/src/main/resources/kotlin-server/README.mustache
                                                                                      modules/openapi-generator/src/main/resources/kotlin-server/model.mustache
                                                                                      modules/openapi-generator/src/main/resources/kotlin-server/api.mustache
                                                                                      bin/configs/kotlin-server-petstore-new.yaml

                                                                                    Create a generic C# server generator:
                                                                                    ./new.sh -n csharp -s -t
                                                                                      Creates:
                                                                                      modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CsharpServerCodegen.java
                                                                                      modules/openapi-generator/src/main/resources/csharp-server/README.mustache
                                                                                      modules/openapi-generator/src/main/resources/csharp-server/model.mustache
                                                                                      modules/openapi-generator/src/main/resources/csharp-server/api.mustache
                                                                                      bin/configs/csharp-server-petstore-new.yaml
                                                                                      modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenTest.java
                                                                                      modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenModelTest.java
                                                                                      modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenOptionsTest.java
                                                                                      modules/openapi-generator/src/test/java/org/openapitools/codegen/options/CsharpServerCodegenOptionsProvider.java

                                                                                  This script allows us to define a client, server, schema, or documentation generator. We'll focus on the simplest generator (documentation). The other generator types may require heavy extension of the "Config" base class, and these docs could very quickly become outdated. When creating a new generator, please review existing generators as a guideline for implementation.

                                                                                  Create a new Markdown generator, specifying CommonMark as the name to avoid conflicting with the built-in Markdown generator.

                                                                                  ./new.sh -n common-mark -d

                                                                                  You should see output similar to the following:

                                                                                  Creating modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CommonMarkDocumentationCodegen.java
                                                                                  Creating modules/openapi-generator/src/main/resources/common-mark-documentation/README.mustache
                                                                                  Creating modules/openapi-generator/src/main/resources/common-mark-documentation/model.mustache
                                                                                  Creating modules/openapi-generator/src/main/resources/common-mark-documentation/api.mustache
                                                                                  Creating bin/configs/common-mark-documentation-petstore-new.yaml
                                                                                  Finished.

                                                                                  Review Generated Config​

                                                                                  Beginning with the "Codegen" file (CommonMarkDocumentationCodegen.java), the constructor was created:

                                                                                      public CommonMarkDocumentationCodegen() {
                                                                                          super();

                                                                                          outputFolder = "generated-code" + File.separator + "common-mark";
                                                                                          modelTemplateFiles.put("model.mustache", ".zz");
                                                                                          apiTemplateFiles.put("api.mustache", ".zz");
                                                                                          embeddedTemplateDir = templateDir = "common-mark-documentation";
                                                                                          apiPackage = File.separator + "Apis";
                                                                                          modelPackage = File.separator + "Models";
                                                                                          supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
                                                                                          // TODO: Fill this out.
                                                                                      }

                                                                                  These options are some defaults which may require updating. Let's look line-by-line at the config.

                                                                                  outputFolder = "generated-code" + File.separator + "common-mark";

                                                                                  This is the default output location. This will be generated-code/common-mark on non-Windows machines and generated-code\common-mark on Windows. You may change this to any value you'd like, but a user will almost always provide an output directory.

                                                                                  When joining paths, always use File.separator

                                                                                   modelTemplateFiles.put("model.mustache", ".zz");

                                                                                  The model.mustache file is registered as the template for model generation. The new.sh script doesn't have a way to know your intended file extension, so we default to a .zz extension. This must be changed (unless your generator's target extension is .zz). For this example, you'd change .zz to .md or .markdown, depending on your preference.

                                                                                  This model template registration will use model.mustache to generate a new file for every model defined in your API's specification document.

                                                                                  The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).

                                                                                  apiTemplateFiles.put("api.mustache", ".zz");

                                                                                  This is the template used for generating API related files. Similar to the above model template, you'll want to change .zz to .md or .markdown.

                                                                                  The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).

                                                                                  embeddedTemplateDir = templateDir = "common-mark-documentation";

                                                                                  This line sets the embedded and template directories to common-mark-documentation. The embeddedTemplateDir refers to the directory which will exist under modules/openapi-generator/src/main/resources and will be published with every release in which your new generator is present.

                                                                                  The templateDir variable refers to the "current" template directory setting, as defined by the user. That is, the user may invoke with -t or --template-directory (or plugin option variants), and override this directory.

                                                                                  Both of these variables exist because the generator will fallback to files under embeddedTemplateDir if they are not defined in the user's custom template directory.

                                                                                  apiPackage = "Apis";

                                                                                  This sets the "package" location for anything considered an API document. You might want to change this setting if, for instance, your language doesn't support uppercase letters in the path. We don't need to worry about that here.

                                                                                  Every templated output from api.mustache (registered via apiTemplateFiles above) will end up in the directory defined by apiPackage here.

                                                                                  modelPackage = "Models";

                                                                                  Similarly, this sets the package for Models.

                                                                                  Every templated output from model.mustache (registered via modelTemplateFiles above) will end up in the directory defined by modelPackage here.

                                                                                  supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));

                                                                                  A "supporting file" is an extra file which isn't created once for every operation or model defined in your specification document. It is a single file which may or may not be templated (determined by the extension of the filename).

                                                                                  A supporting file only passes through the Mustache template processor if the filename ends in .mustache.

                                                                                  The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).

                                                                                  If you want your readme to be generic (not templated), just rename the file to README.md and change README.mustache to README.md above.

                                                                                  Create templates​

                                                                                  The new.sh created our three required files. Let's start filling out each of these files.

                                                                                  README.mustache​

                                                                                  # Documentation for {{appName}}

                                                                                  {{#generateApiDocs}}
                                                                                  <a id="documentation-for-api-endpoints"></a>
                                                                                  ## Documentation for API Endpoints

                                                                                  All URIs are relative to *{{{basePath}}}*

                                                                                  Class | Method | HTTP request | Description
                                                                                  ------------ | ------------- | ------------- | -------------
                                                                                  {{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**](Apis/{{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{{summary}}}{{/summary}}
                                                                                  {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
                                                                                  {{/generateApiDocs}}

                                                                                  {{#generateModelDocs}}
                                                                                  <a id="documentation-for-models"></a>
                                                                                  ## Documentation for Models

                                                                                  {{#modelPackage}}
                                                                                  {{#models}}{{#model}} - [{{{modelPackage}}}.{{{classname}}}](Models/{{modelDocPath}}{{{classname}}}.md)
                                                                                  {{/model}}{{/models}}
                                                                                  {{/modelPackage}}
                                                                                  {{^modelPackage}}
                                                                                  No model defined in this package
                                                                                  {{/modelPackage}}
                                                                                  {{/generateModelDocs}}

                                                                                  <a id="documentation-for-authorization"></a>{{! TODO: optional documentation for authorization? }}
                                                                                  ## Documentation for Authorization

                                                                                  {{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
                                                                                  {{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
                                                                                  {{#authMethods}}
                                                                                  <a id="{{name}}"></a>
                                                                                  ### {{name}}

                                                                                  {{#isApiKey}}- **Type**: API key
                                                                                  - **API key parameter name**: {{keyParamName}}
                                                                                  - **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
                                                                                  {{/isApiKey}}
                                                                                  {{#isBasicBasic}}- **Type**: HTTP basic authentication
                                                                                  {{/isBasicBasic}}
                                                                                  {{#isBasicBearer}}- **Type**: HTTP Bearer Token authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}
                                                                                  {{/isBasicBearer}}
                                                                                  {{#isHttpSignature}}- **Type**: HTTP signature authentication
                                                                                  {{/isHttpSignature}}
                                                                                  {{#isOAuth}}- **Type**: OAuth
                                                                                  - **Flow**: {{flow}}
                                                                                  - **Authorization URL**: {{authorizationUrl}}
                                                                                  - **Scopes**: {{^scopes}}N/A{{/scopes}}
                                                                                  {{#scopes}}  - {{scope}}: {{description}}
                                                                                  {{/scopes}}
                                                                                  {{/isOAuth}}
                                                                                  {{#isOpenId}}- **Type**: OpenIDConnect
                                                                                  - **Connect URL**: {{{openIdConnectUrl}}}
                                                                                  - **Bearer Format**: {{{bearerFormat}}}
                                                                                  {{/isOpenId}}

                                                                                  {{/authMethods}}

                                                                                  Let's not focus too much on the contents of this file. You may refer to templating for more details on the variables bound to these files and to debugging how to debug the structures. Of note here is that we're generating structures in markdown as defined by the objects constructed by our new "Config" class.

                                                                                  api.mustache​

                                                                                  The API documentation might look like this:

                                                                                  # {{classname}}{{#description}}
                                                                                  {{description}}{{/description}}

                                                                                  All URIs are relative to *{{basePath}}*

                                                                                  Method | HTTP request | Description
                                                                                  ------------- | ------------- | -------------
                                                                                  {{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
                                                                                  {{/operation}}{{/operations}}

                                                                                  {{#operations}}
                                                                                  {{#operation}}
                                                                                  <a id="{{operationId}}"></a>
                                                                                  # **{{operationId}}**
                                                                                  > {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}({{#allParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/allParams}})

                                                                                  {{summary}}{{#notes}}

                                                                                  {{notes}}{{/notes}}

                                                                                  ### Parameters
                                                                                  {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
                                                                                  Name | Type | Description  | Notes
                                                                                  ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}
                                                                                  {{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}{{#generateModelDocs}}[**{{dataType}}**]({{baseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{dataType}}**{{/generateModelDocs}}{{/isFile}}{{/isPrimitiveType}}| {{description}} |{{^required}} [optional]{{/required}}{{#defaultValue}} [default to {{defaultValue}}]{{/defaultValue}}{{#allowableValues}} [enum: {{#values}}{{{.}}}{{^-last}}, {{/-last}}{{/values}}]{{/allowableValues}}
                                                                                  {{/allParams}}

                                                                                  ### Return type

                                                                                  {{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}{{#generateModelDocs}}[**{{returnType}}**]({{returnBaseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{returnType}}**{{/generateModelDocs}}{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}null (empty response body){{/returnType}}

                                                                                  ### Authorization

                                                                                  {{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{name}}](../README.md#{{name}}){{^-last}}, {{/-last}}{{/authMethods}}

                                                                                  ### HTTP request headers

                                                                                   - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
                                                                                   - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}}

                                                                                  {{/operation}}
                                                                                  {{/operations}}

                                                                                  model.mustache​

                                                                                  The models file could resemble the following.

                                                                                  {{#models}}
                                                                                  {{#model}}
                                                                                  # {{{packageName}}}.{{modelPackage}}.{{{classname}}}
                                                                                  ## Properties

                                                                                  Name | Type | Description | Notes
                                                                                  ------------ | ------------- | ------------- | -------------
                                                                                  {{#parent}}
                                                                                  {{#parentVars}}
                                                                                  **{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
                                                                                  {{/parentVars}}
                                                                                  {{/parent}}
                                                                                  {{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
                                                                                  {{/vars}}

                                                                                  [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

                                                                                  {{/model}}
                                                                                  {{/models}}

                                                                                  Build it​

                                                                                  To compile quickly to test this out, you can run mvn clean package -DskipTests.

                                                                                  When implementing a more robust generator, you'll want to run all tests as well: mvn clean package

                                                                                  Compile Sample​

                                                                                  The new.sh script created the generation config file bin/configs/common-mark-documentation-petstore-new.yaml:

                                                                                  generatorName: common-mark
                                                                                  outputDir: samples/documentation/petstore/common/mark
                                                                                  inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
                                                                                  templateDir: modules/openapi-generator/src/main/resources/common-mark
                                                                                  additionalProperties:
                                                                                    hideGenerationTimestamp: "true"

                                                                                  This configuration file is passed to the generator's CLI tool during continuous integration builds, and many outputs are compiled and tested as a regression test on every build. Contributors are also asked to run ./bin/utils/ensure-up-to-date before opening a pull request to regenerate all samples defined under ./bin/configs. This allows maintainers to quickly verify whether changes impact other generators.

                                                                                  Configuration based examples allow us to test the same samples in each tooling option (CLI, Gradle Plugin, Maven Plugin, etc.).

                                                                                  You can compile your generator by running:

                                                                                  ./bin/generate-samples.sh bin/configs/common-mark-documentation-petstore-new.yaml

                                                                                  This configuration file can be used to demonstrate the default options for generation. A common option in most of these configs is to define the template directory as the generator's directory under resources. This allows template maintainers to modify and test out template changes which don't require recompilation of the entire project. You'd still need to recompile the project in full if you add or modify behaviors to the generator (such as adding a CliOption).

                                                                                  Verify output​

                                                                                  Creating a new generator will be an iterative task. Once you've generated the sample, you'll want to try it out. For compiled client/server outputs, this would mean running the code or creating a small sample project to consume your artifact just to make sure it works.

                                                                                  For markdown, you can open in Visual Studio Code or any other editor with a markdown preview. Not all editors support relative links to other markdown documents. To test the output in this guide, install markserv:

                                                                                  npm install --global markserv

                                                                                  Now, you can serve the output directory directly and test your links:

                                                                                  markserv samples/documentation/petstore/common/markdown

                                                                                  That's it! You've created your first generator!

                                                                                  - + \ No newline at end of file diff --git a/docs/online/index.html b/docs/online/index.html index ee7082db195..b4496387ad4 100644 --- a/docs/online/index.html +++ b/docs/online/index.html @@ -15,14 +15,14 @@ - +

                                                                                  Online

                                                                                  Hosted​

                                                                                  We offer online services, publicly and free of charge:

                                                                                  Hosting Sponsor
                                                                                  Linode Logo

                                                                                  These services are beta and do not have any guarantee on service level

                                                                                  Docker Image​

                                                                                  The openapi-generator-online Docker image can act as a self-hosted web application and API for generating code. This container can be incorporated into a CI pipeline, and requires at least two HTTP requests and some docker orchestration to access generated code.

                                                                                  Example usage:

                                                                                  # Start container at port 8888 and save the container id
                                                                                  CID=$(docker run -d -p 8888:8080 openapitools/openapi-generator-online)

                                                                                  # allow for startup
                                                                                  sleep 10

                                                                                  # Get the IP of the running container (optional)
                                                                                  GEN_IP=$(docker inspect --format '{{.NetworkSettings.IPAddress}}'  ${CID})

                                                                                  # Execute an HTTP request to generate a Ruby client
                                                                                  curl -X POST --header 'Content-Type: application/json' \
                                                                                    --header 'Accept: application/json' \
                                                                                    -d '{"openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml"}' \
                                                                                    'http://localhost:8888/api/gen/clients/ruby'

                                                                                  # Example output:
                                                                                  # {"code":"c2d483.3.4672-40e9-91df-b9ffd18d22b8","link":"http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8"}

                                                                                  # Download the generated zip file  (using "code" provided from your output) 
                                                                                  wget http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8

                                                                                  # Unzip the file
                                                                                  unzip c2d483.3.4672-40e9-91df-b9ffd18d22b8

                                                                                  # Shutdown the openapi generator image
                                                                                  docker stop ${CID} && docker rm ${CID}

                                                                                  Local/Self-hosting​

                                                                                  If you prefer to run the service locally, here are the steps:

                                                                                  mvn clean install
                                                                                  cd modules/openapi-generator-online
                                                                                  mvn spring-boot:run

                                                                                  The online openapi-generator can be run via Docker as well.

                                                                                  For example, to generate Ruby API client, simply send the following HTTP request using curl:

                                                                                  curl -X POST -H "content-type:application/json" -d '{"openAPIUrl":"https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml"}' \
                                                                                      http://localhost:8080/api/gen/clients/ruby

                                                                                  Then you will receive a JSON response with the URL to download the zipped code.

                                                                                  To customize the SDK, you can POST to http://localhost:8080/gen/clients/{generator} with the following HTTP body:

                                                                                  {
                                                                                    "options": {},
                                                                                    "openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml"
                                                                                  }

                                                                                  Here, the options for a language can be obtained by submitting a GET request to http://locahost:8080/api/gen/clients/{generator}:

                                                                                  For example, curl http://localhost:8080/api/gen/clients/python returns

                                                                                    "packageName":{
                                                                                      "opt":"packageName",
                                                                                      "description":"python package name (convention: snake_case).",
                                                                                      "type":"string",
                                                                                      "default":"openapi_client"
                                                                                    },
                                                                                    "packageVersion":{
                                                                                      "opt":"packageVersion",
                                                                                      "description":"python package version.",
                                                                                      "type":"string",
                                                                                      "default":"1.0.0"
                                                                                    },
                                                                                    "sortParamsByRequiredFlag":{
                                                                                      "opt":"sortParamsByRequiredFlag",
                                                                                      "description":"Sort method arguments to place required parameters before optional parameters.",
                                                                                      "type":"boolean",
                                                                                      "default":"true"
                                                                                    }

                                                                                  {}

                                                                                  To set package name to pet_store, the HTTP body of the request is as follows:

                                                                                  {
                                                                                    "options": {
                                                                                      "packageName": "pet_store"
                                                                                    },
                                                                                    "openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml"
                                                                                  }

                                                                                  and here is the curl command:

                                                                                  curl -H "Content-type: application/json" \
                                                                                      -X POST \
                                                                                      -d '{"options": {"packageName": "pet_store"},"openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml"}' \
                                                                                      http://localhost:8080/api/gen/clients/python

                                                                                  Instead of using openAPIUrl with a URL to the OpenAPI spec, one can include the spec in the JSON payload with spec:

                                                                                  {
                                                                                    "options": {},
                                                                                    "spec": {
                                                                                      "swagger": "2.0",
                                                                                      "info": {
                                                                                        "version": "1.0.0",
                                                                                        "title": "Test API"
                                                                                      },
                                                                                      ...
                                                                                    }
                                                                                  }
                                                                                  - + \ No newline at end of file diff --git a/docs/plugins/index.html b/docs/plugins/index.html index 8c92b49a663..aecdb673de5 100644 --- a/docs/plugins/index.html +++ b/docs/plugins/index.html @@ -15,13 +15,13 @@ - +

                                                                                  Plugins

                                                                                  Maven​

                                                                                  A Maven plugin to support the OpenAPI generator project

                                                                                  Example​

                                                                                  Add to your build->plugins section (default phase is generate-sources phase)

                                                                                  <plugin>
                                                                                      <groupId>org.openapitools</groupId>
                                                                                      <artifactId>openapi-generator-maven-plugin</artifactId>
                                                                                      <version>7.9.0</version>
                                                                                      <executions>
                                                                                          <execution>
                                                                                              <goals>
                                                                                                  <goal>generate</goal>
                                                                                              </goals>
                                                                                              <configuration>
                                                                                                  <inputSpec>${project.basedir}/src/main/resources/api.yaml</inputSpec>
                                                                                                  <generatorName>java</generatorName>
                                                                                                  <configOptions>
                                                                                                     <sourceFolder>src/gen/java/main</sourceFolder>
                                                                                                  </configOptions>
                                                                                              </configuration>
                                                                                          </execution>
                                                                                      </executions>
                                                                                  </plugin>

                                                                                  Followed by:

                                                                                  mvn clean compile

                                                                                  For full details of all options, see the plugin README.

                                                                                  Dependencies​

                                                                                  The generated models use commonly used Swagger v2 annotations like @ApiModelProperty. A user may add Swagger v3 annotations:

                                                                                  <dependency>
                                                                                      <groupId>io.swagger.core.v3</groupId>
                                                                                      <artifactId>swagger-annotations</artifactId>
                                                                                  </dependency>

                                                                                  But this will not work. This dependency is not binary compatible with Swagger v2 annotations. The resulting code will fail to compile.

                                                                                  As alternative instead use the following dependency:

                                                                                  <dependency>
                                                                                      <groupId>io.swagger.parser.v3</groupId>
                                                                                      <artifactId>swagger-parser</artifactId>
                                                                                  </dependency>

                                                                                  Gradle​

                                                                                  This gradle plugin offers a declarative DSL via extensions (these are Gradle project extensions). These map almost fully 1:1 with the options you’d pass to the CLI or Maven plugin. The plugin maps the extensions to a task of the same name to provide a clean API. If you’re interested in the extension/task mapping concept from a high-level, you can check out Gradle’s docs.

                                                                                  To include in your project, add the following to build.gradle:

                                                                                  buildscript {
                                                                                    repositories {
                                                                                      mavenLocal()
                                                                                      mavenCentral()
                                                                                    }
                                                                                    dependencies {
                                                                                      classpath "org.openapitools:openapi-generator-gradle-plugin:6.6.0"
                                                                                    }
                                                                                  }

                                                                                  apply plugin: 'org.openapi.generator'

                                                                                  This gives access to the following tasks:

                                                                                  TaskDescription
                                                                                  openApiGenerateGenerate code via Open API Tools Generator for Open API 2.0 or 3.x specification documents.
                                                                                  openApiGeneratorsLists generators available via Open API Generators.
                                                                                  openApiMetaGenerates a new generator to be consumed via Open API Generator.
                                                                                  openApiValidateValidates an Open API 2.0 or 3.x specification document.

                                                                                  The plugin implements the above tasks as project extensions of the same name. If you’d like to declare these tasks as dependencies to other tasks (using dependsOn), you’ll need a task reference. e.g.:

                                                                                  compileJava.dependsOn tasks.named("openApiGenerate")

                                                                                  For full details of all options, see the plugin README.

                                                                                  Example​

                                                                                  An example openApiGenerate task configuration for generating a kotlin client:

                                                                                  openApiGenerate {
                                                                                      generatorName.set("kotlin")
                                                                                      inputSpec.set("$rootDir/specs/petstore-v3.0.yaml")
                                                                                      outputDir.set("$buildDir/generated")
                                                                                      apiPackage.set("org.openapi.example.api")
                                                                                      invokerPackage.set("org.openapi.example.invoker")
                                                                                      modelPackage.set("org.openapi.example.model")
                                                                                      configOptions.set([
                                                                                          dateLibrary: "java8"
                                                                                      ])
                                                                                  }

                                                                                  If you want to create separate tasks (for example when you have more than one api spec and require different parameters for each), this is how to do so in Gradle 7+: tasks.register('taskName', org.openapitools.generator.gradle.plugin.tasks.GenerateTask) { ... }.

                                                                                  - + \ No newline at end of file diff --git a/docs/release-3-0-0/index.html b/docs/release-3-0-0/index.html index c580256823b..512f038d164 100644 --- a/docs/release-3-0-0/index.html +++ b/docs/release-3-0-0/index.html @@ -15,13 +15,13 @@ - +

                                                                                  Release Notes: 3.0.0

                                                                                  • Docker​

                                                                                  • 7dfd94002 Docker: use correct MAVEN_CONFIG (#182)

                                                                                  • b5a0d173d Revise the usage of OpenAPI Generator online (docker image) (#73)

                                                                                  • e58dc2c77 Fix COPY in Dockerfile (#64)

                                                                                  • 9d7feaaeb Fix online generator (docker push) (#58)

                                                                                  • 9247cd01e Changes for Docker

                                                                                  • 64037ee59 update docker-related files to ues jdk8

                                                                                  • Plug-ins​

                                                                                  • b6b8c0db8 [gradle-plugin] Initial implementation (#162)

                                                                                  • 0a28aad73 [MAVEN PLUGIN] Checking for null configOptions before looking for property

                                                                                  • 9c79297d6 [MAVEN PLUGIN] Use latest version in dependencies snippet

                                                                                  • 9e1bbe0c1 Add maven wrapper

                                                                                  • API Clients​

                                                                                  • Ada​

                                                                                  • edf6be8c0 [Ada] bug fix by defining x-is-model-type when property is local to the YML file

                                                                                  • 9ba74f484 [Ada] Fix GNAT project and server skeleton to avoid sending a response when an error is returned

                                                                                  • ea27924f5 [Ada] changed default project/package name, to solve circular dependencies

                                                                                  • 6b9d38d40 remove trailing spaces in ada template

                                                                                  • 0de7f972f Fix the Ada server skeleton to check the authsMethods in the Shared_Instance generic package

                                                                                  • 4bd8fc6e8 Fix 7511: [Ada] Client call is not correct with multiple parameters and application/x-www-urlencoded

                                                                                  • 3035bc629 [Ada] Hotfix/ada model sort

                                                                                  • 43f0e8692 Ada code generator corrected: "=>" instead of "->".

                                                                                  • 7d2b49085 [Ada] wrong order for generated structures in models.ads files

                                                                                  • 2b2b85eec [Ada] wrong JSON in POST operations

                                                                                  • C#​

                                                                                  • 0e34bcf4e [csharp] ctor params should always be camelCase

                                                                                  • 872471996 [csharp] Support arrays of arrays for properties and models

                                                                                  • 1c4e6b7d4 [csharp] Fix ToJson to work with composition and polymorphism

                                                                                  • ed7af73f6 [csharp] Reference this.Configuration in client API template

                                                                                  • C++​

                                                                                  • e796e4c36 [C++] Add linux as a reserve keyword

                                                                                  • 36f69a034 remove trailing spaces in qt5 c++ templates

                                                                                  • f192613f1 fix string type in c++ generator

                                                                                  • 409015461 fix file type in qt5cpp

                                                                                  • a4bcb3bc7 fix datetime and map type for qt5cpp

                                                                                  • 23b31aba8 [qt5cpp] Fix crash when API return a map container

                                                                                  • 3b031ed2b [qt5cpp] delete callback data allocated before signal emission

                                                                                  • 1bb1e44d1 [qt5cpp] Remove qt5 pro.user file

                                                                                  • 194722015 Qt5cpp plug memleaks part2

                                                                                  • 12f3661d6 Qt5cpp plug memleaks

                                                                                  • ea4b94842 [qt5cpp] Add nullptr guard to prevent crash when empty model is being serialized

                                                                                  • 0bf430a80 Qt5cpp Add support for nested containers

                                                                                  • 0b3ec6b1f fix NPE with cpp qt5, add logic to avoid NPE with composed schema

                                                                                  • 7c734445b fix file parameter in header file (cpprest)

                                                                                  • 070b5c00b fix object type declaration in cpprest

                                                                                  • bad1885b4 [cpprest] add parameterToString for number type with unspecified format (double)

                                                                                  • 73bd24db7 [cpprest] Add support for nested vectors

                                                                                  • ee2eb74f7 [qt] update Qt client

                                                                                  • d82499944 Adding qt project generation fix

                                                                                  • 9bd94b4db [qt] Fix warning message

                                                                                  • Clojure​

                                                                                  • d7e374504 [Clojure] Add util method to set the api-context globally (#93)

                                                                                  • Dart​

                                                                                  • f1638a659 [Dart] Allow setting an accessToken for OAuth

                                                                                  • a5e26a44f [Dart] - Rework Dart client generator to be flutter-compatible

                                                                                  • Elixir​

                                                                                  • f9b2839a3 [Elixir] Check date value before calling to_iso8601

                                                                                  • Elm​

                                                                                  • 5a87fe695 [elm] Fix operations with empty responses (#171)

                                                                                  • a5cf27b60 Fix Petstore example for Elm (#96)

                                                                                  • c522927d5 Fix Elm generator for polymorphism (#78)

                                                                                  • 7d9fb9f51 Add CI test for Elm in travis (#40)

                                                                                  • 769a65c95 [Elm] Add support for array schemas

                                                                                  • 56a0268e3 [elm] missing '->' in Main elm template

                                                                                  • Erlang​

                                                                                  • c73118524 [erlang-client] Erlang request utils

                                                                                  • 049eef9c5 Test erlang client, server petstore

                                                                                  • bcc7b788e fix erlang client compilation error

                                                                                  • Go​

                                                                                  • acb63fd5e Fix go readme, remove resty install

                                                                                  • 5d8362d85 Update go client, fix double body read

                                                                                  • 47614bb76 Properly capitalize exported go types

                                                                                  • ee561fcd6 Add withXml option for Go language

                                                                                  • 0f6696089 [Go] Use consistent indentation in readme

                                                                                  • 72abb20f2 [Go] Fix operation files clobbering model files. [2.4.0]

                                                                                  • Haskell​

                                                                                  • 34db79b9b [haskell-http-client] update dependency versions + readme (#81)

                                                                                  • e45b3784f Fix NPE with Haskell client generator with OAS3 spec

                                                                                  • d3401396f [haskell-http-client] remove duplicates in produces/consumes; fix pathParam paramName issue

                                                                                  • 4bc99b9da minor fixes to haskell http client generator

                                                                                  • 2d0bafb6b [haskell-http-client] default InlineMimeTypes=true

                                                                                  • 9fba9c325 [haskell-http-client] add config options: cabalPackage, cabalVersion, baseModule, requestType, configType

                                                                                  • Kotlin​

                                                                                  • a3322fbf7 [kotlin] Add OkHttpClient.Builder to ApiClient.

                                                                                  • 3c5fb1d80 [kotlin] Add json annotation to each enum value.

                                                                                  • 39fa375e3 [kotlin] Fix NPE for POST/PUT/PATCH with empty request models.

                                                                                  • c599906f1 Kotlin: Correct data_class.mustache to use proper property for inner enum data type

                                                                                  • c69925b53 [Kotlin] Fix issues with threetenbp

                                                                                  • a811a48c3 minor fix to kotlin client generator due to merge conflict

                                                                                  • 914275fe7 [kotlin] support selection of datelibrary

                                                                                  • a61d23265 Fixed incorrect renaming of header and query param to camel cases for Kotlin Client template

                                                                                  • Lua​

                                                                                  • dbe78e23e [Lua] Improve auto-generated test files

                                                                                  • 6c79052ac Add auto-generated Lua spec files for APIs, models

                                                                                  • 38a2c1dde [Lua] Fix Rockpec

                                                                                  • a2410b210 Add auto-generated rockspec file to Lua API client

                                                                                  • df10c725a Add lua test script, minor fix to Lua API files

                                                                                  • Java​

                                                                                  • 2e69e6c03 build.gradle should not have commas

                                                                                  • 1a4e5a4e5 Java client: Add constants for libraries (#163)

                                                                                  • 7db0201a8 Fix NPEs in Java generator (#154)

                                                                                  • 4d7ff8cfb JavaDoc fixes for Java/RESTEasy client (#151)

                                                                                  • 072ce070b resteasy: fix outer enum case (#139)

                                                                                  • ccd002966 [Java] rest-assured: fix javadoc in templates

                                                                                  • e7410d4c8 Allow $ in java var name

                                                                                  • 03490e923 Fix Java binary mapping

                                                                                  • 70b4b55fa Fix performance linting problem with maps in Java ApiClient template

                                                                                  • cddcda0fe [Java][Jersey2] Make generated client code thread safe

                                                                                  • 298ca8d35 use correct jackson date library when using Java 8

                                                                                  • 53eeb0c04 [Java] fix connection leak on retrofit OAuth token renewal

                                                                                  • 61c25e711 [Java] Fixes for retrofit

                                                                                  • f02332755 [JAVA] 4709: codegen with parcelableMode fails to build if using arrays in swagger.

                                                                                  • 4eeb974cb [Java][google-api-client] Fix bug with empty POST request not sending content-type

                                                                                  • d4543a99e [Java][retrofit2] file upload sets filename as baseName instead of a dynamic filename

                                                                                  • 62a930223 [JAVA][Rest-assured] reqSpec() method has been added into api.mustache for requests custom…

                                                                                  • fec0363f7 [Java] Add back byte array enhancement

                                                                                  • 59ff4c198 [Java][library: vertx] Add default value and required parameter support to vertx server temp…

                                                                                  • 3bd2da9a8 [Java] Fix build warnings

                                                                                  • 429b96ae7 [JAVA] equals and hashCode for models with byte[] and binary strings

                                                                                  • 495971c2c [Java] use html entities in javadoc of generated code (#106)

                                                                                  • 82ee8656f [java] Enum in array of array (#66)

                                                                                  • bf7e4e7df Java gson: add @SerializedName value as constant (#22)

                                                                                  • 30c1448d7 Fix build.gradle for Java RESTEasy client

                                                                                  • 642c0566d [Java] Use Rx2 Completable for Void Retrofit2 responses

                                                                                  • 72221b1cf Adding @Deprecated to retrofit2 client interfaces.

                                                                                  • 47111b324 [Java] fix gson deserialize format byte

                                                                                  • 9e06f7063 [Java] Fix assignment of new object instance to variable

                                                                                  • 006f084b5 [Java] Allow to set values with setApiPackage(..) and setModelPackage(..)

                                                                                  • JavaScript/NodeJS​

                                                                                  • d80e29585 Fix JS test using baseName in default value (#5)

                                                                                  • fe15f4690 fix toDefaultValueWithParam in JS

                                                                                  • 90859575e Fixing variable name typo (instane -> instance)

                                                                                  • Objective-C​

                                                                                  • 9fb2c29a4 7644 objc deprecated afnetworking datataskwithrequest

                                                                                  • 5d1874028 add class as a keyword in objc generator

                                                                                  • 1b8df5c20 Update ObjcClientCodegen.java

                                                                                  • 246ed5754 restore objc reserved word: property

                                                                                  • PHP​

                                                                                  • 3beeb4e77 [PHP] Not-required properties now shows as nullable (#129)

                                                                                  • 37df59d6f [PHP] Adjust the names (script, sample folder, generator) to lang option (#159)

                                                                                  • 4a5d16b23 [PHP] Fix string length validation

                                                                                  • d58835e57 [PHP] Improve: Make validation strict

                                                                                  • cf8d8d56f [PHP] Fix code example from README. Variable name was missing when using Basic auth.

                                                                                  • 0adbf7e51 [PHP] Improve: update sample tests automatically

                                                                                  • 32cf2f16f [PHP] Non required enum property

                                                                                  • 3bcf0ff76 [PHP] Add path & file separator (/) to return the correct path when deserializing a file

                                                                                  • 14e1e1980 [PHP] Improve validation on empty arrays

                                                                                  • 809e1f4c9 [PHP] Cleanup tests

                                                                                  • 76907cacd [PHP] declare property headerSelector

                                                                                  • Python​

                                                                                  • 7184f1ec6 [python] asyncio supports _preload_content; remove unused imports (#107)

                                                                                  • d74d2ba03 fix: python clients

                                                                                  • 8e0a0ebd6 Fix python / tornado body handling

                                                                                  • b39c35c76 Fix inconsistency between model name and file name in python client

                                                                                  • dfbef4374 Fixed unicode error and supported allow_nonstandard_methods in tornado based python client

                                                                                  • f6e0e297e [python-asyncio] tests and fixes

                                                                                  • R​

                                                                                  • 61e58d649 Add R namespace file

                                                                                  • Ruby​

                                                                                  • a08164592 fix ruby parameters in documentation, fix requiredParams, optionalParams

                                                                                  • 8e34f9a98 update to newer version of ruby

                                                                                  • aa6b217bb [Ruby] Add auto-generated rubocop config file

                                                                                  • Rust​

                                                                                  • b44357394 [Rust] Implement minimal auth support

                                                                                  • 0b845a57e [Rust] Changes hard coded body to dynamic parameter name -

                                                                                  • a3c97753f [Rust] Handles UUID as string

                                                                                  • 027df610b [Rust] Handle error response statuses

                                                                                  • 66be7a791 [Rust] Add user agent handling for rust template (master)

                                                                                  • 3029b7b0f [Rust] Format example with rustfmt

                                                                                  • Scala​

                                                                                  • 197b4481e normalize akka-scala and Java README

                                                                                  • 612cfb7af [Akka-scala] Clean unused dependencies such swagger-core

                                                                                  • 86697fedb [Scala][Gatling] correct body params filename

                                                                                  • 832919b84 [Scala][Akka] Remove unused dep when model package is empty

                                                                                  • Swift​

                                                                                  • 40d5d0990 [Swift4] accept empty content with default client

                                                                                  • 3b7230b17 [Swift 4] Fix APIHelper to accept array parameter

                                                                                  • e22faf4cd [Swift] Add public initializer for modelObject.

                                                                                  • b184fb1d9 [Swift3] escape URL parameters

                                                                                  • 52f606b8d Fix Swift3 test cases and add pom.xml, travis config for iOS test

                                                                                  • a3d0f1d4b Swift4: make generated models structs instead of classes

                                                                                  • TypeScript​

                                                                                  • f615d823f update ts node dependencies

                                                                                  • 9ac9bc0dc [TypeScript] enhance ts import

                                                                                  • 009dcf009 Mark not required swagger properties as optional typescript properties

                                                                                  • bdd2c2a4e Misc typescript Angular code generation improvements

                                                                                  • 260375c9e Fix typescript-node generation of array type models

                                                                                  • d1933b5fc Fix a problem in the generation of typescript-jquery when we have enum in a query param

                                                                                  • 20305139b [Feature][TypeScript] request param enum as literal unions

                                                                                  • 524f162e6 Use supportsES6 flag in ts compilation for language typescript-angular

                                                                                  • 9b8602311 [TypeScript] Make OpenAPI Generator serialize subclasses properly (#102)

                                                                                  • 4bc5ffe86 [typescript-angular] add provided in support (#120)

                                                                                  • ef832e715 [Feature][TS Angular] improve docs angular import

                                                                                  • fc7e08346 [TS][Fetch] Add interfaces option

                                                                                  • 157e6b7fa [angular] Add option to generate tagged unions

                                                                                  • 7faaa091c Fix generated module imports in Aurelia APIs

                                                                                  • b5f0b24ba [TS] fix object declaration in model

                                                                                  • API Servers​

                                                                                  • C++​

                                                                                  • 6fef0a7ff fix string issue with restbed generator

                                                                                  • a339422bd move get type declaration method to c++ restbed

                                                                                  • C#​

                                                                                  • d9d653016 [aspnetcore] Make the use of Swashbuckle optional (#110)

                                                                                  • 9a8183ab0 [aspnetcore] Fix openapi.json location rename (#56)

                                                                                  • 12abfb968 [aspnetcore] Update Dockerfile

                                                                                  • 866817587 [aspnetcore] Fix string enum generation

                                                                                  • Java​

                                                                                  • bd50d368e [JAVA - jaxrs-resteasy-eap] Add import to models (#179)

                                                                                  • 7efda597c Fix issue with useBeanValidation option in Java server generators (#160)

                                                                                  • 71b5de3ed Do not set contextPath for spring-boot (#104)

                                                                                  • b73ab0260 jaxrs-cxf-cdi: fix outer enum (#131)

                                                                                  • 4d7fc046f [JaxRS] Add "validation-api" dependency in jetty (#30)

                                                                                  • ce930e7a6 [Jaxrs-cxf] Add bean-level cascaded beanvalidation for pojos (@Valid)

                                                                                  • 386b9f432 Modify "postProcessOperations" for "jaxrs-cxf-client"

                                                                                  • 5d92717dc update jaxrs to listen at port 10080

                                                                                  • 7c2031675 update artifact id for jaxrs datelib j8

                                                                                  • 88c5112f2 Adds support for returning response in jaxrs-spec interfaces

                                                                                  • 6bf84d5fa [JAXRS-SPEC] Fix lowercase enums sent as uppercase

                                                                                  • 3a1922bc9 Fix version for "spring-boot-maven-plugin" (#85)

                                                                                  • 161948657 Add reactive option for Spring Boot (webflux)

                                                                                  • ff1178ad7 [Java][Spring] fix missing optional query params

                                                                                  • 2103fadab Fix package declaration for play-framework

                                                                                  • 2c6380c84 fix inner item (list, map) for play framework

                                                                                  • e33b350c8 Fix an issue in Play Framework generator where a CSV is empty and transferred to the controllerImp with an empty item.

                                                                                  • 99fc27246 [JAX-RS][Spec] Removes throws Exception.

                                                                                  • fe2a44339 Fixes issue (SpringCodeGen dateLibrary "java8-localdatetime" option is ignored).

                                                                                  • d890d733f [JaxRS][Java] issue with implFolder on windows, and required fields generation for containers (#88)

                                                                                  • c91ce17ae Feature/javaPlayWithAsynchronousControllers

                                                                                  • f00a1ef52 [JAVA] Correct consumes/produces attributes for Spring Controllers

                                                                                  • d14318cf2 [JAVA][Spring] Optional params with delegate

                                                                                  • 3f81378d7 [java resteasy] fix string comparison (#134)

                                                                                  • 5ea3d3bb1 [JAX-RS][SPEC] Bug fix that prevents generating interfaces when interfaceOnly is false.

                                                                                  • Kotlin​

                                                                                  • 7cad47dd3 [kotlin-server] --library=ktor (barebones implementation)

                                                                                  • 752b36e66 [Kotlin] Sanitize enumeration name to add underscore when it starts with digits (#77)

                                                                                  • NodeJS​

                                                                                  • 6d88d073c [NodeJS] make serverPort configurable via CLI option

                                                                                  • e7f4fb3c4 Fix nodejs-server path issue in windows platform

                                                                                  • PHP​

                                                                                  • d30fcbabb Fixes for php-ze-ph generator

                                                                                  • 60e3339aa [Feature][PHP] Update for ze-ph generator

                                                                                  • Python​

                                                                                  • 62b93fc5c [Python][Flask] Handles UUID format -

                                                                                  • 9999eac52 fix python flask parameter naming

                                                                                  • Scala​

                                                                                  • d5c355a59 [Scalatra] Updated the version of Scalatra to the latest (2.6.2)

                                                                                  • 52322c47c [finch] Allow finch server to compile for CI checks (#7)

                                                                                  • Ruby​

                                                                                  • dcad9ae80 [Rails5] make version of the generated Rails stub server to strict Rails 5.0

                                                                                  • Rust​

                                                                                  • 37faaf926 [rust-server] API version constant and composite version support

                                                                                  • 6c7813e79 [rust-server] asynchronous support via hyper v0.11

                                                                                  • Documentation​

                                                                                  • 25a6a9d44 html: fix typo in class name

                                                                                  • Miscellaneous​

                                                                                  • f04213285 Cli error message improvements (#172)
                                                                                  • 0ece706a4 Remove CodegenConfig.fromModel(String, Schema) method (#90)
                                                                                  • 64f2bea37 Fix getReferenced...() methods in ModelUtils (#157)
                                                                                  • 16ff5174e Update swagger-parser to 2.0.1 (#123)
                                                                                  • 76b7307a6 DefaultGenerator: ignore only form param schemas (#74)
                                                                                  • a3aabd390 Create a default implementation of delegate if none could be autowired (#92)
                                                                                  • ca89af808 Switch to Java 8
                                                                                  • 27426f7b5 Cli generator name option, replaces 'language' options in CLI and Maven Plugin (#57)
                                                                                  • a1ff50241 Rename datatype to dataType in CodegenProperty (#69)
                                                                                  • 3b9a2a7c3 CaseFormatLambda has been added, params for Rest-assured client has been refactored (#91)
                                                                                  • 488910362 Set parameters allowableValues dynamically (#65)
                                                                                  • 2821f18b9 Meta: set version for "build-helper-maven-plugin" (#89)
                                                                                  • 82d9e935e Add CORS configuration to openapi-generator-online (#71)
                                                                                  • e3814f51d Improvements to online codegen (#55)
                                                                                  • 6b8079808 Consider minLength, maxLength and pattern in referenced schema (#45)
                                                                                  • 7c5dfbfa0 Minor improvements to OpenAPI Generator Online (#54)
                                                                                  • 8dd46a3fb Move online gen from jersey to spring boot (#44)
                                                                                  • 803821e21 Fix an issue with example generator when array is too large (#46)
                                                                                  • 673f2bc46 Add CodegenProperty.nameInSnakeCase (#42)
                                                                                  • 67ebe17dd Fix isPrimitiveType flag for array of form parameters (#38)
                                                                                  • 10ac4024d Code clean-up: remove field declaration hiding existing fields (#35)
                                                                                  • ab9c4b5a6 Code clean-up: Add own private static final LOGGER in each class (#26)
                                                                                  • 41b0ff351 Code clean-up: remove DefaultCodegen#getSimpleRef(String) (#19)
                                                                                  • 13f084e7b Fix dataTypeWithEnum for array of form parameters
                                                                                  • fd3b883e8 [DefaultCodegen] Fill CodegenOperation::produces with unique media types
                                                                                  • db9a899a0 update getSchemaType variable, remove unused import
                                                                                  • d74b4cdf8 fix map type and collection format for form parameter (array)
                                                                                  • d99f46cff Revise how to obtain the example value
                                                                                  • b1eac05b2 Fix form datatype (array of string)
                                                                                  • 3c666a6d4 Fix array of form parameters
                                                                                  • 1492df6ce Override server port for Jetty configuration
                                                                                  • 622a75b2c Fix data type shadowing
                                                                                  • 861d11d01 use vendor extension in operation to set the body parameter name
                                                                                  • 80c8b92cb add postProcessParameter for body, form parameter
                                                                                  • 7fe555a51 Set collectionFormat default only for array
                                                                                  • 16589de97 default collection format to csv according to the spec
                                                                                  • edbe4902a Consider '$ref' for consumes and produces in CodegenOperation
                                                                                  • e24238a35 Improve getter name handling for boolean properties
                                                                                  • 6e2ca294b update discriminator to discriminatorName
                                                                                  • 74075c087 Primitive datatype in Schema components
                                                                                  • d8abd4a14 support map in body parameter
                                                                                  • 186594115 Update swagger-core to 2.0.1
                                                                                  • 2034f61e5 Add HideGenerationTimestamp getter and setter in the CodegenConfig interface
                                                                                  • d0e2d7684 Getter and Setter for hideGenerationTimestamp
                                                                                  • adbde2fb6 replace fromOperation with postProcessOperations
                                                                                  • 9d1ae0dd2 fix bigdecimal in default codegen
                                                                                  • ffa0e115d fix default value and type declaration
                                                                                  • 0e744adb8 Apply collection format to SIMPLE enum style
                                                                                  • 36ed29852 Tweak tests according to the parameter order changes
                                                                                  • 17b082793 Move 'enum_query_double' to parameters section
                                                                                  • 28fcf48f4 Add a method returns discriminator name
                                                                                  • 7daa2ec5d Fix broken discriminator
                                                                                  • faa901640 Replace with the helper function: getTypeDeclaration
                                                                                  • c8650d0e3 Make optional properties in models optional parameters
                                                                                  • 40c30dd2f Fix inputSpec for multi module builds
                                                                                  • 5326152cc add option to reorder form/body parameter
                                                                                  • d1850091a Improve JMeter Template
                                                                                  • fedfb0cda Factorize addOption/addSwitch method
                                                                                  • e73eeb4fd fix for stripping prefix on single enums
                                                                                  • 13e3db59e Add operationIdOriginal to store the original operationId
                                                                                  • 0b2d80569 Expose getter/setter for serverPort to facilitate testing
                                                                                  • 8e270f465 add vendorExtensions field in CodegenSecurity class
                                                                                  • 1ee85de94 Added Intelli J ignore
                                                                                  • 7b8e409cf Added gitignore generation function
                                                                                  - + \ No newline at end of file diff --git a/docs/release-summary/index.html b/docs/release-summary/index.html index 9f0b312b953..ae588c67730 100644 --- a/docs/release-summary/index.html +++ b/docs/release-summary/index.html @@ -15,13 +15,13 @@ - +

                                                                                  Release Summary

                                                                                  Versioning​

                                                                                  We version artifacts in the common major.minor.patch strategy.

                                                                                  We decided versions should be incremented according to the following rules. The examples provided below are not exhaustive.

                                                                                  PartBreaking Changes?RuleExamples
                                                                                  majorYESbreaking changes without fallback
                                                                                  • New Features
                                                                                  • Large refactors
                                                                                  • Removal of deprecated code
                                                                                  • Changes to coding interfaces
                                                                                  • Large changes to template bound variables
                                                                                  minorALLOWEDbreaking changes with fallback
                                                                                  • Adding new generator behavior which doesn't affect custom templates (or does, with config option for old behavior)
                                                                                  • Changing generator templates in a way in which switching to custom templates results in old behavior
                                                                                  • Introducing deprecated methods in generators or other shared code
                                                                                  patchNOnew features without breaking changes
                                                                                  • New generators
                                                                                  • Bug fixes in template or generators

                                                                                  Cadence​

                                                                                  For patch release (e.g. 3.0.5 to 3.0.6), we plan to do it on a weekly basis.

                                                                                  For minor release (e.g. 3.1.6 to 3.2.0), we plan to do it on a monthly basis.

                                                                                  For major releases (e.g. 3.3.6 to 4.0.0), we plan to do it on a quarterly basis.

                                                                                  - + \ No newline at end of file diff --git a/docs/roadmap/index.html b/docs/roadmap/index.html index bf4e4a438bf..a494af53ebc 100644 --- a/docs/roadmap/index.html +++ b/docs/roadmap/index.html @@ -15,13 +15,13 @@ - +

                                                                                  Roadmap

                                                                                  This document lists short-term, medium-term, and long-term goals for the project.

                                                                                  NOTE

                                                                                  These are goals, not necessarily commitments. The sections are not intended to represent exclusive focus during these terms. For example, when you start at a college or university you may have a long-term goal to graduate and a short-term goal to find a job for supplemental income. We will similarly work toward many of our medium-term and long-term goals in the near future as we move toward meeting our short-term goals.

                                                                                  Short-term​

                                                                                  Usability, stability, and marketing.

                                                                                  Short term are focused on improving contributor and user productivity (part of this is getting the word out).

                                                                                  • CLI improvements
                                                                                    • Search functionality (e.g. what generators support retrofit, what generators are available for kotlin)
                                                                                  • Build automation improvements
                                                                                  • Discuss consolidating current third-party build systems
                                                                                  • Investigate custom docker containerization for prepared build environments
                                                                                  • Automated release stability
                                                                                  • General
                                                                                  • OAS3.0 features support: anyOf, oneOf, callbacks, etc
                                                                                  • Consider opt-in telemetry about generators being used, limited to a counter of invocations by generator name. This would allow us to make prioritization decisions based on statistics.
                                                                                  • Code clean up
                                                                                  • Documentation
                                                                                  • Static pages, preferably on gh-pages, devoted to each generator
                                                                                  • Explain generator options
                                                                                  • Centralized docs on generated code usage/examples/configuration

                                                                                  Medium-term​

                                                                                  Feature set, well-defined API (code and templates), and extensibility improvements.

                                                                                  API​

                                                                                  • Typed representation of the model bound to our templates. As it is, everything is treated as an Object, and this can lead to changes in the interface which might be unexpected from the template perspective.
                                                                                  • Feature set (potential generators to add; not an exhaustive list)
                                                                                    • Azure functions (node.js, server)
                                                                                    • Finagle HTTP Client (Scala, client)
                                                                                    • Finagle Http Server (Scala, server)
                                                                                    • Finatra (Scala, server)
                                                                                    • Kotlin Spring MVC/Springboot (server)
                                                                                    • C++ Server, any framework (server)

                                                                                  General​

                                                                                  • Migrate from Maven to Gradle
                                                                                  • Java 9+ support
                                                                                  • Feature set (other options to investigate)
                                                                                  • SPI plugins
                                                                                    • Templating engine
                                                                                    • Language extensions
                                                                                    • Custom extensions (e.g. allowing users to load support for azure-rest-api-specs)
                                                                                  • Customizable templating engines (handlebars support)
                                                                                  • Unit-testing templates (to previously mentioned explicit type as an interface to the template)
                                                                                  • Reduce coupling
                                                                                  • Make types extending CodegenConfig become the generation entrypoint
                                                                                  • Allow current CodegenConfig types to define templating engine
                                                                                  • Allow current CodegenConfig types to modify workflow (currently encapsulated in DefaultGenerator and tightly coupled to the template engine
                                                                                  • Clearer reuse of "language" features, outside of "generator" types. That is, rather than enforcing polymorphic sharing of "language" which currently allows the super type to redefine framework-specific mapping functionality, generators could compose one or more language support types.
                                                                                  • Define template deprecation/removal process

                                                                                  Long-term​

                                                                                  Expanding tooling offered, integrations, potentially SaaS offering to partially fund efforts.

                                                                                  • Generator UI wrappers
                                                                                    • Move jimschubert/intellij-swagger-codegen plugin under the org, and rename
                                                                                    • Look into an Eclipse UI wrapper around the generator
                                                                                    • Look at Visual Studio Code (and/or Atom, sublime text) integration
                                                                                  • Provide a native GUI for viewing/editing specs. Most tools are currently geared toward developers, but often times it may be non-technical business users who are interested in an API.
                                                                                  • A paid service (SaaS) for generation may be enticing for some users. Such a service would allow for statistics (mentioned earlier in telemetry)
                                                                                  • Additional tools
                                                                                  • node.js build system(s) integration (grunt/gulp/webpack/etc)
                                                                                  • ruby gem
                                                                                  • others (which may require previously mentioned SaaS API)
                                                                                  - + \ No newline at end of file diff --git a/docs/spec-info/index.html b/docs/spec-info/index.html index c19ef3c5ef6..8780243cb53 100644 --- a/docs/spec-info/index.html +++ b/docs/spec-info/index.html @@ -15,13 +15,13 @@ - +
                                                                                  - + \ No newline at end of file diff --git a/docs/swagger-codegen-migration/index.html b/docs/swagger-codegen-migration/index.html index 9d832b36850..fcf2e8d9644 100644 --- a/docs/swagger-codegen-migration/index.html +++ b/docs/swagger-codegen-migration/index.html @@ -15,7 +15,7 @@ - + @@ -32,7 +32,7 @@ The syntax inside the file stays the same.

                                                                                  You don't need to rename t As example the default package name used in the generated code has changed. You need to have a look at the specific value, depending on your target language, but often Swagger îs replaced by OpenAPITools and io.swagger is replaced by org.openapitools. Concretely if you did not specify anything when you are generating java code, a file org/openapitools/api/PetApi.java might be generated instead of io/swagger/api/PetApi.java.

                                                                                  If this is a problem for you, you need to explicitly set the parameter value in order to match with the swagger-codegen default value (apiPackage == io.swagger in the previous example with the java generator).

                                                                                  New fully qualified name for the classes​

                                                                                  If you have extended some generators in your project, and you are looking for a specific class, replace the io.swagger.codegen package (old name) with org.openapitools.codegen package (new name).

                                                                                  Example: org.openapitools.codegen.DefaultGenerator

                                                                                  Body parameter name​

                                                                                  ‼️ Since 4.0.0-beta, the body parameter name in OAS v2 is automatically preserved in the vendor extension x-codegen-request-body-name

                                                                                  In OpenAPI spec v3, there's no body parameter, which is replaced by Request Body Object. The parameter name for Request Body is named automatically based on the model name (e.g. User). To control how the "Request Body" parameter is named, please add the vendor extension x-codegen-request-body-name to the operation:

                                                                                  OpenAPI Spec v3:

                                                                                  paths:
                                                                                    /pet:
                                                                                      post:
                                                                                        tags:
                                                                                          - pet
                                                                                        summary: Add a new pet to the store
                                                                                        description: ''
                                                                                        operationId: addPet
                                                                                        x-codegen-request-body-name: new_body_name
                                                                                        responses:
                                                                                          '405':
                                                                                            description: Invalid input
                                                                                        security:
                                                                                          - petstore_auth:
                                                                                              - 'write:pets'
                                                                                              - 'read:pets'
                                                                                        requestBody:
                                                                                          $ref: '#/components/requestBodies/Pet'

                                                                                  OpenAPI Spec v2:

                                                                                  paths:
                                                                                    /pet:
                                                                                      post:
                                                                                        tags:
                                                                                          - pet
                                                                                        summary: Add a new pet to the store
                                                                                        description: ''
                                                                                        operationId: addPet
                                                                                        x-codegen-request-body-name: new_body_name
                                                                                        consumes:
                                                                                          - application/json
                                                                                          - application/xml
                                                                                        produces:
                                                                                          - application/xml
                                                                                          - application/json
                                                                                        parameters:
                                                                                          - in: body
                                                                                            name: body
                                                                                            description: Pet object that needs to be added to the store
                                                                                            required: true
                                                                                            schema:
                                                                                              $ref: '#/definitions/Pet'
                                                                                        responses:
                                                                                          '405':
                                                                                            description: Invalid input
                                                                                        security:
                                                                                          - petstore_auth:
                                                                                              - 'write:pets'
                                                                                              - 'read:pets'

                                                                                  If your API client is using named parameters in the function call (e.g. Perl required & optional parameters, Ruby optional parameters), you will need to add x-codegen-request-body-name to the spec to restore the original body parameter name.

                                                                                  Default basePath​

                                                                                  The default basePath has been changed from https://localhost to http://localhost (http without s)

                                                                                  Nullable​

                                                                                  OpenAPI spec v3 has better support for nullable. If you're still using OpenAPI/Swagger spec v2, please use x-nullable: true instead.

                                                                                  - + \ No newline at end of file diff --git a/docs/templating/index.html b/docs/templating/index.html index 97edde1c40d..47e54babfc9 100644 --- a/docs/templating/index.html +++ b/docs/templating/index.html @@ -15,7 +15,7 @@ - + @@ -26,7 +26,7 @@ This is used to define names of the enum items.

                                                                                  x-enum-descriptions< This is used for comments in the code (like javadoc if the target language is java).

                                                                                  x-enum-descriptions and x-enum-varnames are each expected to be list of items containing the same number of items as enum. The order of the items in the list matters: their position is used to group them together.

                                                                                  Example:

                                                                                  WeatherType:
                                                                                    type: integer
                                                                                    format: int32
                                                                                    enum:
                                                                                      - 42
                                                                                      - 18
                                                                                      - 56
                                                                                    x-enum-descriptions:
                                                                                      - 'Blue sky'
                                                                                      - 'Slightly overcast'
                                                                                      - 'Take an umbrella with you'
                                                                                    x-enum-varnames:
                                                                                      - Sunny
                                                                                      - Cloudy
                                                                                      - Rainy

                                                                                  In the example for the integer value 42, the description will be Blue sky and the name of the enum item will be Sunny (some generators changes it to SUNNY to respect some coding convention).

                                                                                  ObjC​

                                                                                  x-objc-operationId​

                                                                                  To customize the method name, you can provide a different name in x-objc-operationId, e.g.

                                                                                  summary: Add a new pet to the store
                                                                                  description: ''
                                                                                  operationId: addPet
                                                                                  x-objc-operationId: CreateNewPet

                                                                                  Java (Feign)​

                                                                                  x-accepts​

                                                                                  A single Accepts value as the Feign API client needs a single value for Accepts header, e.g.

                                                                                  consumes:
                                                                                    - application/json
                                                                                    - application/xml
                                                                                  x-accepts: application/json

                                                                                  x-content-type​

                                                                                  A single "Content-Type" value as the Feign API client needs a single value for Content-Type header, e.g.

                                                                                  produces:
                                                                                    - application/xml
                                                                                    - application/json
                                                                                  x-content-type: application/json

                                                                                  Rust-server​

                                                                                  x-response-id​

                                                                                  Each response may specify a unique x-response-id. rust-server will use this to name the corresponding enum variant in the code. e.g.

                                                                                  paths:
                                                                                    /ping:
                                                                                      get:
                                                                                        responses:
                                                                                          200:
                                                                                            description: OK
                                                                                            x-response-id: Pong

                                                                                  MySQL Schema​

                                                                                  x-mysqlSchema​

                                                                                  MySQL schema generator creates vendor extensions based on openapi dataType and dataFormat. When user defined extensions with same key already exists codegen accepts those as is. It means it won't validate properties or correct it for you. Every model in definitions can contain table related and column related extensions like in example below:

                                                                                  definitions:
                                                                                    Order:
                                                                                      description: This should be most common InnoDB table
                                                                                      type: object
                                                                                      properties:
                                                                                        id:
                                                                                          description: >-
                                                                                            This column should be unsigned BIGINT with AUTO_INCREMENT
                                                                                          type: integer
                                                                                          format: int64
                                                                                          x-mysqlSchema:
                                                                                            columnDefinition:
                                                                                              colName: id
                                                                                              colDataType: DECIMAL
                                                                                              colDataTypeArguments:
                                                                                                - argumentValue: 16
                                                                                                  isString: false
                                                                                                - argumentValue: 4
                                                                                                  isString: false
                                                                                              colUnsigned: true
                                                                                              colNotNull: true
                                                                                              colDefault:
                                                                                                defaultValue: AUTO_INCREMENT
                                                                                                isString: false
                                                                                                isNumeric: false
                                                                                                isKeyword: true
                                                                                              colComment: >-
                                                                                                Column comment. This column should be unsigned BIGINT with AUTO_INCREMENT
                                                                                      x-mysqlSchema:
                                                                                        tableDefinition:
                                                                                          tblName: orders
                                                                                          tblStorageEngine: InnoDB
                                                                                          tblComment: >-
                                                                                            Table comment. This should be most common InnoDB table

                                                                                  There are properties that are not implemented by now(tblStorageEngine), but you can see how generator can be enhanced in future.

                                                                                  Mustache Tips​

                                                                                  Here are a few tips we've found useful for new template authors. For more details on Mustache see mustache.5. See also samskivert/jmustache for implementation-specific details.

                                                                                  First/Last​

                                                                                  To access the first or last element in a list using Mustache:

                                                                                  {{#vars}}{{#-first}} this is the first element {{.}} {{/-first}}{{/vars}}
                                                                                  {{#vars}}{{#-last}} this is the last element {{.}} {{/-last}}{{/vars}}

                                                                                  This​

                                                                                  Mustache evaluates template variables contextually. If the variable isn't found in the immediate object, mustache will search the parent. This is similar to JavaScript's prototype object (if you're familiar with the concept).

                                                                                  You can inspect this entire context by outputting {{this}}. For example:

                                                                                  {{#operations}}{{this}}{{/operations}}

                                                                                  Index​

                                                                                  If you'd like a 1-based index in your array traversal, you can use {{-index}}:

                                                                                  {{#enums}}{{-index}} {{enum}}{{/enums}}
                                                                                  - + \ No newline at end of file diff --git a/docs/usage/index.html b/docs/usage/index.html index ccdd680a4b8..2e562d5ef3a 100644 --- a/docs/usage/index.html +++ b/docs/usage/index.html @@ -15,7 +15,7 @@ - + @@ -24,7 +24,7 @@ This page demonstrates navigating the options via CLI. Commands are presented here in a logical progression as a tutorial, but you're welcome to skip directly to the generate command.

                                                                                  help​

                                                                                  The help option lists all commands available to the CLI.

                                                                                  openapi-generator-cli help
                                                                                  usage: openapi-generator-cli <command> [<args>]

                                                                                  The most commonly used openapi-generator-cli commands are:
                                                                                      author        Utilities for authoring generators or customizing templates.
                                                                                      batch         Generate code in batch via external configs.
                                                                                      config-help   Config help for chosen lang
                                                                                      generate      Generate code with the specified generator.
                                                                                      help          Display help information about openapi-generator
                                                                                      list          Lists the available generators
                                                                                      meta          MetaGenerator. Generator for creating a new template set and configuration for Codegen.  The output will be based on the language you specify, and includes default templates to include.
                                                                                      validate      Validate specification
                                                                                      version       Show version information used in tooling

                                                                                  See 'openapi-generator-cli help <command>' for more information on a specific
                                                                                  command.

                                                                                  version​

                                                                                  The version command provides version information, returning either the version by default, the git commit sha when passed --sha, or verbose output when passed --full.

                                                                                  NAME
                                                                                          openapi-generator-cli version - Show version information used in tooling

                                                                                  SYNOPSIS
                                                                                          openapi-generator-cli version [--full] [--sha]

                                                                                  OPTIONS
                                                                                          --full
                                                                                              Full version details

                                                                                          --sha
                                                                                              Git commit SHA version

                                                                                  list​

                                                                                  The list command outputs a formatted list of every available generator. Pass the -s/--short option if you would like a CSV output for easy parsing.

                                                                                  openapi-generator-cli help list
                                                                                  NAME
                                                                                          openapi-generator-cli list - Lists the available generators

                                                                                  SYNOPSIS
                                                                                          openapi-generator-cli list [(-i <include> | --include <include>)]
                                                                                                  [(-s | --short)]

                                                                                  OPTIONS
                                                                                          -i <include>, --include <include>
                                                                                              comma-separated list of stability indexes to include (value:
                                                                                              all,beta,stable,experimental,deprecated). Excludes deprecated by
                                                                                              default.

                                                                                          -s, --short
                                                                                              shortened output (suitable for scripting)

                                                                                  Example:

                                                                                  openapi-generator-cli list -s | tr ',' '\n'

                                                                                  For the full list of generators, refer to the Generators List.

                                                                                  config-help​

                                                                                  The config-help option provides details about 

                                                                                  openapi-generator-cli help config-help
                                                                                  NAME
                                                                                          openapi-generator-cli config-help - Config help for chosen lang

                                                                                  SYNOPSIS
                                                                                          openapi-generator-cli config-help
                                                                                                  [(-f <output format> | --format <output format>)] [--feature-set]
                                                                                                  [--full-details]
                                                                                                  [(-g <generator name> | --generator-name <generator name>)]
                                                                                                  [--import-mappings] [--instantiation-types]
                                                                                                  [--language-specific-primitive] [--markdown-header] [--named-header]
                                                                                                  [(-o <output location> | --output <output location>)] [--reserved-words]

                                                                                  OPTIONS
                                                                                          -f <output format>, --format <output format>
                                                                                              Write output files in the desired format. Options are 'text',
                                                                                              'markdown' or 'yamlsample'. Default is 'text'.

                                                                                          --feature-set
                                                                                              displays feature set as supported by the generator

                                                                                          --full-details
                                                                                              displays CLI options as well as other configs/mappings (implies
                                                                                              --instantiation-types, --reserved-words,
                                                                                              --language-specific-primitives, --import-mappings,
                                                                                              --supporting-files)

                                                                                          -g <generator name>, --generator-name <generator name>
                                                                                              generator to get config help for

                                                                                          --import-mappings
                                                                                              displays the default import mappings (types and aliases, and what
                                                                                              imports they will pull into the template)

                                                                                          --instantiation-types
                                                                                              displays types used to instantiate simple type/alias names

                                                                                          --language-specific-primitive
                                                                                              displays the language specific primitives (types which require no
                                                                                              additional imports, or which may conflict with user defined model
                                                                                              names)

                                                                                          --markdown-header
                                                                                              When format=markdown, include this option to write out markdown
                                                                                              headers (e.g. for docusaurus).

                                                                                          --named-header
                                                                                              Header includes the generator name, for clarity in output

                                                                                          -o <output location>, --output <output location>
                                                                                              Optionally write help to this location, otherwise default is
                                                                                              standard output

                                                                                          --reserved-words
                                                                                              displays the reserved words which may result in renamed model or
                                                                                              property names

                                                                                  The option of note is -g/--generator-name (other options are exposed for tooling).

                                                                                  You may pass any generator name (see list command) to -g, and options specific to that generator will be displayed. Some generators have many options, while others may have only a few.

                                                                                  Example:

                                                                                  openapi-generator-cli config-help -g go

                                                                                  Outputs:

                                                                                  CONFIG OPTIONS
                                                                                      packageName
                                                                                          Go package name (convention: lowercase). (Default: openapi)

                                                                                      hideGenerationTimestamp
                                                                                          Hides the generation timestamp when files are generated. (Default: true)

                                                                                      packageVersion
                                                                                          Go package version. (Default: 1.0.0)

                                                                                      withGoCodegenComment
                                                                                          whether to include Go codegen comment to disable Go Lint and collapse by default in GitHub PRs and diffs (Default: false)

                                                                                      withXml
                                                                                          whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false)

                                                                                      prependFormOrBodyParameters
                                                                                          Add form or body parameters to the beginning of the parameter list. (Default: false)

                                                                                  To pass these go client generator-specific options to the generate command for a go client, use the --additional-properties option. See the generate command section for an example.

                                                                                  meta​

                                                                                  The meta command creates a new Java class and template files, used for creating your own custom templates.

                                                                                  openapi-generator-cli help meta
                                                                                  NAME
                                                                                          openapi-generator-cli meta - MetaGenerator. Generator for creating a new
                                                                                          template set and configuration for Codegen. The output will be based on
                                                                                          the language you specify, and includes default templates to include.

                                                                                  SYNOPSIS
                                                                                          openapi-generator-cli meta [(-l <language> | --language <language>)]
                                                                                                  [(-n <name> | --name <name>)]
                                                                                                  [(-o <output directory> | --output <output directory>)]
                                                                                                  [(-p <package> | --package <package>)] [(-t <type> | --type <type>)]

                                                                                  OPTIONS
                                                                                          -l <language>, --language <language>
                                                                                              the implementation language for the generator class

                                                                                          -n <name>, --name <name>
                                                                                              the human-readable name of the generator

                                                                                          -o <output directory>, --output <output directory>
                                                                                              where to write the generated files (current dir by default)

                                                                                          -p <package>, --package <package>
                                                                                              the package to put the main class into (defaults to
                                                                                              org.openapitools.codegen)

                                                                                          -t <type>, --type <type>
                                                                                              the type of generator that is created

                                                                                  For an in-depth example of using the meta command, see Customization.

                                                                                  validate​

                                                                                  The validate command allows you to validate an input specification, optionally providing recommendations for error fixes or other improvements (if available).

                                                                                  openapi-generator-cli help validate
                                                                                  NAME
                                                                                          openapi-generator-cli validate - Validate specification

                                                                                  SYNOPSIS
                                                                                          openapi-generator-cli validate
                                                                                                  (-i <spec file> | --input-spec <spec file>) [--recommend]

                                                                                  OPTIONS
                                                                                          -i <spec file>, --input-spec <spec file>
                                                                                              location of the OpenAPI spec, as URL or file (required)

                                                                                          --recommend

                                                                                  Valid Spec Example (using petstore-v3.0.yaml)

                                                                                  openapi-generator-cli validate -i petstore-v3.0.yaml
                                                                                  Validating spec (petstore-v3.0.yaml)
                                                                                  No validation issues detected.

                                                                                  Invalid Spec Example (using petstore-v3.0-invalid.yaml):

                                                                                  openapi-generator-cli validate -i petstore-v3.0-invalid.yaml
                                                                                  Validating spec (petstore-v3.0-invalid.yaml)
                                                                                  Errors:
                                                                                      -attribute info is missing

                                                                                  [error] Spec has 1 errors.

                                                                                  completion​

                                                                                  Although not documented in the help output, the CLI offers a completion command, which can be used for auto-completion.

                                                                                  This command takes one or more parameters representing the args list you would otherwise pass to openapi-generator. For example:

                                                                                  openapi-generator-cli completion config-help
                                                                                  -o
                                                                                  --output
                                                                                  --named-header
                                                                                  -g
                                                                                  --generator-name
                                                                                  -f
                                                                                  --format
                                                                                  --markdown-header

                                                                                  An example bash completion script can be found in the repo at scripts/openapi-generator-cli-completion.bash.

                                                                                  generate​

                                                                                  The generate command is the workhorse of the generator toolset. As such, it has many more options available than the previous commands. The abbreviated options are below, but you may expand the full descriptions.

                                                                                  openapi-generator-cli help generate
                                                                                  NAME
                                                                                          openapi-generator-cli generate - Generate code with the specified
                                                                                          generator.

                                                                                  SYNOPSIS
                                                                                          openapi-generator-cli generate
                                                                                                  [(-a <authorization> | --auth <authorization>)]
                                                                                                  [--api-name-suffix <api name suffix>] [--api-package <api package>]
                                                                                                  [--artifact-id <artifact id>] [--artifact-version <artifact version>]
                                                                                                  [(-c <configuration file> | --config <configuration file>)] [--dry-run]
                                                                                                  [(-e <templating engine> | --engine <templating engine>)]
                                                                                                  [--enable-post-process-file]
                                                                                                  [(-g <generator name> | --generator-name <generator name>)]
                                                                                                  [--generate-alias-as-model] [--git-host <git host>]
                                                                                                  [--git-repo-id <git repo id>] [--git-user-id <git user id>]
                                                                                                  [--global-property <global properties>...] [--group-id <group id>]
                                                                                                  [--http-user-agent <http user agent>]
                                                                                                  [(-i <spec file> | --input-spec <spec file>)]
                                                                                                  [--ignore-file-override <ignore file override location>]
                                                                                                  [--import-mappings <import mappings>...]
                                                                                                  [--instantiation-types <instantiation types>...]
                                                                                                  [--invoker-package <invoker package>]
                                                                                                  [--language-specific-primitives <language specific primitives>...]
                                                                                                  [--legacy-discriminator-behavior] [--library <library>]
                                                                                                  [--log-to-stderr] [--minimal-update]
                                                                                                  [--model-name-prefix <model name prefix>]
                                                                                                  [--model-name-suffix <model name suffix>]
                                                                                                  [--model-package <model package>]
                                                                                                  [(-o <output directory> | --output <output directory>)] [(-p <additional properties> | --additional-properties <additional properties>)...]
                                                                                                  [--package-name <package name>] [--release-note <release note>]
                                                                                                  [--remove-operation-id-prefix]
                                                                                                  [--reserved-words-mappings <reserved word mappings>...]
                                                                                                  [(-s | --skip-overwrite)] [--server-variables <server variables>...]
                                                                                                  [--skip-operation-example] [--skip-validate-spec]
                                                                                                  [--strict-spec <true/false strict behavior>]
                                                                                                  [(-t <template directory> | --template-dir <template directory>)]
                                                                                                  [--type-mappings <type mappings>...] [(-v | --verbose)]
                                                                                  generate OPTIONS
                                                                                  OPTIONS
                                                                                          -a <authorization>, --auth <authorization>
                                                                                              adds authorization headers when fetching the OpenAPI definitions
                                                                                              remotely. Pass in a URL-encoded string of name:header with a comma
                                                                                              separating multiple values

                                                                                          --api-name-suffix <api name suffix>
                                                                                              Suffix that will be appended to all API names ('tags'). Default:
                                                                                              Api. e.g. Pet => PetApi. Note: Only ruby, python, jaxrs generators
                                                                                              support this feature at the moment.

                                                                                          --api-package <api package>
                                                                                              package for generated api classes

                                                                                          --artifact-id <artifact id>
                                                                                              artifactId in generated pom.xml. This also becomes part of the
                                                                                              generated library's filename

                                                                                          --artifact-version <artifact version>
                                                                                              artifact version in generated pom.xml. This also becomes part of the
                                                                                              generated library's filename

                                                                                          -c <configuration file>, --config <configuration file>
                                                                                              Path to configuration file. It can be JSON or YAML. If file is JSON,
                                                                                              the content should have the format {"optionKey":"optionValue",
                                                                                              "optionKey1":"optionValue1"...}. If file is YAML, the content should
                                                                                              have the format optionKey: optionValue. Supported options can be
                                                                                              different for each language. Run config-help -g {generator name}
                                                                                              command for language-specific config options.

                                                                                          --dry-run
                                                                                              Try things out and report on potential changes (without actually
                                                                                              making changes).

                                                                                          -e <templating engine>, --engine <templating engine>
                                                                                              templating engine: "mustache" (default) or "handlebars" (beta)

                                                                                          --enable-post-process-file
                                                                                              Enable post-processing file using environment variables.

                                                                                          -g <generator name>, --generator-name <generator name>
                                                                                              generator to use (see list command for list)

                                                                                          --generate-alias-as-model
                                                                                              Generate model implementation for aliases to map and array schemas.
                                                                                              An 'alias' is an array, map, or list which is defined inline in a
                                                                                              OpenAPI document and becomes a model in the generated code. A 'map'
                                                                                              schema is an object that can have undeclared properties, i.e. the
                                                                                              'additionalproperties' attribute is set on that object. An 'array'
                                                                                              schema is a list of sub schemas in a OAS document

                                                                                          --git-host <git host>
                                                                                              Git host, e.g. gitlab.com.

                                                                                          --git-repo-id <git repo id>
                                                                                              Git repo ID, e.g. openapi-generator.

                                                                                          --git-user-id <git user id>
                                                                                              Git user ID, e.g. openapitools.

                                                                                          --global-property <global properties>
                                                                                              sets specified global properties (previously called 'system
                                                                                              properties') in the format of name=value,name=value (or multiple
                                                                                              options, each with name=value)

                                                                                          --group-id <group id>
                                                                                              groupId in generated pom.xml

                                                                                          --http-user-agent <http user agent>
                                                                                              HTTP user agent, e.g. codegen_csharp_api_client, default to
                                                                                              'OpenAPI-Generator/{packageVersion}/{language}'

                                                                                          -i <spec file>, --input-spec <spec file>
                                                                                              location of the OpenAPI spec, as URL or file (required if not loaded
                                                                                              via config using -c)

                                                                                          --ignore-file-override <ignore file override location>
                                                                                              Specifies an override location for the .openapi-generator-ignore
                                                                                              file. Most useful on initial generation.

                                                                                          --import-mappings <import mappings>
                                                                                              specifies mappings between a given class and the import that should
                                                                                              be used for that class in the format of type=import,type=import. You
                                                                                              can also have multiple occurrences of this option.

                                                                                          --instantiation-types <instantiation types>
                                                                                              sets instantiation type mappings in the format of
                                                                                              type=instantiatedType,type=instantiatedType.For example (in Java):
                                                                                              array=ArrayList,map=HashMap. In other words array types will get
                                                                                              instantiated as ArrayList in generated code. You can also have
                                                                                              multiple occurrences of this option.

                                                                                          --invoker-package <invoker package>
                                                                                              root package for generated code

                                                                                          --language-specific-primitives <language specific primitives>
                                                                                              specifies additional language specific primitive types in the format
                                                                                              of type1,type2,type3,type3. For example:
                                                                                              String,boolean,Boolean,Double. You can also have multiple
                                                                                              occurrences of this option.

                                                                                          --legacy-discriminator-behavior
                                                                                              Set to false for generators with better support for discriminators.
                                                                                              (Python, Java, Go, PowerShell, C#have this enabled by default).

                                                                                          --library <library>
                                                                                              library template (sub-template)

                                                                                          --log-to-stderr
                                                                                              write all log messages (not just errors) to STDOUT. Useful for
                                                                                              piping the JSON output of debug options (e.g. `--global-property
                                                                                              debugOperations`) to an external parser directly while testing a
                                                                                              generator.

                                                                                          --minimal-update
                                                                                              Only write output files that have changed.

                                                                                          --model-name-prefix <model name prefix>
                                                                                              Prefix that will be prepended to all model names.

                                                                                          --model-name-suffix <model name suffix>
                                                                                              Suffix that will be appended to all model names.

                                                                                          --model-package <model package>
                                                                                              package for generated models

                                                                                          -o <output directory>, --output <output directory>
                                                                                              where to write the generated files (current dir by default)

                                                                                          -p <additional properties>, --additional-properties <additional
                                                                                          properties>
                                                                                              sets additional properties that can be referenced by the mustache
                                                                                              templates in the format of name=value,name=value. You can also have
                                                                                              multiple occurrences of this option.

                                                                                          --package-name <package name>
                                                                                              package for generated classes (where supported)

                                                                                          --release-note <release note>
                                                                                              Release note, default to 'Minor update'.

                                                                                          --remove-operation-id-prefix
                                                                                              Remove prefix of operationId, e.g. config_getId => getId

                                                                                          --reserved-words-mappings <reserved word mappings>
                                                                                              specifies how a reserved name should be escaped to. Otherwise, the
                                                                                              default _<name> is used. For example id=identifier. You can also
                                                                                              have multiple occurrences of this option.

                                                                                          -s, --skip-overwrite
                                                                                              specifies if the existing files should be overwritten during the
                                                                                              generation.

                                                                                          --server-variables <server variables>
                                                                                              sets server variables overrides for spec documents which support
                                                                                              variable templating of servers.

                                                                                          --skip-operation-example
                                                                                              Skip examples defined in operations to avoid out of memory errors.

                                                                                          --skip-validate-spec
                                                                                              Skips the default behavior of validating an input specification.

                                                                                          --strict-spec <true/false strict behavior>
                                                                                              'MUST' and 'SHALL' wording in OpenAPI spec is strictly adhered to.
                                                                                              e.g. when false, no fixes will be applied to documents which pass
                                                                                              validation but don't follow the spec.

                                                                                          -t <template directory>, --template-dir <template directory>
                                                                                              folder containing the template files

                                                                                          --type-mappings <type mappings>
                                                                                              sets mappings between OpenAPI spec types and generated code types in
                                                                                              the format of OpenAPIType=generatedType,OpenAPIType=generatedType.
                                                                                              For example: array=List,map=Map,string=String. You can also have
                                                                                              multiple occurrences of this option.

                                                                                          -v, --verbose
                                                                                              verbose mode

                                                                                  At a minimum, generate requires:

                                                                                  • -g to specify the generator
                                                                                  • -o to specify a meaningful output directory (defaults to the current directory!)
                                                                                  • -i to specify the input OpenAPI document

                                                                                  NOTE You may also pass -Dcolor as a system property to colorize terminal outputs.

                                                                                  Examples​

                                                                                  The following examples use petstore.yaml.

                                                                                  Additional Properties​

                                                                                  Generator-specific options should be passed as --additional-properties:

                                                                                  openapi-generator-cli generate -g go --additional-properties=prependFormOrBodyParameters=true \
                                                                                      -o out -i petstore.yaml

                                                                                  Pass more options via comma delimited key/value pairs:

                                                                                  --additional-properties=key1=value1,key2=value2

                                                                                  For the full list of generator-specific parameters, refer to generators docs.

                                                                                  Type Mappings and Import Mappings​

                                                                                  Most generators allow for types bound to the OpenAPI Specification's types to be remapped to a user's desired types. Not all type mappings can be reassigned, as some generators define mappings which are tightly coupled to the built-in templates.

                                                                                  If you're not using your own templates with star/glob package imports, you will most likely need to combine --type-mappings and --import-mappings together.

                                                                                  • --type-mappings Defines the user's target type
                                                                                  • --import-mappings Informs the template of the type to be imported

                                                                                  Here's how one might change the kotlin-spring server generator's default of OffsetDateTime to LocalDateTime:

                                                                                  openapi-generator-cli generate \
                                                                                      -i petstore.yaml \
                                                                                      -g kotlin-spring \
                                                                                      -o out \
                                                                                      --additional-properties=library=spring-boot,beanValidations=true,serviceImplementation=true \
                                                                                      --import-mappings=DateTime=java.time.LocalDateTime \
                                                                                      --type-mappings=DateTime=java.time.LocalDateTime

                                                                                  NOTE: mappings are applied to DateTime, as this is the representation of the primitive type. See DefaultCodegen.

                                                                                  File Post-Processing​

                                                                                  The --enable-post-process-file option enables specific generators to invoke some external language-specific formatting script. Each filename is passed individually to this external script, allowing for linting, formatting, or other custom clean-up.

                                                                                  For more details, see File Post-Processing.

                                                                                  Target External Models​

                                                                                  Sometimes you don't want the codegen to make a model for you--you might want to just include one that already exists in your codebase. Say you already have a User object and want to reuse that, which has a different model package from the other generated files:

                                                                                  First, indicate that the class is already included by default. This will keep the codegen from trying to generate the class.

                                                                                  --language-specific-primitives=Pet

                                                                                  This command line option will tell the generator to consider Pet a "primitive" type.

                                                                                  Next, if the Pet class is a different package, add an --import-mapping to tell the generator to include that import wherever Pet is used:

                                                                                  --import-mappings=Pet=com.yourpackage.models.Pet

                                                                                  Now the codegen will know what to import from that specific package.

                                                                                  NOTE: import-mappings is assigned a key-value pair in this example, but multiple values can be comma-separate. For instance:

                                                                                  --import-mappings=Pet=com.yourpackage.models.Pet,User=com.yourpackage.models.User

                                                                                  Configuration File​

                                                                                  Rather than passing generator options in a CSV of --additional-properties, you may also provide the settings via JSON file or YAML file.

                                                                                  For example, one of our typescript samples has the following configuration file:

                                                                                  {
                                                                                    "npmName": "@swagger/typescript-fetch-petstore",
                                                                                    "npmVersion": "1.0.0",
                                                                                    "npmRepository" : "https://skimdb.npmjs.com/registry",
                                                                                    "snapshot" : false,
                                                                                    "supportsES6": true
                                                                                  }

                                                                                  These settings can be passed via -c filename. Here, we've saved the above as config.json:

                                                                                  openapi-generator-cli generate -i petstore.yaml -g typescript-fetch -o out \
                                                                                      -c config.json

                                                                                  Same configuration file can be passed into YAML format having following equivalent content:

                                                                                  npmName: "@swagger/typescript-fetch-petstore"
                                                                                  npmVersion: "1.0.0"
                                                                                  npmRepository: "https://skimdb.npmjs.com/registry"
                                                                                  snapshot: false
                                                                                  supportsES6: true

                                                                                  The settings are passed exactly the same as for config.json. The most important part is the file extension. Supported values are yml or yaml. The name of the file should be config.yml or config.yaml (in our example it will be config.yaml).

                                                                                  openapi-generator-cli generate -i petstore.yaml -g typescript-fetch -o out \
                                                                                      -c config.yaml

                                                                                  batch​

                                                                                  The batch command allows you to move all CLI arguments supported by the generate command into a YAML or JSON file.

                                                                                  NOTE: This command supports an additional !include property which may point to another "shared" file, the base path to which can be modified by --includes-base-dir. Starting with 5.0.0, the !batch command supports multiple !include properties, either sequential or nested under other keys. In order to support multiple !include properties in a JSON file, the property name can have a suffix, e.g. !include1, !include2, etc. The suffix have no meaning other than providing unique property names.

                                                                                  openapi-generator-cli help batch
                                                                                  NAME
                                                                                          openapi-generator-cli batch - Generate code in batch via external
                                                                                          configs.

                                                                                  SYNOPSIS
                                                                                          openapi-generator-cli batch [--clean] [--fail-fast]
                                                                                                  [--includes-base-dir <includes>] [(-r <threads> | --threads <threads>)]
                                                                                                  [--root-dir <root>] [--timeout <timeout>] [(-v | --verbose)] [--]
                                                                                                  <configs>...

                                                                                  OPTIONS
                                                                                          --clean
                                                                                              clean output of previously written files before generation

                                                                                          --fail-fast
                                                                                              fail fast on any errors

                                                                                          --includes-base-dir <includes>
                                                                                              base directory used for includes

                                                                                          -r <threads>, --threads <threads>
                                                                                              thread count

                                                                                          --root-dir <root>
                                                                                              root directory used output/includes (includes can be overridden)

                                                                                          --timeout <timeout>
                                                                                              execution timeout (minutes)

                                                                                          -v, --verbose
                                                                                              verbose mode

                                                                                          --
                                                                                              This option can be used to separate command-line options from the
                                                                                              list of argument, (useful when arguments might be mistaken for
                                                                                              command-line options

                                                                                          <configs>
                                                                                              Generator configuration files.

                                                                                  Example:

                                                                                  # create "shared" config
                                                                                  mkdir shared && cat > shared/common.yaml <<EOF
                                                                                  inputSpec: https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml
                                                                                  additionalProperties:
                                                                                      x-ext-name: "Your Name"
                                                                                  EOF

                                                                                  # create nested "shared" config
                                                                                  cat > shared/nested.yaml <<EOF
                                                                                  useCompareNetObjects: "true"
                                                                                  EOF

                                                                                  # create "standard" configs
                                                                                  cat > kotlin.yaml <<EOF
                                                                                  '!include': 'shared/common.yaml'
                                                                                  outputDir: out/kotlin
                                                                                  generatorName: kotlin
                                                                                  artifactId: kotlin-petstore-string
                                                                                  additionalProperties:
                                                                                    dateLibrary: string
                                                                                    serializableModel: "true"
                                                                                  EOF

                                                                                  cat > csharp.yaml <<EOF
                                                                                  '!include': 'shared/common.yaml'
                                                                                  outputDir: out/csharp-netcore
                                                                                  generatorName: csharp-netcore
                                                                                  additionalProperties:
                                                                                    packageGuid: "{321C8C3F-0156-40C1-AE42-D59761FB9B6C}"
                                                                                    '!include': 'shared/nested.yaml'
                                                                                  EOF

                                                                                  # Generate them
                                                                                  openapi-generator-cli batch *.yaml

                                                                                  author​

                                                                                  This command group contains utilities for authoring generators or customizing templates.

                                                                                  openapi-generator-cli help author
                                                                                  NAME
                                                                                          openapi-generator-cli author - Utilities for authoring generators or
                                                                                          customizing templates.

                                                                                  SYNOPSIS
                                                                                          openapi-generator-cli author
                                                                                          openapi-generator-cli author template [--library <library>]
                                                                                                  [(-v | --verbose)]
                                                                                                  [(-o <output directory> | --output <output directory>)]
                                                                                                  (-g <generator name> | --generator-name <generator name>)

                                                                                  OPTIONS
                                                                                          --help
                                                                                              Display help about the tool

                                                                                          --version
                                                                                              Display full version output

                                                                                  COMMANDS
                                                                                          With no arguments, Display help information about openapi-generator

                                                                                          template
                                                                                              Retrieve templates for local modification

                                                                                              With --library option, library template (sub-template)

                                                                                              With --verbose option, verbose mode

                                                                                              With --output option, where to write the template files (defaults to
                                                                                              'out')

                                                                                              With --generator-name option, generator to use (see list command for
                                                                                              list)

                                                                                  template​

                                                                                  This command allows user to extract templates from the CLI jar which simplifies customization efforts.

                                                                                  openapi-generator-cli help author template
                                                                                  NAME
                                                                                          openapi-generator-cli author template - Retrieve templates for local
                                                                                          modification

                                                                                  SYNOPSIS
                                                                                          openapi-generator-cli author template
                                                                                                  (-g <generator name> | --generator-name <generator name>)
                                                                                                  [--library <library>]
                                                                                                  [(-o <output directory> | --output <output directory>)]
                                                                                                  [(-v | --verbose)]

                                                                                  OPTIONS
                                                                                          -g <generator name>, --generator-name <generator name>
                                                                                              generator to use (see list command for list)

                                                                                          --library <library>
                                                                                              library template (sub-template)

                                                                                          -o <output directory>, --output <output directory>
                                                                                              where to write the template files (defaults to 'out')

                                                                                          -v, --verbose
                                                                                              verbose mode

                                                                                  Example:

                                                                                  Extract Java templates, limiting to the webclient library.

                                                                                  openapi-generator-cli author template -g java --library webclient

                                                                                  Extract all Java templates:

                                                                                  openapi-generator-cli author template -g java
                                                                                  - + \ No newline at end of file diff --git a/index.html b/index.html index 390d5675f45..65b730c9eaf 100644 --- a/index.html +++ b/index.html @@ -15,13 +15,13 @@ - +
                                                                                  -

                                                                                  OpenAPI Generator

                                                                                  Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents

                                                                                  Try It OutInstall
                                                                                  GeneratorsCustomizationIntegrations

                                                                                  Sponsors

                                                                                  If you find OpenAPI Generator useful, please consider asking your company to become a sponsor.

                                                                                  You can also individually sponsor the project by becoming a backer.

                                                                                  Thank you to our bronze sponsors!

                                                                                  NamSorLightbowDocSpringDatadogThalesApideckPEXANumaryOneSignalVirtualan SoftwareMergeBürkertFINBOURNEBump.shbiletoBairesDevdmTECHAdyenFornexAlloy Automationsss TwitterSvixLITSLINKDesignliit@mKongRoute4MeDotcom-Monitor
                                                                                  logo

                                                                                  Easy to Use

                                                                                  With 50+ client generators, you can easily generate code to interact with any server which exposes an OpenAPI document.

                                                                                  Maintainers of APIs may also automatically generate and distribute clients as part of official SDKs.

                                                                                  Each client supports different options and features, but all templates can be replaced with your own Mustache-based templates.

                                                                                  See Customization for details.
                                                                                  logo

                                                                                  Servers

                                                                                  Getting started with server development can be tough, especially if you're evaluating technologies. We can reduce the burden when you bring your own OpenAPI document.

                                                                                  Generate server stubs for 40+ different languages and technologies, including Java, Kotlin, Go, and PHP.

                                                                                  Some generators support Inversion of Control, allowing you to iterate on design via your OpenAPI document without worrying about blowing away your entire domain layer when you regenerate code.

                                                                                  logo

                                                                                  Schemas/Configs

                                                                                  Ever wanted to iteratively design a MySQL database, but writing table declarations was too tedious?

                                                                                  OpenAPI Generator offers some special generators such as Apache2 Configuration, MySQL and GraphQL schema generators.

                                                                                  You can easily extend these generators and their templates to create derivative generators!

                                                                                  logo

                                                                                  Documentation

                                                                                  OpenAPI documents allow you to convert the metadata about your API into some other format.

                                                                                  We include documentation formats such as HTML and Cwiki, which allow you to distribute static documentation to your consumers.

                                                                                  We also support generating from OpenAPI 2.0 to newer JSON/YAML OpenAPI 3.x documents.

                                                                                  learn logo

                                                                                  Learn How

                                                                                  OpenAPI Generator supports many different integrations and use cases, including (but not limited to):

                                                                                  • Maven Plugin
                                                                                  • Gradle Plugin
                                                                                  • Bazel Plugin
                                                                                  • SBT Plugin
                                                                                  • Cake Plugin
                                                                                  • CLI via Homebrew
                                                                                  • CLI via Docker
                                                                                  • CLI via npm
                                                                                  • Generator SaaS

                                                                                  For details, see Workflow Integrations

                                                                                  Generation also allows for easy customization via options, custom templates, or even custom generators on your classpath. See Customization for details.

                                                                                  connectOnSlack logo

                                                                                  Active Community

                                                                                  Connect with us on Slack!

                                                                                  We're a very community-oriented project. We have an active community of users, contributors, and core team members on Slack. Slack is often a good place to start if you're looking for guidance about where to begin contributing, if you have an idea you're not sure fits the project, or if you just want to ask a question or say hello.

                                                                                  Slack is free to download, and our workspace is free to sign up.

                                                                                  try logo

                                                                                  Try via npm

                                                                                  The npm package wrapper is cross-platform wrapper around the .jar artifact.

                                                                                  Install globally, exposing the CLI on the command line:


                                                                                  # install the latest version of "openapi-generator-cli"
                                                                                  npm install @openapitools/openapi-generator-cli -g

                                                                                  # use a specific version of "openapi-generator-cli"
                                                                                  openapi-generator-cli version-manager set 7.9.0

                                                                                  # Or install it as dev-dependency in your node.js projects
                                                                                  npm install @openapitools/openapi-generator-cli -D

                                                                                  Then, generate a ruby client from a valid petstore.yaml doc:


                                                                                                  openapi-generator-cli generate -i petstore.yaml -g ruby -o /tmp/test/

                                                                                  tryHomebrew logo

                                                                                  Try via Homebrew

                                                                                  Install via homebrew:

                                                                                  brew install openapi-generator

                                                                                  Then, generate a ruby client from a valid petstore.yaml doc:

                                                                                  openapi-generator generate -i petstore.yaml -g ruby -o /tmp/test/

                                                                                  tryDocker logo

                                                                                  Try via Docker

                                                                                  The OpenAPI Generator image acts as a standalone executable. It can be used as an alternative to installing via homebrew, or for developers who are unable to install Java or upgrade the installed version.

                                                                                  To generate code from a valid petstore.yaml doc with this image, you'll need to mount a local location as a volume.


                                                                                  docker run --rm \
                                                                                      -v $PWD:/local openapitools/openapi-generator-cli generate \
                                                                                      -i /local/petstore.yaml \
                                                                                      -g go \
                                                                                      -o /local/out/go

                                                                                  For a full list of our docker images, check out u/openapitools on Docker Hub.

                                                                                  Who is Using This?

                                                                                  Here are some users of OpenAPI Generator

                                                                                  ASKULBithost GmbHGiant Monkey GmbHJustStarMetaswitchStingrayTelstraunblu inc.WSO2Zalando
                                                                                  More OpenAPI Generator Users
                                                                                  "OpenAPI Tools" and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI)
                                                                                  - +

                                                                                  OpenAPI Generator

                                                                                  Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents

                                                                                  Try It OutInstall
                                                                                  GeneratorsCustomizationIntegrations

                                                                                  Sponsors

                                                                                  If you find OpenAPI Generator useful, please consider asking your company to become a sponsor.

                                                                                  You can also individually sponsor the project by becoming a backer.

                                                                                  Thank you to our bronze sponsors!

                                                                                  NamSorLightbowDocSpringDatadogThalesApideckPEXANumaryOneSignalVirtualan SoftwareMergeBürkertFINBOURNEBump.shbiletoBairesDevdmTECHAdyenFornexAlloy Automationsss TwitterSvixLITSLINKDesignliit@mKongRoute4MeDotcom-Monitor
                                                                                  logo

                                                                                  Easy to Use

                                                                                  With 50+ client generators, you can easily generate code to interact with any server which exposes an OpenAPI document.

                                                                                  Maintainers of APIs may also automatically generate and distribute clients as part of official SDKs.

                                                                                  Each client supports different options and features, but all templates can be replaced with your own Mustache-based templates.

                                                                                  See Customization for details.
                                                                                  logo

                                                                                  Servers

                                                                                  Getting started with server development can be tough, especially if you're evaluating technologies. We can reduce the burden when you bring your own OpenAPI document.

                                                                                  Generate server stubs for 40+ different languages and technologies, including Java, Kotlin, Go, and PHP.

                                                                                  Some generators support Inversion of Control, allowing you to iterate on design via your OpenAPI document without worrying about blowing away your entire domain layer when you regenerate code.

                                                                                  logo

                                                                                  Schemas/Configs

                                                                                  Ever wanted to iteratively design a MySQL database, but writing table declarations was too tedious?

                                                                                  OpenAPI Generator offers some special generators such as Apache2 Configuration, MySQL and GraphQL schema generators.

                                                                                  You can easily extend these generators and their templates to create derivative generators!

                                                                                  logo

                                                                                  Documentation

                                                                                  OpenAPI documents allow you to convert the metadata about your API into some other format.

                                                                                  We include documentation formats such as HTML and Cwiki, which allow you to distribute static documentation to your consumers.

                                                                                  We also support generating from OpenAPI 2.0 to newer JSON/YAML OpenAPI 3.x documents.

                                                                                  learn logo

                                                                                  Learn How

                                                                                  OpenAPI Generator supports many different integrations and use cases, including (but not limited to):

                                                                                  • Maven Plugin
                                                                                  • Gradle Plugin
                                                                                  • Bazel Plugin
                                                                                  • SBT Plugin
                                                                                  • Cake Plugin
                                                                                  • CLI via Homebrew
                                                                                  • CLI via Docker
                                                                                  • CLI via npm
                                                                                  • Generator SaaS

                                                                                  For details, see Workflow Integrations

                                                                                  Generation also allows for easy customization via options, custom templates, or even custom generators on your classpath. See Customization for details.

                                                                                  connectOnSlack logo

                                                                                  Active Community

                                                                                  Connect with us on Slack!

                                                                                  We're a very community-oriented project. We have an active community of users, contributors, and core team members on Slack. Slack is often a good place to start if you're looking for guidance about where to begin contributing, if you have an idea you're not sure fits the project, or if you just want to ask a question or say hello.

                                                                                  Slack is free to download, and our workspace is free to sign up.

                                                                                  try logo

                                                                                  Try via npm

                                                                                  The npm package wrapper is cross-platform wrapper around the .jar artifact.

                                                                                  Install globally, exposing the CLI on the command line:


                                                                                  # install the latest version of "openapi-generator-cli"
                                                                                  npm install @openapitools/openapi-generator-cli -g

                                                                                  # use a specific version of "openapi-generator-cli"
                                                                                  openapi-generator-cli version-manager set 7.9.0

                                                                                  # Or install it as dev-dependency in your node.js projects
                                                                                  npm install @openapitools/openapi-generator-cli -D

                                                                                  Then, generate a ruby client from a valid petstore.yaml doc:


                                                                                                  openapi-generator-cli generate -i petstore.yaml -g ruby -o /tmp/test/

                                                                                  tryHomebrew logo

                                                                                  Try via Homebrew

                                                                                  Install via homebrew:

                                                                                  brew install openapi-generator

                                                                                  Then, generate a ruby client from a valid petstore.yaml doc:

                                                                                  openapi-generator generate -i petstore.yaml -g ruby -o /tmp/test/

                                                                                  tryDocker logo

                                                                                  Try via Docker

                                                                                  The OpenAPI Generator image acts as a standalone executable. It can be used as an alternative to installing via homebrew, or for developers who are unable to install Java or upgrade the installed version.

                                                                                  To generate code from a valid petstore.yaml doc with this image, you'll need to mount a local location as a volume.


                                                                                  docker run --rm \
                                                                                      -v $PWD:/local openapitools/openapi-generator-cli generate \
                                                                                      -i /local/petstore.yaml \
                                                                                      -g go \
                                                                                      -o /local/out/go

                                                                                  For a full list of our docker images, check out u/openapitools on Docker Hub.

                                                                                  Who is Using This?

                                                                                  Here are some users of OpenAPI Generator

                                                                                  ASKULBithost GmbHGiant Monkey GmbHJustStarMetaswitchStingrayTelstraunblu inc.WSO2Zalando
                                                                                  More OpenAPI Generator Users
                                                                                  "OpenAPI Tools" and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI)
                                                                                  + \ No newline at end of file diff --git a/search/index.html b/search/index.html index 40b6614afbc..e8b1c214712 100644 --- a/search/index.html +++ b/search/index.html @@ -15,13 +15,13 @@ - +

                                                                                  Search the documentation

                                                                                  - + \ No newline at end of file diff --git a/team/index.html b/team/index.html index 876357a2c85..d4596c6a9f4 100644 --- a/team/index.html +++ b/team/index.html @@ -15,13 +15,13 @@ - +

                                                                                  Core Team

                                                                                  William Cheng

                                                                                  William Cheng

                                                                                  (2015/07)
                                                                                  Jim Schubert

                                                                                  Jim Schubert

                                                                                  (2016/05)
                                                                                  Christopher Bornet

                                                                                  Christopher Bornet

                                                                                  (2016/05)
                                                                                  Jérémie Bresson

                                                                                  Jérémie Bresson

                                                                                  (2018/04)
                                                                                  sunn

                                                                                  sunn

                                                                                  (2019/06)
                                                                                  - + \ No newline at end of file diff --git a/users.html b/users.html index f4a71b8f618..e9be91cc913 100644 --- a/users.html +++ b/users.html @@ -15,13 +15,13 @@ - +
                                                                                  - + \ No newline at end of file diff --git a/users/index.html b/users/index.html index 9bbc6f0efb4..eb1f0b46551 100644 --- a/users/index.html +++ b/users/index.html @@ -15,13 +15,13 @@ - +

                                                                                  Who is Using This?

                                                                                  Here are some of our users. To add your company, click "Edit this page" below.

                                                                                  Aalborg UniversityAdaptant Solutions AGadesso SEAdyenAgodaAllianzAngular.SchuleANZArduinoASKULaspectivoAmazon Web Services (AWS)b<>com百度营销BandwidthBanzai CloudBIMData.ioBithost GmbHBosch Connected IndustryBoxeverBunker Holding GroupCalifornia State University, NorthridgeCAMCamptocampCarlsberg GroupCiscocodecentric AGCoinAPIConfigCatCommencisCrossover HealthCupixDatadogDB SystelDocSpringDeeproute.aiDevelocitydmTECH GmbHdwangoEdge ImpulseElastic EmailElement AIemineofastlyFenergoFlipkartFiNC TechnologiesfreeeFreshCellsFuseGantnerGetYourGuideGiant Monkey GmbHGlovoGMO PepaboGoDaddyGumtreeHereIBMJustStark6.ioKlarnaLandeshauptstadt München - it@MLinodeKronsoft DevelopmentKubernetesKurusugawa Computer Inc.LVM VersicherungenLumerisM3, Inc.MailSlurpMastercardMédiavisionMetaswitchMoonVisionMyworkoutNamSorNokiaOneSignalOptions Clearing Corporation (OCC)OpenetOPTiMOraclePaxosPassgenau DigitalPLAID, Inc.PlaidPinterestPonicodePricefxPrometheus/AlertmanagerPTV GroupPuppetQoveryQulix SystemsRaksulRaiffeisen Schweiz GenossenschaftRedHatRepreZen API StudioREST UnitedRobocorpSearchApiShotstackSmartHRSony Interactive EntertainmentSplititStingraySumUpSuvaSvixTelstraTencentThe University of AizuTileDBTINQINTravelTime platformTribalScaleTUI InfoTec GmbHTwilioTwitterunblu inc.VeamlyviadeeVMwareVonageVouchery.iowbt-solutionswe-make.aiWoleetWSO2XeroYahoo! JapanYITU TechnologyYelpZalandoZOZO Technologies3DS OUTSCALE
                                                                                  Edit this page
                                                                                  - + \ No newline at end of file