github.com/antihax/goesi@v0.0.0-20240126031043-6c54d0cb7f95/meta/api/swagger.yaml (about)

     1  ---
     2  swagger: "2.0"
     3  info:
     4    description: "ESI specs and miscellaneous routes"
     5    version: "0.1"
     6    title: "ESI Meta Spec"
     7  host: "esi.evetech.net"
     8  schemes:
     9  - "https"
    10  produces:
    11  - "application/json"
    12  - "text/plain; charset=utf-8"
    13  - "text/html; charset=utf-8"
    14  paths:
    15    /_dev/swagger.json:
    16      get:
    17        tags:
    18        - "Swagger"
    19        summary: "Get _dev spec (versioned)"
    20        description: "The _dev ESI swagger specification. The underscore swagger specs\
    21          \ do not have a basePath, giving you an easy way to generate stable clients\
    22          \ on versioned routes."
    23        operationId: "get__dev_swagger"
    24        produces:
    25        - "application/json"
    26        parameters:
    27        - name: "user_agent"
    28          in: "query"
    29          description: "Client identifier, takes precedence over headers"
    30          required: false
    31          type: "string"
    32          x-exportParamName: "UserAgent"
    33          x-optionalDataType: "String"
    34        - name: "X-User-Agent"
    35          in: "header"
    36          description: "Client identifier, takes precedence over User-Agent"
    37          required: false
    38          type: "string"
    39          x-exportParamName: "XUserAgent"
    40          x-optionalDataType: "String"
    41        - name: "datasource"
    42          in: "query"
    43          description: "The server name you would like data from"
    44          required: false
    45          type: "string"
    46          default: "tranquility"
    47          enum:
    48          - "tranquility"
    49          x-exportParamName: "Datasource"
    50          x-optionalDataType: "String"
    51        responses:
    52          200:
    53            description: "ESI _dev swagger specification"
    54            schema:
    55              type: "object"
    56              description: "ESI _dev swagger 2.0 spec"
    57              title: "get__dev_swagger_ok"
    58              properties: {}
    59            headers:
    60              Cache-Control:
    61                type: "string"
    62                description: "The caching mechanism used"
    63              Expires:
    64                type: "string"
    65                description: "RFC7231 formatted datetime string"
    66              Last-Modified:
    67                type: "string"
    68                description: "RFC7231 formatted datetime string"
    69        x-cached-seconds: 60
    70    /_latest/swagger.json:
    71      get:
    72        tags:
    73        - "Swagger"
    74        summary: "Get _latest spec (versioned)"
    75        description: "The _latest ESI swagger specification. The underscore swagger\
    76          \ specs do not have a basePath, giving you an easy way to generate stable\
    77          \ clients on versioned routes."
    78        operationId: "get__latest_swagger"
    79        produces:
    80        - "application/json"
    81        parameters:
    82        - name: "user_agent"
    83          in: "query"
    84          description: "Client identifier, takes precedence over headers"
    85          required: false
    86          type: "string"
    87          x-exportParamName: "UserAgent"
    88          x-optionalDataType: "String"
    89        - name: "X-User-Agent"
    90          in: "header"
    91          description: "Client identifier, takes precedence over User-Agent"
    92          required: false
    93          type: "string"
    94          x-exportParamName: "XUserAgent"
    95          x-optionalDataType: "String"
    96        - name: "datasource"
    97          in: "query"
    98          description: "The server name you would like data from"
    99          required: false
   100          type: "string"
   101          default: "tranquility"
   102          enum:
   103          - "tranquility"
   104          x-exportParamName: "Datasource"
   105          x-optionalDataType: "String"
   106        responses:
   107          200:
   108            description: "ESI _latest swagger specification"
   109            schema:
   110              type: "object"
   111              description: "ESI _latest swagger 2.0 spec"
   112              title: "get__latest_swagger_ok"
   113              properties: {}
   114            headers:
   115              Cache-Control:
   116                type: "string"
   117                description: "The caching mechanism used"
   118              Expires:
   119                type: "string"
   120                description: "RFC7231 formatted datetime string"
   121              Last-Modified:
   122                type: "string"
   123                description: "RFC7231 formatted datetime string"
   124        x-cached-seconds: 60
   125    /_legacy/swagger.json:
   126      get:
   127        tags:
   128        - "Swagger"
   129        summary: "Get _legacy spec (versioned)"
   130        description: "The _legacy ESI swagger specification. The underscore swagger\
   131          \ specs do not have a basePath, giving you an easy way to generate stable\
   132          \ clients on versioned routes."
   133        operationId: "get__legacy_swagger"
   134        produces:
   135        - "application/json"
   136        parameters:
   137        - name: "user_agent"
   138          in: "query"
   139          description: "Client identifier, takes precedence over headers"
   140          required: false
   141          type: "string"
   142          x-exportParamName: "UserAgent"
   143          x-optionalDataType: "String"
   144        - name: "X-User-Agent"
   145          in: "header"
   146          description: "Client identifier, takes precedence over User-Agent"
   147          required: false
   148          type: "string"
   149          x-exportParamName: "XUserAgent"
   150          x-optionalDataType: "String"
   151        - name: "datasource"
   152          in: "query"
   153          description: "The server name you would like data from"
   154          required: false
   155          type: "string"
   156          default: "tranquility"
   157          enum:
   158          - "tranquility"
   159          x-exportParamName: "Datasource"
   160          x-optionalDataType: "String"
   161        responses:
   162          200:
   163            description: "ESI _legacy swagger specification"
   164            schema:
   165              type: "object"
   166              description: "ESI _legacy swagger 2.0 spec"
   167              title: "get__legacy_swagger_ok"
   168              properties: {}
   169            headers:
   170              Cache-Control:
   171                type: "string"
   172                description: "The caching mechanism used"
   173              Expires:
   174                type: "string"
   175                description: "RFC7231 formatted datetime string"
   176              Last-Modified:
   177                type: "string"
   178                description: "RFC7231 formatted datetime string"
   179        x-cached-seconds: 60
   180    /dev/swagger.json:
   181      get:
   182        tags:
   183        - "Swagger"
   184        summary: "Get dev swagger spec"
   185        description: "The dev ESI swagger specification."
   186        operationId: "get_dev_swagger"
   187        produces:
   188        - "application/json"
   189        parameters:
   190        - name: "user_agent"
   191          in: "query"
   192          description: "Client identifier, takes precedence over headers"
   193          required: false
   194          type: "string"
   195          x-exportParamName: "UserAgent"
   196          x-optionalDataType: "String"
   197        - name: "X-User-Agent"
   198          in: "header"
   199          description: "Client identifier, takes precedence over User-Agent"
   200          required: false
   201          type: "string"
   202          x-exportParamName: "XUserAgent"
   203          x-optionalDataType: "String"
   204        - name: "datasource"
   205          in: "query"
   206          description: "The server name you would like data from"
   207          required: false
   208          type: "string"
   209          default: "tranquility"
   210          enum:
   211          - "tranquility"
   212          x-exportParamName: "Datasource"
   213          x-optionalDataType: "String"
   214        responses:
   215          200:
   216            description: "ESI dev swagger specification"
   217            schema:
   218              type: "object"
   219              description: "ESI dev swagger 2.0 spec"
   220              title: "get_dev_swagger_ok"
   221              properties: {}
   222            headers:
   223              Cache-Control:
   224                type: "string"
   225                description: "The caching mechanism used"
   226              Expires:
   227                type: "string"
   228                description: "RFC7231 formatted datetime string"
   229              Last-Modified:
   230                type: "string"
   231                description: "RFC7231 formatted datetime string"
   232        x-cached-seconds: 60
   233    /diff/{version_a}/{version_b}/:
   234      get:
   235        tags:
   236        - "WebUI"
   237        summary: "Diff route"
   238        description: "Diff two ESI specs"
   239        operationId: "get_diff_version_a_version_b"
   240        produces:
   241        - "text/html; charset=utf-8"
   242        parameters:
   243        - name: "user_agent"
   244          in: "query"
   245          description: "Client identifier, takes precedence over headers"
   246          required: false
   247          type: "string"
   248          x-exportParamName: "UserAgent"
   249          x-optionalDataType: "String"
   250        - name: "X-User-Agent"
   251          in: "header"
   252          description: "Client identifier, takes precedence over User-Agent"
   253          required: false
   254          type: "string"
   255          x-exportParamName: "XUserAgent"
   256          x-optionalDataType: "String"
   257        - name: "datasource"
   258          in: "query"
   259          description: "The server name you would like data from"
   260          required: false
   261          type: "string"
   262          default: "tranquility"
   263          enum:
   264          - "tranquility"
   265          x-exportParamName: "Datasource"
   266          x-optionalDataType: "String"
   267        - name: "version_a"
   268          in: "path"
   269          description: "Swagger spec version to compare with"
   270          required: true
   271          type: "string"
   272          enum:
   273          - "_dev"
   274          - "_latest"
   275          - "_legacy"
   276          - "dev"
   277          - "latest"
   278          - "legacy"
   279          - "v1"
   280          - "v2"
   281          - "v3"
   282          - "v4"
   283          - "v5"
   284          - "v6"
   285          x-exportParamName: "VersionA"
   286        - name: "version_b"
   287          in: "path"
   288          description: "Swagger spec version to compare against"
   289          required: true
   290          type: "string"
   291          enum:
   292          - "_dev"
   293          - "_latest"
   294          - "_legacy"
   295          - "dev"
   296          - "latest"
   297          - "legacy"
   298          - "v1"
   299          - "v2"
   300          - "v3"
   301          - "v4"
   302          - "v5"
   303          - "v6"
   304          x-exportParamName: "VersionB"
   305        responses:
   306          200:
   307            description: "Diff results"
   308            schema:
   309              type: "string"
   310              description: "Diff HTML response"
   311              title: "get_diff_version_a_version_b_ok"
   312    /headers/:
   313      get:
   314        tags:
   315        - "Meta"
   316        summary: "Debug request headers"
   317        description: "Echo the request headers for debugging purposes. Note that the\
   318          \ 'Connection' header and any 'X-' headers are not included"
   319        operationId: "get_headers"
   320        produces:
   321        - "application/json"
   322        parameters: []
   323        responses:
   324          200:
   325            description: "Headers OK"
   326            schema:
   327              type: "object"
   328              description: "Headers response"
   329              title: "get_headers_ok"
   330              additionalProperties:
   331                type: "string"
   332    /latest/swagger.json:
   333      get:
   334        tags:
   335        - "Swagger"
   336        summary: "Get latest swagger spec"
   337        description: "The latest ESI swagger specification."
   338        operationId: "get_latest_swagger"
   339        produces:
   340        - "application/json"
   341        parameters:
   342        - name: "user_agent"
   343          in: "query"
   344          description: "Client identifier, takes precedence over headers"
   345          required: false
   346          type: "string"
   347          x-exportParamName: "UserAgent"
   348          x-optionalDataType: "String"
   349        - name: "X-User-Agent"
   350          in: "header"
   351          description: "Client identifier, takes precedence over User-Agent"
   352          required: false
   353          type: "string"
   354          x-exportParamName: "XUserAgent"
   355          x-optionalDataType: "String"
   356        - name: "datasource"
   357          in: "query"
   358          description: "The server name you would like data from"
   359          required: false
   360          type: "string"
   361          default: "tranquility"
   362          enum:
   363          - "tranquility"
   364          x-exportParamName: "Datasource"
   365          x-optionalDataType: "String"
   366        responses:
   367          200:
   368            description: "ESI latest swagger specification"
   369            schema:
   370              type: "object"
   371              description: "ESI latest swagger 2.0 spec"
   372              title: "get_latest_swagger_ok"
   373              properties: {}
   374            headers:
   375              Cache-Control:
   376                type: "string"
   377                description: "The caching mechanism used"
   378              Expires:
   379                type: "string"
   380                description: "RFC7231 formatted datetime string"
   381              Last-Modified:
   382                type: "string"
   383                description: "RFC7231 formatted datetime string"
   384        x-cached-seconds: 60
   385    /legacy/swagger.json:
   386      get:
   387        tags:
   388        - "Swagger"
   389        summary: "Get legacy swagger spec"
   390        description: "The legacy ESI swagger specification."
   391        operationId: "get_legacy_swagger"
   392        produces:
   393        - "application/json"
   394        parameters:
   395        - name: "user_agent"
   396          in: "query"
   397          description: "Client identifier, takes precedence over headers"
   398          required: false
   399          type: "string"
   400          x-exportParamName: "UserAgent"
   401          x-optionalDataType: "String"
   402        - name: "X-User-Agent"
   403          in: "header"
   404          description: "Client identifier, takes precedence over User-Agent"
   405          required: false
   406          type: "string"
   407          x-exportParamName: "XUserAgent"
   408          x-optionalDataType: "String"
   409        - name: "datasource"
   410          in: "query"
   411          description: "The server name you would like data from"
   412          required: false
   413          type: "string"
   414          default: "tranquility"
   415          enum:
   416          - "tranquility"
   417          x-exportParamName: "Datasource"
   418          x-optionalDataType: "String"
   419        responses:
   420          200:
   421            description: "ESI legacy swagger specification"
   422            schema:
   423              type: "object"
   424              description: "ESI legacy swagger 2.0 spec"
   425              title: "get_legacy_swagger_ok"
   426              properties: {}
   427            headers:
   428              Cache-Control:
   429                type: "string"
   430                description: "The caching mechanism used"
   431              Expires:
   432                type: "string"
   433                description: "RFC7231 formatted datetime string"
   434              Last-Modified:
   435                type: "string"
   436                description: "RFC7231 formatted datetime string"
   437        x-cached-seconds: 60
   438    /ping:
   439      get:
   440        tags:
   441        - "Meta"
   442        summary: "Ping route"
   443        description: "Ping the ESI routers"
   444        operationId: "get_ping"
   445        produces:
   446        - "text/plain; charset=utf-8"
   447        parameters: []
   448        responses:
   449          200:
   450            description: "Ping OK"
   451            schema:
   452              type: "string"
   453              description: "OK response"
   454              title: "get_ping_ok"
   455              enum:
   456              - "ok"
   457    /status.json:
   458      get:
   459        tags:
   460        - "Meta"
   461        summary: "ESI health status"
   462        description: "Provides a general health indicator per route and method"
   463        operationId: "get_status"
   464        produces:
   465        - "application/json"
   466        parameters:
   467        - name: "version"
   468          in: "query"
   469          description: "The version of metrics to request. Note that alternate versions\
   470            \ are grouped together"
   471          required: false
   472          type: "string"
   473          default: "latest"
   474          enum:
   475          - "latest"
   476          - "dev"
   477          - "legacy"
   478          - "meta"
   479          x-exportParamName: "Version"
   480          x-optionalDataType: "String"
   481        responses:
   482          200:
   483            description: "ESI Status"
   484            schema:
   485              type: "array"
   486              description: "ESI Status JSON"
   487              title: "get_status_ok"
   488              items:
   489                $ref: "#/definitions/get_status_item"
   490            headers:
   491              Cache-Control:
   492                type: "string"
   493                description: "The caching mechanism used"
   494              Expires:
   495                type: "string"
   496                description: "RFC7231 formatted datetime string"
   497              Last-Modified:
   498                type: "string"
   499                description: "RFC7231 formatted datetime string"
   500          404:
   501            description: "Unsupported version"
   502            schema:
   503              $ref: "#/definitions/get_status_not_found"
   504        x-cached-seconds: 60
   505    /swagger.json:
   506      get:
   507        tags:
   508        - "Swagger"
   509        summary: "Get meta swagger spec"
   510        description: "The meta ESI swagger specification."
   511        operationId: "get_meta_swagger"
   512        produces:
   513        - "application/json"
   514        parameters:
   515        - name: "user_agent"
   516          in: "query"
   517          description: "Client identifier, takes precedence over headers"
   518          required: false
   519          type: "string"
   520          x-exportParamName: "UserAgent"
   521          x-optionalDataType: "String"
   522        - name: "X-User-Agent"
   523          in: "header"
   524          description: "Client identifier, takes precedence over User-Agent"
   525          required: false
   526          type: "string"
   527          x-exportParamName: "XUserAgent"
   528          x-optionalDataType: "String"
   529        - name: "datasource"
   530          in: "query"
   531          description: "The server name you would like data from"
   532          required: false
   533          type: "string"
   534          default: "tranquility"
   535          enum:
   536          - "tranquility"
   537          x-exportParamName: "Datasource"
   538          x-optionalDataType: "String"
   539        responses:
   540          200:
   541            description: "ESI meta swagger specification"
   542            schema:
   543              type: "object"
   544              description: "ESI meta swagger 2.0 spec"
   545              title: "get_meta_swagger_ok"
   546              properties: {}
   547            headers:
   548              Cache-Control:
   549                type: "string"
   550                description: "The caching mechanism used"
   551              Expires:
   552                type: "string"
   553                description: "RFC7231 formatted datetime string"
   554              Last-Modified:
   555                type: "string"
   556                description: "RFC7231 formatted datetime string"
   557        x-cached-seconds: 60
   558    /ui/:
   559      get:
   560        tags:
   561        - "WebUI"
   562        summary: "SwaggerUI route (v3)"
   563        description: "ESI web UI. This is an open source project. If you find ESI web\
   564          \ UI specific bugs, please report them to https://github.com/esi/esi-swagger-ui/issues"
   565        operationId: "get_ui"
   566        produces:
   567        - "text/html; charset=utf-8"
   568        parameters:
   569        - name: "user_agent"
   570          in: "query"
   571          description: "Client identifier, takes precedence over headers"
   572          required: false
   573          type: "string"
   574          x-exportParamName: "UserAgent"
   575          x-optionalDataType: "String"
   576        - name: "X-User-Agent"
   577          in: "header"
   578          description: "Client identifier, takes precedence over User-Agent"
   579          required: false
   580          type: "string"
   581          x-exportParamName: "XUserAgent"
   582          x-optionalDataType: "String"
   583        - name: "datasource"
   584          in: "query"
   585          description: "The server name you would like data from"
   586          required: false
   587          type: "string"
   588          default: "tranquility"
   589          enum:
   590          - "tranquility"
   591          x-exportParamName: "Datasource"
   592          x-optionalDataType: "String"
   593        - name: "version"
   594          in: "query"
   595          description: "The Swagger spec version to display"
   596          required: false
   597          type: "string"
   598          default: "latest"
   599          enum:
   600          - "_dev"
   601          - "_latest"
   602          - "_legacy"
   603          - "dev"
   604          - "latest"
   605          - "legacy"
   606          - "v1"
   607          - "v2"
   608          - "v3"
   609          - "v4"
   610          - "v5"
   611          - "v6"
   612          x-exportParamName: "Version"
   613          x-optionalDataType: "String"
   614        responses:
   615          200:
   616            description: "v3 SwaggerUI"
   617            schema:
   618              type: "string"
   619              description: "ESI web UI"
   620              title: "get_ui_ok"
   621    /v1/swagger.json:
   622      get:
   623        tags:
   624        - "Swagger"
   625        summary: "Get v1 swagger spec"
   626        description: "The v1 ESI swagger specification."
   627        operationId: "get_v1_swagger"
   628        produces:
   629        - "application/json"
   630        parameters:
   631        - name: "user_agent"
   632          in: "query"
   633          description: "Client identifier, takes precedence over headers"
   634          required: false
   635          type: "string"
   636          x-exportParamName: "UserAgent"
   637          x-optionalDataType: "String"
   638        - name: "X-User-Agent"
   639          in: "header"
   640          description: "Client identifier, takes precedence over User-Agent"
   641          required: false
   642          type: "string"
   643          x-exportParamName: "XUserAgent"
   644          x-optionalDataType: "String"
   645        - name: "datasource"
   646          in: "query"
   647          description: "The server name you would like data from"
   648          required: false
   649          type: "string"
   650          default: "tranquility"
   651          enum:
   652          - "tranquility"
   653          x-exportParamName: "Datasource"
   654          x-optionalDataType: "String"
   655        responses:
   656          200:
   657            description: "ESI v1 swagger specification"
   658            schema:
   659              type: "object"
   660              description: "ESI v1 swagger 2.0 spec"
   661              title: "get_v1_swagger_ok"
   662              properties: {}
   663            headers:
   664              Cache-Control:
   665                type: "string"
   666                description: "The caching mechanism used"
   667              Expires:
   668                type: "string"
   669                description: "RFC7231 formatted datetime string"
   670              Last-Modified:
   671                type: "string"
   672                description: "RFC7231 formatted datetime string"
   673        x-cached-seconds: 60
   674    /v2/swagger.json:
   675      get:
   676        tags:
   677        - "Swagger"
   678        summary: "Get v2 swagger spec"
   679        description: "The v2 ESI swagger specification."
   680        operationId: "get_v2_swagger"
   681        produces:
   682        - "application/json"
   683        parameters:
   684        - name: "user_agent"
   685          in: "query"
   686          description: "Client identifier, takes precedence over headers"
   687          required: false
   688          type: "string"
   689          x-exportParamName: "UserAgent"
   690          x-optionalDataType: "String"
   691        - name: "X-User-Agent"
   692          in: "header"
   693          description: "Client identifier, takes precedence over User-Agent"
   694          required: false
   695          type: "string"
   696          x-exportParamName: "XUserAgent"
   697          x-optionalDataType: "String"
   698        - name: "datasource"
   699          in: "query"
   700          description: "The server name you would like data from"
   701          required: false
   702          type: "string"
   703          default: "tranquility"
   704          enum:
   705          - "tranquility"
   706          x-exportParamName: "Datasource"
   707          x-optionalDataType: "String"
   708        responses:
   709          200:
   710            description: "ESI v2 swagger specification"
   711            schema:
   712              type: "object"
   713              description: "ESI v2 swagger 2.0 spec"
   714              title: "get_v2_swagger_ok"
   715              properties: {}
   716            headers:
   717              Cache-Control:
   718                type: "string"
   719                description: "The caching mechanism used"
   720              Expires:
   721                type: "string"
   722                description: "RFC7231 formatted datetime string"
   723              Last-Modified:
   724                type: "string"
   725                description: "RFC7231 formatted datetime string"
   726        x-cached-seconds: 60
   727    /v3/swagger.json:
   728      get:
   729        tags:
   730        - "Swagger"
   731        summary: "Get v3 swagger spec"
   732        description: "The v3 ESI swagger specification."
   733        operationId: "get_v3_swagger"
   734        produces:
   735        - "application/json"
   736        parameters:
   737        - name: "user_agent"
   738          in: "query"
   739          description: "Client identifier, takes precedence over headers"
   740          required: false
   741          type: "string"
   742          x-exportParamName: "UserAgent"
   743          x-optionalDataType: "String"
   744        - name: "X-User-Agent"
   745          in: "header"
   746          description: "Client identifier, takes precedence over User-Agent"
   747          required: false
   748          type: "string"
   749          x-exportParamName: "XUserAgent"
   750          x-optionalDataType: "String"
   751        - name: "datasource"
   752          in: "query"
   753          description: "The server name you would like data from"
   754          required: false
   755          type: "string"
   756          default: "tranquility"
   757          enum:
   758          - "tranquility"
   759          x-exportParamName: "Datasource"
   760          x-optionalDataType: "String"
   761        responses:
   762          200:
   763            description: "ESI v3 swagger specification"
   764            schema:
   765              type: "object"
   766              description: "ESI v3 swagger 2.0 spec"
   767              title: "get_v3_swagger_ok"
   768              properties: {}
   769            headers:
   770              Cache-Control:
   771                type: "string"
   772                description: "The caching mechanism used"
   773              Expires:
   774                type: "string"
   775                description: "RFC7231 formatted datetime string"
   776              Last-Modified:
   777                type: "string"
   778                description: "RFC7231 formatted datetime string"
   779        x-cached-seconds: 60
   780    /v4/swagger.json:
   781      get:
   782        tags:
   783        - "Swagger"
   784        summary: "Get v4 swagger spec"
   785        description: "The v4 ESI swagger specification."
   786        operationId: "get_v4_swagger"
   787        produces:
   788        - "application/json"
   789        parameters:
   790        - name: "user_agent"
   791          in: "query"
   792          description: "Client identifier, takes precedence over headers"
   793          required: false
   794          type: "string"
   795          x-exportParamName: "UserAgent"
   796          x-optionalDataType: "String"
   797        - name: "X-User-Agent"
   798          in: "header"
   799          description: "Client identifier, takes precedence over User-Agent"
   800          required: false
   801          type: "string"
   802          x-exportParamName: "XUserAgent"
   803          x-optionalDataType: "String"
   804        - name: "datasource"
   805          in: "query"
   806          description: "The server name you would like data from"
   807          required: false
   808          type: "string"
   809          default: "tranquility"
   810          enum:
   811          - "tranquility"
   812          x-exportParamName: "Datasource"
   813          x-optionalDataType: "String"
   814        responses:
   815          200:
   816            description: "ESI v4 swagger specification"
   817            schema:
   818              type: "object"
   819              description: "ESI v4 swagger 2.0 spec"
   820              title: "get_v4_swagger_ok"
   821              properties: {}
   822            headers:
   823              Cache-Control:
   824                type: "string"
   825                description: "The caching mechanism used"
   826              Expires:
   827                type: "string"
   828                description: "RFC7231 formatted datetime string"
   829              Last-Modified:
   830                type: "string"
   831                description: "RFC7231 formatted datetime string"
   832        x-cached-seconds: 60
   833    /v5/swagger.json:
   834      get:
   835        tags:
   836        - "Swagger"
   837        summary: "Get v5 swagger spec"
   838        description: "The v5 ESI swagger specification."
   839        operationId: "get_v5_swagger"
   840        produces:
   841        - "application/json"
   842        parameters:
   843        - name: "user_agent"
   844          in: "query"
   845          description: "Client identifier, takes precedence over headers"
   846          required: false
   847          type: "string"
   848          x-exportParamName: "UserAgent"
   849          x-optionalDataType: "String"
   850        - name: "X-User-Agent"
   851          in: "header"
   852          description: "Client identifier, takes precedence over User-Agent"
   853          required: false
   854          type: "string"
   855          x-exportParamName: "XUserAgent"
   856          x-optionalDataType: "String"
   857        - name: "datasource"
   858          in: "query"
   859          description: "The server name you would like data from"
   860          required: false
   861          type: "string"
   862          default: "tranquility"
   863          enum:
   864          - "tranquility"
   865          x-exportParamName: "Datasource"
   866          x-optionalDataType: "String"
   867        responses:
   868          200:
   869            description: "ESI v5 swagger specification"
   870            schema:
   871              type: "object"
   872              description: "ESI v5 swagger 2.0 spec"
   873              title: "get_v5_swagger_ok"
   874              properties: {}
   875            headers:
   876              Cache-Control:
   877                type: "string"
   878                description: "The caching mechanism used"
   879              Expires:
   880                type: "string"
   881                description: "RFC7231 formatted datetime string"
   882              Last-Modified:
   883                type: "string"
   884                description: "RFC7231 formatted datetime string"
   885        x-cached-seconds: 60
   886    /v6/swagger.json:
   887      get:
   888        tags:
   889        - "Swagger"
   890        summary: "Get v6 swagger spec"
   891        description: "The v6 ESI swagger specification."
   892        operationId: "get_v6_swagger"
   893        produces:
   894        - "application/json"
   895        parameters:
   896        - name: "user_agent"
   897          in: "query"
   898          description: "Client identifier, takes precedence over headers"
   899          required: false
   900          type: "string"
   901          x-exportParamName: "UserAgent"
   902          x-optionalDataType: "String"
   903        - name: "X-User-Agent"
   904          in: "header"
   905          description: "Client identifier, takes precedence over User-Agent"
   906          required: false
   907          type: "string"
   908          x-exportParamName: "XUserAgent"
   909          x-optionalDataType: "String"
   910        - name: "datasource"
   911          in: "query"
   912          description: "The server name you would like data from"
   913          required: false
   914          type: "string"
   915          default: "tranquility"
   916          enum:
   917          - "tranquility"
   918          x-exportParamName: "Datasource"
   919          x-optionalDataType: "String"
   920        responses:
   921          200:
   922            description: "ESI v6 swagger specification"
   923            schema:
   924              type: "object"
   925              description: "ESI v6 swagger 2.0 spec"
   926              title: "get_v6_swagger_ok"
   927              properties: {}
   928            headers:
   929              Cache-Control:
   930                type: "string"
   931                description: "The caching mechanism used"
   932              Expires:
   933                type: "string"
   934                description: "RFC7231 formatted datetime string"
   935              Last-Modified:
   936                type: "string"
   937                description: "RFC7231 formatted datetime string"
   938        x-cached-seconds: 60
   939    /verify/:
   940      get:
   941        tags:
   942        - "Meta"
   943        summary: "Verify access token"
   944        description: "Verify authorization tokens in ESI's auth cache"
   945        operationId: "get_verify"
   946        produces:
   947        - "application/json"
   948        parameters:
   949        - name: "user_agent"
   950          in: "query"
   951          description: "Client identifier, takes precedence over headers"
   952          required: false
   953          type: "string"
   954          x-exportParamName: "UserAgent"
   955          x-optionalDataType: "String"
   956        - name: "X-User-Agent"
   957          in: "header"
   958          description: "Client identifier, takes precedence over User-Agent"
   959          required: false
   960          type: "string"
   961          x-exportParamName: "XUserAgent"
   962          x-optionalDataType: "String"
   963        - name: "datasource"
   964          in: "query"
   965          description: "The server name you would like data from"
   966          required: false
   967          type: "string"
   968          default: "tranquility"
   969          enum:
   970          - "tranquility"
   971          x-exportParamName: "Datasource"
   972          x-optionalDataType: "String"
   973        - name: "token"
   974          in: "query"
   975          description: "Access token to use if unable to set a header"
   976          required: false
   977          type: "string"
   978          x-exportParamName: "Token"
   979          x-optionalDataType: "String"
   980        - name: "Authorization"
   981          in: "header"
   982          description: "Access token, in the format of \"Bearer <access token>\""
   983          required: false
   984          type: "string"
   985          x-exportParamName: "Authorization"
   986          x-optionalDataType: "String"
   987        responses:
   988          200:
   989            description: "SSO /verify JSON response"
   990            schema:
   991              $ref: "#/definitions/get_verify_ok"
   992            headers:
   993              Cache-Control:
   994                type: "string"
   995                description: "The caching mechanism used"
   996              Expires:
   997                type: "string"
   998                description: "RFC7231 formatted datetime string"
   999              Last-Modified:
  1000                type: "string"
  1001                description: "RFC7231 formatted datetime string"
  1002          400:
  1003            description: "SSO /verify JSON error"
  1004            schema:
  1005              $ref: "#/definitions/get_verify_error"
  1006            headers:
  1007              Cache-Control:
  1008                type: "string"
  1009                description: "The caching mechanism used"
  1010              Expires:
  1011                type: "string"
  1012                description: "RFC7231 formatted datetime string"
  1013              Last-Modified:
  1014                type: "string"
  1015                description: "RFC7231 formatted datetime string"
  1016          401:
  1017            description: "Authorization not provided"
  1018            schema:
  1019              $ref: "#/definitions/get_verify_unauthorized"
  1020          404:
  1021            description: "Unsupported datasource"
  1022            schema:
  1023              $ref: "#/definitions/get_verify_not_found"
  1024        x-cached-seconds: 30
  1025    /versions/:
  1026      get:
  1027        tags:
  1028        - "Meta"
  1029        summary: "List versions"
  1030        description: "List all endpoint versions"
  1031        operationId: "get_versions"
  1032        produces:
  1033        - "application/json"
  1034        parameters:
  1035        - name: "user_agent"
  1036          in: "query"
  1037          description: "Client identifier, takes precedence over headers"
  1038          required: false
  1039          type: "string"
  1040          x-exportParamName: "UserAgent"
  1041          x-optionalDataType: "String"
  1042        - name: "X-User-Agent"
  1043          in: "header"
  1044          description: "Client identifier, takes precedence over User-Agent"
  1045          required: false
  1046          type: "string"
  1047          x-exportParamName: "XUserAgent"
  1048          x-optionalDataType: "String"
  1049        responses:
  1050          200:
  1051            description: "Version list"
  1052            schema:
  1053              type: "array"
  1054              description: "List of versions"
  1055              title: "get_versions_ok"
  1056              items:
  1057                type: "string"
  1058                description: "Available version"
  1059                title: "get_versions_version"
  1060            headers:
  1061              Cache-Control:
  1062                type: "string"
  1063                description: "The caching mechanism used"
  1064              Expires:
  1065                type: "string"
  1066                description: "RFC7231 formatted datetime string"
  1067              Last-Modified:
  1068                type: "string"
  1069                description: "RFC7231 formatted datetime string"
  1070        x-cached-seconds: 60
  1071  definitions:
  1072    get_verify_ok:
  1073      required:
  1074      - "CharacterID"
  1075      properties:
  1076        CharacterID:
  1077          type: "integer"
  1078          format: "int32"
  1079          description: "Token owner's character ID"
  1080          title: "get_verify_character_id"
  1081        CharacterName:
  1082          type: "string"
  1083          description: "Token owner's character name"
  1084          title: "get_verify_character_name"
  1085        CharacterOwnerHash:
  1086          type: "string"
  1087          description: "Hash of the character's owner. If the character is sold or otherwise\
  1088            \ transferred, this will change"
  1089          title: "get_verify_character_owner_hash"
  1090        ExpiresOn:
  1091          type: "string"
  1092          description: "Expiry time of the token (not RFC3339)"
  1093          title: "get_verify_expires_on"
  1094        IntellectualProperty:
  1095          type: "string"
  1096          description: "The IP which generated the token"
  1097          title: "get_verify_intellectual_property"
  1098        Scopes:
  1099          type: "string"
  1100          description: "Space separated list of scopes the token is valid for"
  1101          title: "get_verify_scopes"
  1102        TokenType:
  1103          type: "string"
  1104          description: "Type of access token"
  1105          title: "get_verify_token_type"
  1106      description: "SSO /verify JSON"
  1107      example:
  1108        TokenType: "TokenType"
  1109        IntellectualProperty: "IntellectualProperty"
  1110        Scopes: "Scopes"
  1111        CharacterID: 0
  1112        CharacterName: "CharacterName"
  1113        ExpiresOn: "ExpiresOn"
  1114        CharacterOwnerHash: "CharacterOwnerHash"
  1115    get_verify_error:
  1116      required:
  1117      - "error"
  1118      properties:
  1119        error:
  1120          type: "string"
  1121          description: "Generic error returned by SSO"
  1122          title: "get_verify_error_error"
  1123        error_description:
  1124          type: "string"
  1125          description: "Detailed error description from SSO"
  1126          title: "get_verify_error_description"
  1127      description: "SSO /verify JSON"
  1128    get_verify_unauthorized:
  1129      required:
  1130      - "error"
  1131      properties:
  1132        error:
  1133          type: "string"
  1134          description: "Authorization not provided"
  1135          title: "get_verify_unauthorized_error"
  1136      description: "Authorization not provided"
  1137    get_status_item:
  1138      required:
  1139      - "endpoint"
  1140      - "method"
  1141      - "route"
  1142      - "status"
  1143      - "tags"
  1144      properties:
  1145        endpoint:
  1146          type: "string"
  1147          description: "ESI Endpoint cluster advertising this route"
  1148          title: "get_status_endpoint"
  1149        method:
  1150          type: "string"
  1151          description: "Swagger defined method"
  1152          title: "get_status_method"
  1153        route:
  1154          type: "string"
  1155          description: "Swagger defined route, not including version prefix"
  1156          title: "get_status_route"
  1157        status:
  1158          type: "string"
  1159          description: "Vague route status. Green is good, yellow is degraded, meaning\
  1160            \ slow or potentially dropping requests. Red means most requests are not\
  1161            \ succeeding and/or are very slow (5s+) on average."
  1162          title: "get_status_status"
  1163          enum:
  1164          - "green"
  1165          - "yellow"
  1166          - "red"
  1167        tags:
  1168          type: "array"
  1169          description: "Swagger tags applicable to this route"
  1170          title: "get_status_tags"
  1171          items:
  1172            type: "string"
  1173            description: "Swagger tag"
  1174            title: "get_status_tag"
  1175      description: "Per route status"
  1176      example:
  1177        endpoint: "endpoint"
  1178        route: "route"
  1179        method: "method"
  1180        status: "green"
  1181        tags:
  1182        - "tags"
  1183        - "tags"
  1184    get_verify_not_found:
  1185      required:
  1186      - "error"
  1187      properties:
  1188        error:
  1189          type: "string"
  1190          description: "Unsupported datasource"
  1191          title: "get_verify_not_found_error"
  1192      description: "Unsupported datasource"
  1193    get_status_not_found:
  1194      required:
  1195      - "error"
  1196      properties:
  1197        error:
  1198          type: "string"
  1199          description: "Unsupported version"
  1200          title: "get_status_not_found_error"
  1201      description: "Unsupported version"
  1202  parameters:
  1203    Authorization:
  1204      name: "Authorization"
  1205      in: "header"
  1206      description: "Access token, in the format of \"Bearer <access token>\""
  1207      required: false
  1208      type: "string"
  1209      x-exportParamName: "Authorization"
  1210      x-optionalDataType: "String"
  1211    X-User-Agent:
  1212      name: "X-User-Agent"
  1213      in: "header"
  1214      description: "Client identifier, takes precedence over User-Agent"
  1215      required: false
  1216      type: "string"
  1217      x-exportParamName: "XUserAgent"
  1218      x-optionalDataType: "String"
  1219    datasource:
  1220      name: "datasource"
  1221      in: "query"
  1222      description: "The server name you would like data from"
  1223      required: false
  1224      type: "string"
  1225      default: "tranquility"
  1226      enum:
  1227      - "tranquility"
  1228      x-exportParamName: "Datasource"
  1229      x-optionalDataType: "String"
  1230    token:
  1231      name: "token"
  1232      in: "query"
  1233      description: "Access token to use if unable to set a header"
  1234      required: false
  1235      type: "string"
  1236      x-exportParamName: "Token"
  1237      x-optionalDataType: "String"
  1238    user_agent:
  1239      name: "user_agent"
  1240      in: "query"
  1241      description: "Client identifier, takes precedence over headers"
  1242      required: false
  1243      type: "string"
  1244      x-exportParamName: "UserAgent"
  1245      x-optionalDataType: "String"
  1246    version:
  1247      name: "version"
  1248      in: "query"
  1249      description: "The version of metrics to request. Note that alternate versions\
  1250        \ are grouped together"
  1251      required: false
  1252      type: "string"
  1253      default: "latest"
  1254      enum:
  1255      - "latest"
  1256      - "dev"
  1257      - "legacy"
  1258      - "meta"
  1259      x-exportParamName: "Version"
  1260      x-optionalDataType: "String"
  1261    version-ui:
  1262      name: "version"
  1263      in: "query"
  1264      description: "The Swagger spec version to display"
  1265      required: false
  1266      type: "string"
  1267      default: "latest"
  1268      enum:
  1269      - "_dev"
  1270      - "_latest"
  1271      - "_legacy"
  1272      - "dev"
  1273      - "latest"
  1274      - "legacy"
  1275      - "v1"
  1276      - "v2"
  1277      - "v3"
  1278      - "v4"
  1279      - "v5"
  1280      - "v6"
  1281      x-exportParamName: "Version"
  1282      x-optionalDataType: "String"
  1283    version_a:
  1284      name: "version_a"
  1285      in: "path"
  1286      description: "Swagger spec version to compare with"
  1287      required: true
  1288      type: "string"
  1289      enum:
  1290      - "_dev"
  1291      - "_latest"
  1292      - "_legacy"
  1293      - "dev"
  1294      - "latest"
  1295      - "legacy"
  1296      - "v1"
  1297      - "v2"
  1298      - "v3"
  1299      - "v4"
  1300      - "v5"
  1301      - "v6"
  1302      x-exportParamName: "VersionA"
  1303    version_b:
  1304      name: "version_b"
  1305      in: "path"
  1306      description: "Swagger spec version to compare against"
  1307      required: true
  1308      type: "string"
  1309      enum:
  1310      - "_dev"
  1311      - "_latest"
  1312      - "_legacy"
  1313      - "dev"
  1314      - "latest"
  1315      - "legacy"
  1316      - "v1"
  1317      - "v2"
  1318      - "v3"
  1319      - "v4"
  1320      - "v5"
  1321      - "v6"
  1322      x-exportParamName: "VersionB"