Merge pull request #7901 from swagger-api/generator-service-endpoints-changes

updated /clients and /servers operation ids.

Author: HugoMario

modules/swagger-generator/openapi.yaml

@@ -13,6 +13,8 @@ info:
 tags:
   - name: developers
     description: Operations available to regular developers
+  - name: clients
+  - name: servers
 paths:
   /generate:
     get:
@@ -82,8 +84,10 @@ paths:
 
   /clients:
     get:
+      tags:
+      - "clients"
       x-swagger-router-controller: "io.swagger.generator.online.GeneratorController"
-      operationId: getClients
+      operationId: clientOptions
       responses:
         200:
           description: successful operation
@@ -95,8 +99,10 @@ paths:
                   type: string
   /servers:
     get:
+      tags:
+      - "servers"
       x-swagger-router-controller: "io.swagger.generator.online.GeneratorController"
-      operationId: getServers
+      operationId: serverOptions
       responses:
         200:
           description: successful operation

modules/swagger-generator/src/main/java/io/swagger/generator/online/GeneratorController.java

@@ -49,14 +49,14 @@ public class GeneratorController {
         Collections.sort(SERVERS, String.CASE_INSENSITIVE_ORDER);
     }
 
-    public ResponseContext getClients(RequestContext requestContext) {
+    public ResponseContext clientOptions(RequestContext requestContext) {
         return new ResponseContext()
                 .status(Response.Status.OK.getStatusCode())
                 .entity(CLIENTS);
 
     }
 
-    public ResponseContext getServers(RequestContext requestContext) {
+    public ResponseContext serverOptions(RequestContext requestContext) {
         return new ResponseContext()
                 .status(Response.Status.OK.getStatusCode())
                 .entity(SERVERS);

modules/swagger-generator/src/main/resources/generator.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","servers":[{"url":"/v2"}],"info":{"description":"codegen generator server API","version":"1.0.0","title":"Generator API","contact":{"email":"[email protected]"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"tags":[{"name":"developers","description":"Operations available to regular developers"},{"name":"clients"},{"name":"servers"}],"paths":{"/generate":{"get":{"x-swagger-router-controller":"io.swagger.generator.online.GeneratorController","operationId":"generateFiles","parameters":[{"name":"argumentsUrl","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}},"post":{"x-swagger-router-controller":"io.swagger.generator.online.GeneratorController","operationId":"generate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationRequest"}}}},"responses":{"200":{"description":"successful operation","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}},"/generate/{language}":{"get":{"x-swagger-router-controller":"io.swagger.generator.online.GeneratorController","operationId":"generate","parameters":[{"name":"language","in":"path","description":"language to generate","required":true,"schema":{"type":"string"}},{"name":"specUrl","in":"query","description":"spec url location","required":true,"schema":{"type":"string"}},{"name":"library","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}},"/clients":{"get":{"tags":["clients"],"x-swagger-router-controller":"io.swagger.generator.online.GeneratorController","operationId":"clientOptions","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/servers":{"get":{"tags":["servers"],"x-swagger-router-controller":"io.swagger.generator.online.GeneratorController","operationId":"serverOptions","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}},"components":{"schemas":{"GenerationRequest":{"x-swagger-router-model":"io.swagger.generator.model.GenerationRequest","required":["spec","options"],"properties":{"spec":{"type":"object","description":"spec in json format."},"options":{"$ref":"#/components/schemas/Options"}}},"Options":{"x-swagger-router-model":"io.swagger.generator.model.Options","required":["lang"],"properties":{"lang":{"type":"string","title":"language","description":"client language to generate (maybe class name in classpath, required)","example":"java"},"auth":{"type":"string","title":"authorization","description":"adds authorization headers when fetching the open api 3 definitions remotely. Pass in a URL-encoded string of name:header with a comma separating multiple values"},"apiPackage":{"type":"string","title":"api package","description":"package for generated api classes"},"templateVersion":{"type":"string","title":"Template Version","description":"template version for generation"},"modelPackage":{"type":"string","title":"model package","description":"package for generated models"},"modelNamePrefix":{"type":"string","title":"model name prefix","description":"Prefix that will be prepended to all model names. Default is the empty string."},"modelNameSuffix":{"type":"string","title":"model name suffix","description":"PrefixSuffix that will be appended to all model names. Default is the empty string."},"systemProperties":{"type":"array","items":{"type":"string"},"title":"System Properties","description":"sets specified system properties in the format of name=value,name=value (or multiple options, each with name=value)"},"instantiationTypes":{"type":"array","items":{"type":"string"},"title":"instantiation types","description":"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."},"typeMappings":{"type":"array","items":{"type":"string"},"title":"type mappings","description":"sets mappings between swagger spec types and generated code types in the format of swaggerType=generatedType,swaggerType=generatedType. For example: array=List,map=Map,string=String. You can also have multiple occurrences of this option."},"additionalProperties":{"type":"array","items":{"type":"string"},"title":"additional properties","description":"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."},"languageSpecificPrimitives":{"type":"array","items":{"type":"string"},"title":"language specific primitives","description":"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."},"importMappings":{"type":"array","items":{"type":"string"},"title":"import mappings","description":"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."},"invokerPackage":{"type":"string","title":"invoker package","description":"root package for generated code"},"groupId":{"type":"string","title":"group id","description":"groupId in generated pom.xml"},"artifactId":{"type":"string","title":"artifact id","description":"artifactId in generated pom.xml"},"artifactVersion":{"type":"string","title":"artifact version","description":"artifact version generated in pom.xml"},"library":{"type":"string","title":"library","description":"library template (sub-template)"},"gitUserId":{"type":"string","title":"git user id","description":"Git user ID, e.g. swagger-api."},"gitRepoId":{"type":"string","title":"git repo id","description":"Git repo ID, e.g. swagger-codegen."},"releaseNote":{"type":"string","title":"release note","description":"Release note, default to 'Minor update'."},"httpUserAgent":{"type":"string","title":"http user agent","description":"HTTP user agent, e.g. codegen_csharp_api_client, default to 'Swagger-Codegen/{packageVersion}}/{language}'"},"reservedWordsMappings":{"type":"array","items":{"type":"string"},"title":"reserved words mappings","description":"pecifies 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."},"ignoreFileOverride":{"type":"string","title":"ignore file override location","description":"Specifies an override location for the .swagger-codegen-ignore file. Most useful on initial generation."},"removeOperationIdPrefix":{"type":"boolean","title":"remove prefix of the operationId","description":"Remove prefix of operationId, e.g. config_getId => getId"}}}}}}