openapi: 3.2.0
info:
  title: Swagger Codegen Servers API
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
  description: 'Operations tagged servers across 2 of this provider''s published API definitions: swagger-generator-v2-swagger-original.json, swagger-generator-v3-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://generator.swagger.io/api
- url: /api
tags:
- name: servers
paths:
  /gen/download/{fileId}:
    get:
      tags:
      - servers
      summary: Downloads a pre-generated file
      description: A valid `fileId` is generated by the `/clients/{language}` or `/servers/{language}` POST operations.  The fileId code can be used just once, after which a new `fileId` will need to be requested.
      operationId: downloadFile
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/octet-stream:
              schema:
                type: string
    servers:
    - url: https://generator.swagger.io/api
  /gen/servers/{framework}:
    get:
      tags:
      - servers
      summary: Returns options for a server framework
      description: ''
      operationId: getServerOptions
      parameters:
      - name: framework
        in: path
        description: The target language for the server framework
        required: true
        schema:
          type: string
          enum:
          - ada-server
          - aspnetcore
          - erlang-server
          - finch
          - go-server
          - haskell
          - inflector
          - java-pkmst
          - java-play-framework
          - java-vertx
          - jaxrs
          - jaxrs-cxf
          - jaxrs-cxf-cdi
          - jaxrs-resteasy
          - jaxrs-resteasy-eap
          - jaxrs-spec
          - kotlin-server
          - lumen
          - msf4j
          - nancyfx
          - nodejs-server
          - php-silex
          - php-symfony
          - pistache-server
          - python-flask
          - rails5
          - restbed
          - rust-server
          - scala-lagom-server
          - scalatra
          - sinatra
          - slim
          - spring
          - undertow
          - ze-ph
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/CliOption'
    post:
      tags:
      - servers
      summary: Generates a server library
      description: Accepts a `GeneratorInput` options map for spec location and generation options.
      operationId: generateServerForLanguage
      parameters:
      - name: framework
        in: path
        description: framework
        required: true
        schema:
          type: string
          enum:
          - ada-server
          - aspnetcore
          - erlang-server
          - finch
          - go-server
          - haskell
          - inflector
          - java-pkmst
          - java-play-framework
          - java-vertx
          - jaxrs
          - jaxrs-cxf
          - jaxrs-cxf-cdi
          - jaxrs-resteasy
          - jaxrs-resteasy-eap
          - jaxrs-spec
          - kotlin-server
          - lumen
          - msf4j
          - nancyfx
          - nodejs-server
          - php-silex
          - php-symfony
          - pistache-server
          - python-flask
          - rails5
          - restbed
          - rust-server
          - scala-lagom-server
          - scalatra
          - sinatra
          - slim
          - spring
          - undertow
          - ze-ph
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseCode'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GeneratorInput'
        description: parameters
        required: true
    servers:
    - url: https://generator.swagger.io/api
  /gen/servers:
    get:
      tags:
      - servers
      summary: Gets languages supported by the server generator
      description: ''
      operationId: serverOptions
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
    servers:
    - url: https://generator.swagger.io/api
  /servers:
    get:
      tags:
      - servers
      summary: Deprecated, use '/{type}/{version}' instead. List generator languages of type 'server' for given codegen version (defaults to V3)
      operationId: serverLanguages
      parameters:
      - $ref: '#/components/parameters/version'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      deprecated: true
      x-swagger-router-controller: io.swagger.v3.generator.online.GeneratorController
    servers:
    - url: /api
components:
  schemas:
    GeneratorInput:
      type: object
      properties:
        spec:
          type: object
        options:
          type: object
          additionalProperties:
            type: string
        swaggerUrl:
          type: string
          example: http://petstore.swagger.io/v2/swagger.json
        authorizationValue:
          $ref: '#/components/schemas/AuthorizationValue'
        usingFlattenSpec:
          type: boolean
        securityDefinition:
          $ref: '#/components/schemas/SecuritySchemeDefinition'
    ResponseCode:
      type: object
      properties:
        code:
          type: string
          example: d40029be-eda6-4d62-b1ef-d05e2e91a72a
          description: File download code
        link:
          type: string
          example: http://generator.swagger.io:80/api/gen/download/d40029be-eda6-4d62-b1ef-d05e2e91a72a
          description: URL for fetching the generated client
    AuthorizationValue:
      type: object
      properties:
        value:
          type: string
        type:
          type: string
        keyName:
          type: string
        urlMatcher:
          $ref: '#/components/schemas/UrlMatcher'
    CliOption:
      type: object
      properties:
        optionName:
          type: string
        description:
          type: string
        type:
          type: string
          description: Data type is based on the types supported by the JSON-Schema
        enum:
          type: object
          additionalProperties:
            type: string
        default:
          type: string
    SecuritySchemeDefinition:
      type: object
      properties:
        type:
          type: string
        description:
          type: string
    UrlMatcher:
      type: object
  parameters:
    version:
      name: version
      in: query
      description: generator version used by codegen engine
      schema:
        type: string
        enum:
        - V2
        - V3
x-refined-from:
- swagger-generator-v2-swagger-original.json
- swagger-generator-v3-openapi-original.json