docs(gdscript): document petstore server ADR

Author: Goutte

bin/configs/gdscript-petstore.yaml

@@ -2,18 +2,33 @@
 #     bin/generate-samples.sh bin/configs/gdscript-petstore.yaml
 
 generatorName: gdscript
+
+# We output straight into an addon directory. (any addon name will work)
+# The addon need not be enabled in Project Settings to be used, for now,
+# but that may change, so as best practice you should enable it anyway.
 outputDir: samples/client/petstore/gdscript/addons/oas.petstore.client
+
 # We have two test servers available.
 # See https://github.com/OpenAPITools/openapi-generator/wiki/Integration-Tests
+
 # A: Newer, recommended echo server OAS, that we're failing for now:
 # Exception: Could not process model 'Bird'. Please make sure that your schema is correct!
 # Caused by: java.lang.RuntimeException: reserved word color not allowed
+# Perhaps try this again later, using another config file like gdscript-echo.yaml
 #inputSpec: modules/openapi-generator/src/test/resources/3_0/echo_api.yaml
+
 # B: Older (legacy, deprecated) petstore server OAS
 inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
+
 templateDir: modules/openapi-generator/src/main/resources/gdscript
+
 additionalProperties:
+  # Timestamping the generated sample project would only add noise to git
   hideGenerationTimestamp: "true"
+  # Since we're polluting the global namespace with class_name (it's really convenient),
+  # we can use these prefixes to namespace the generated classes.
+  # Best make sure the words you use here are not part of the domain of Godot.
+  # It's a bit cumbersome to have to add all three (idea: globalNamePrefix as sugar?)
   apiNamePrefix: Demo
   modelNamePrefix: Demo
   coreNamePrefix: Demo

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/GdscriptClientCodegen.java

@@ -281,7 +281,7 @@ public String modelDocFileFolder() {
     @Override
     public String escapeUnsafeCharacters(String input) {
         // There might be ways to inject code in Gdscript, but I don't see any for now.  (no /* */ comments)
-        // TODO: review this with someone knowledgeable
+        // TODO: review this can of worms with someone knowledgeable
         return input;
     }
 
@@ -377,14 +377,12 @@ public Map<String, ModelsMap> updateAllModels(Map<String, ModelsMap> objs) {
 
     protected List<String> getReservedWords() {
         return Arrays.asList(
-                // Local properties used in Model classes
-                "bee_class_name",
                 // Local method names used in base API class
-                "bee_connect_client_if_needed", "bee_request", "_bee_request_text", "_bee_do_request_text",
-                "_bee_convert_http_method", "_bee_urlize_path_param", "_bee_escape_path_param",
-                "_bee_next_loop_iteration", "_bee_get_content_type", "_bee_format_error_response",
+                "_bzz_connect_client_if_needed", "bzz_request", "_bzz_request_text", "_bzz_do_request_text",
+                "_bzz_convert_http_method", "_bzz_urlize_path_param", "_bzz_escape_path_param",
+                "_bzz_next_loop_iteration", "_bzz_get_content_type", "_bzz_format_error_response",
                 // Local properties used in base API class
-                "bee_config", "bee_client", "bee_name",
+                "_bzz_config", "_bzz_client", "_bzz_name",
                 // Local variable names used in API methods (endpoints)
                 "bzz_method", "bzz_path", "bzz_query",
                 "bzz_result", "bzz_code", "bzz_headers",

samples/client/petstore/gdscript/README.md

@@ -7,10 +7,24 @@
 - Returns non-zero exit code upon test failure
 - Uses [GUT] as test engine
 
+
+## Prepare the test server
+
+See https://github.com/OpenAPITools/openapi-generator/wiki/Integration-Tests
+
+> We are using the petstore docker, not the echo server for now.
+> Feel free to refactor or duplicate the sample demo to use the new echo server.
+> See `bin/configs/gdscript-petstore.yaml`.
+
+
 ## Run
 
 	godot --headless samples/client/petstore/gdscript
 
+The command should return a zero exit code if all tests passed.
+You may want to add `--verbose` for more logs when debugging.
+
+
 ## Update
 
 Refresh the generated files, after modifying the gdscript templates or java generator:

samples/client/petstore/gdscript/addons/oas.petstore.client/.openapi-generator/VERSION

@@ -1 +1 @@
-6.2.1-SNAPSHOT
+6.6.0-SNAPSHOT

samples/client/petstore/gdscript/addons/oas.petstore.client/README.md

@@ -100,13 +100,6 @@ Class | Method | HTTP request | Description
 ## Documentation For Authorization
 
 
-## api_key
-
-- **Type**: API key
-- **API key parameter name**: api_key
-- **Location**: HTTP header
-
- Authentication schemes defined for the API:
 ## petstore_auth
 
 - **Type**: OAuth
@@ -116,6 +109,13 @@ Class | Method | HTTP request | Description
  - **write:pets**: modify pets in your account
  - **read:pets**: read your pets
 
+ Authentication schemes defined for the API:
+## api_key
+
+- **Type**: API key
+- **API key parameter name**: api_key
+- **Location**: HTTP header
+
 
 
 ## Troubleshooting

samples/client/petstore/gdscript/addons/oas.petstore.client/apis/DemoPetApi.md

@@ -405,8 +405,8 @@ api.upload_file(
 
 ### Authorization
 
-[api_key](../README.md#api_key), 
-[petstore_auth](../README.md#petstore_auth)
+[petstore_auth](../README.md#petstore_auth), 
+[api_key](../README.md#api_key)
 
 [[Back to top]](#__pageTop) \
 [[Back to API list]](../README.md#documentation-for-api-endpoints) \

samples/client/petstore/gdscript/addons/oas.petstore.client/apis/DemoStoreApi.md

@@ -194,8 +194,8 @@ api.place_order(
 
 ### Authorization
 
-[api_key](../README.md#api_key), 
-[petstore_auth](../README.md#petstore_auth)
+[petstore_auth](../README.md#petstore_auth), 
+[api_key](../README.md#api_key)
 
 [[Back to top]](#__pageTop) \
 [[Back to API list]](../README.md#documentation-for-api-endpoints) \

samples/client/petstore/gdscript/addons/oas.petstore.client/apis/DemoUserApi.md

@@ -391,8 +391,8 @@ api.update_user(
 
 ### Authorization
 
-[api_key](../README.md#api_key), 
-[petstore_auth](../README.md#petstore_auth)
+[petstore_auth](../README.md#petstore_auth), 
+[api_key](../README.md#api_key)
 
 [[Back to top]](#__pageTop) \
 [[Back to API list]](../README.md#documentation-for-api-endpoints) \

samples/client/petstore/gdscript/addons/oas.petstore.client/core/DemoApiConfig.gd

@@ -130,13 +130,13 @@ func log_debug(message: String):
 		print(message)
 
 
+# Authentication method `petstore_auth`.
+# → Skipped: not implemented in the gdscript templates.  (contribs welcome)
+
+
 # Authentication method `api_key`.
 # Api Key Authentication `api_key`
 func set_security_api_key(value: String):
 	self.headers_base["api_key"] = value
 
 
-# Authentication method `petstore_auth`.
-# → Skipped: not implemented in the gdscript templates.  (contribs welcome)
-
-