Code generation: add comments and deprecation note (#277)

* Generate comments and deprecation info * Generate comments and deprecation info * Generate comments and deprecation info * Run codeql on cronjob
Adyen · Nov 11, 2024 · e355440 · e355440
1 parent d983811
commit e355440
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 4 deletions.
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -1,10 +1,6 @@
 name: "CodeQL"
 
 on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
   schedule:
     - cron: "40 12 * * 0"
 

diff --git a/templates/api-single.mustache b/templates/api-single.mustache
@@ -5,6 +5,11 @@ require_relative '{{serviceName}}/{{#lambda.snakecase}}{{classname}}{{/lambda.sn
     {{/apiInfo}}
 
 module Adyen
+
+  # NOTE: This class is auto generated by OpenAPI Generator
+  # Ref: https://openapi-generator.tech
+  #
+  # Do not edit the class manually.
   class {{#lambda.titlecase}}{{serviceName}}{{/lambda.titlecase}}
     attr_accessor :service, :version
 

diff --git a/templates/api-small.mustache b/templates/api-small.mustache
@@ -1,6 +1,11 @@
 require_relative './service'
 module Adyen
 {{#operations}}
+
+  # NOTE: This class is auto generated by OpenAPI Generator
+  # Ref: https://openapi-generator.tech
+  #
+  # Do not edit the class manually.
   class {{#lambda.titlecase}}{{serviceName}}{{/lambda.titlecase}} < Service
     attr_accessor :service, :version
 
@@ -10,6 +15,10 @@ module Adyen
     end
 
 {{#operation}}
+    # {{{summary}}}{{^summary}}{{operationId}}{{/summary}}{{#isDeprecated}}
+    #
+    # Deprecated {{#vendorExtensions.x-deprecatedInVersion}}since {{#appName}}{{{.}}}{{/appName}} v{{.}}{{/vendorExtensions.x-deprecatedInVersion}}{{#vendorExtensions.x-deprecatedMessage}}
+    # {{{.}}}{{/vendorExtensions.x-deprecatedMessage}}{{/isDeprecated}}
     def {{#lambda.snakecase}}{{#vendorExtensions.x-methodName}}{{.}}{{/vendorExtensions.x-methodName}}{{^vendorExtensions.x-methodName}}{{nickname}}{{/vendorExtensions.x-methodName}}{{/lambda.snakecase}}({{#bodyParams}}request, {{/bodyParams}}{{#requiredParams}}{{^isQueryParam}}{{#lambda.snakecase}}{{paramName}}{{/lambda.snakecase}}, {{/isQueryParam}}{{/requiredParams}}headers: {}{{#queryParams}}{{#-first}}, query_params: {}{{/-first}}{{/queryParams}})
       endpoint = '{{path}}'.gsub(/{.+?}/, '%s')
       endpoint = endpoint.gsub(%r{^/}, '')

diff --git a/templates/api.mustache b/templates/api.mustache
@@ -1,6 +1,11 @@
 require_relative '../service'
 module Adyen
 {{#operations}}
+
+  # NOTE: This class is auto generated by OpenAPI Generator
+  # Ref: https://openapi-generator.tech
+  #
+  # Do not edit the class manually.
   class {{classname}} < Service
     attr_accessor :service, :version
 
@@ -9,6 +14,10 @@ module Adyen
     end
 
 {{#operation}}
+    # {{{summary}}}{{^summary}}{{operationId}}{{/summary}}{{#isDeprecated}}
+    #
+    # Deprecated {{#vendorExtensions.x-deprecatedInVersion}}since {{#appName}}{{{.}}}{{/appName}} v{{.}}{{/vendorExtensions.x-deprecatedInVersion}}{{#vendorExtensions.x-deprecatedMessage}}
+    # {{{.}}}{{/vendorExtensions.x-deprecatedMessage}}{{/isDeprecated}}
     def {{#lambda.snakecase}}{{#vendorExtensions.x-methodName}}{{.}}{{/vendorExtensions.x-methodName}}{{^vendorExtensions.x-methodName}}{{nickname}}{{/vendorExtensions.x-methodName}}{{/lambda.snakecase}}({{#bodyParams}}request, {{/bodyParams}}{{#requiredParams}}{{^isQueryParam}}{{#lambda.snakecase}}{{paramName}}{{/lambda.snakecase}}, {{/isQueryParam}}{{/requiredParams}}headers: {}{{#queryParams}}{{#-first}}, query_params: {}{{/-first}}{{/queryParams}})
       endpoint = '{{path}}'.gsub(/{.+?}/, '%s')
       endpoint = endpoint.gsub(%r{^/}, '')