github.com/antihax/goesi@v0.0.0-20240126031043-6c54d0cb7f95/meta/docs/SwaggerApi.md (about)

     1  # \SwaggerApi
     2  
     3  All URIs are relative to *https://esi.evetech.net*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetDevSwagger**](SwaggerApi.md#GetDevSwagger) | **Get** /_dev/swagger.json | Get _dev spec (versioned)
     8  [**GetDevSwagger_0**](SwaggerApi.md#GetDevSwagger_0) | **Get** /dev/swagger.json | Get dev swagger spec
     9  [**GetLatestSwagger**](SwaggerApi.md#GetLatestSwagger) | **Get** /_latest/swagger.json | Get _latest spec (versioned)
    10  [**GetLatestSwagger_0**](SwaggerApi.md#GetLatestSwagger_0) | **Get** /latest/swagger.json | Get latest swagger spec
    11  [**GetLegacySwagger**](SwaggerApi.md#GetLegacySwagger) | **Get** /_legacy/swagger.json | Get _legacy spec (versioned)
    12  [**GetLegacySwagger_0**](SwaggerApi.md#GetLegacySwagger_0) | **Get** /legacy/swagger.json | Get legacy swagger spec
    13  [**GetMetaSwagger**](SwaggerApi.md#GetMetaSwagger) | **Get** /swagger.json | Get meta swagger spec
    14  [**GetV1Swagger**](SwaggerApi.md#GetV1Swagger) | **Get** /v1/swagger.json | Get v1 swagger spec
    15  [**GetV2Swagger**](SwaggerApi.md#GetV2Swagger) | **Get** /v2/swagger.json | Get v2 swagger spec
    16  [**GetV3Swagger**](SwaggerApi.md#GetV3Swagger) | **Get** /v3/swagger.json | Get v3 swagger spec
    17  [**GetV4Swagger**](SwaggerApi.md#GetV4Swagger) | **Get** /v4/swagger.json | Get v4 swagger spec
    18  [**GetV5Swagger**](SwaggerApi.md#GetV5Swagger) | **Get** /v5/swagger.json | Get v5 swagger spec
    19  [**GetV6Swagger**](SwaggerApi.md#GetV6Swagger) | **Get** /v6/swagger.json | Get v6 swagger spec
    20  
    21  
    22  # **GetDevSwagger**
    23  > interface{} GetDevSwagger(ctx, optional)
    24  Get _dev spec (versioned)
    25  
    26  The _dev ESI swagger specification. The underscore swagger specs do not have a basePath, giving you an easy way to generate stable clients on versioned routes.
    27  
    28  ### Required Parameters
    29  
    30  Name | Type | Description  | Notes
    31  ------------- | ------------- | ------------- | -------------
    32   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    33   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
    34  
    35  ### Optional Parameters
    36  Optional parameters are passed through a map[string]interface{}.
    37  
    38  Name | Type | Description  | Notes
    39  ------------- | ------------- | ------------- | -------------
    40   **userAgent** | **string**| Client identifier, takes precedence over headers | 
    41   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
    42   **datasource** | **string**| The server name you would like data from | [default to tranquility]
    43  
    44  ### Return type
    45  
    46  [**interface{}**](interface{}.md)
    47  
    48  ### Authorization
    49  
    50  No authorization required
    51  
    52  ### HTTP request headers
    53  
    54   - **Content-Type**: Not defined
    55   - **Accept**: application/json
    56  
    57  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    58  
    59  # **GetDevSwagger_0**
    60  > interface{} GetDevSwagger_0(ctx, optional)
    61  Get dev swagger spec
    62  
    63  The dev ESI swagger specification.
    64  
    65  ### Required Parameters
    66  
    67  Name | Type | Description  | Notes
    68  ------------- | ------------- | ------------- | -------------
    69   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    70   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
    71  
    72  ### Optional Parameters
    73  Optional parameters are passed through a map[string]interface{}.
    74  
    75  Name | Type | Description  | Notes
    76  ------------- | ------------- | ------------- | -------------
    77   **userAgent** | **string**| Client identifier, takes precedence over headers | 
    78   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
    79   **datasource** | **string**| The server name you would like data from | [default to tranquility]
    80  
    81  ### Return type
    82  
    83  [**interface{}**](interface{}.md)
    84  
    85  ### Authorization
    86  
    87  No authorization required
    88  
    89  ### HTTP request headers
    90  
    91   - **Content-Type**: Not defined
    92   - **Accept**: application/json
    93  
    94  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    95  
    96  # **GetLatestSwagger**
    97  > interface{} GetLatestSwagger(ctx, optional)
    98  Get _latest spec (versioned)
    99  
   100  The _latest ESI swagger specification. The underscore swagger specs do not have a basePath, giving you an easy way to generate stable clients on versioned routes.
   101  
   102  ### Required Parameters
   103  
   104  Name | Type | Description  | Notes
   105  ------------- | ------------- | ------------- | -------------
   106   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   107   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   108  
   109  ### Optional Parameters
   110  Optional parameters are passed through a map[string]interface{}.
   111  
   112  Name | Type | Description  | Notes
   113  ------------- | ------------- | ------------- | -------------
   114   **userAgent** | **string**| Client identifier, takes precedence over headers | 
   115   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
   116   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   117  
   118  ### Return type
   119  
   120  [**interface{}**](interface{}.md)
   121  
   122  ### Authorization
   123  
   124  No authorization required
   125  
   126  ### HTTP request headers
   127  
   128   - **Content-Type**: Not defined
   129   - **Accept**: application/json
   130  
   131  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   132  
   133  # **GetLatestSwagger_0**
   134  > interface{} GetLatestSwagger_0(ctx, optional)
   135  Get latest swagger spec
   136  
   137  The latest ESI swagger specification.
   138  
   139  ### Required Parameters
   140  
   141  Name | Type | Description  | Notes
   142  ------------- | ------------- | ------------- | -------------
   143   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   144   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   145  
   146  ### Optional Parameters
   147  Optional parameters are passed through a map[string]interface{}.
   148  
   149  Name | Type | Description  | Notes
   150  ------------- | ------------- | ------------- | -------------
   151   **userAgent** | **string**| Client identifier, takes precedence over headers | 
   152   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
   153   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   154  
   155  ### Return type
   156  
   157  [**interface{}**](interface{}.md)
   158  
   159  ### Authorization
   160  
   161  No authorization required
   162  
   163  ### HTTP request headers
   164  
   165   - **Content-Type**: Not defined
   166   - **Accept**: application/json
   167  
   168  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   169  
   170  # **GetLegacySwagger**
   171  > interface{} GetLegacySwagger(ctx, optional)
   172  Get _legacy spec (versioned)
   173  
   174  The _legacy ESI swagger specification. The underscore swagger specs do not have a basePath, giving you an easy way to generate stable clients on versioned routes.
   175  
   176  ### Required Parameters
   177  
   178  Name | Type | Description  | Notes
   179  ------------- | ------------- | ------------- | -------------
   180   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   181   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   182  
   183  ### Optional Parameters
   184  Optional parameters are passed through a map[string]interface{}.
   185  
   186  Name | Type | Description  | Notes
   187  ------------- | ------------- | ------------- | -------------
   188   **userAgent** | **string**| Client identifier, takes precedence over headers | 
   189   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
   190   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   191  
   192  ### Return type
   193  
   194  [**interface{}**](interface{}.md)
   195  
   196  ### Authorization
   197  
   198  No authorization required
   199  
   200  ### HTTP request headers
   201  
   202   - **Content-Type**: Not defined
   203   - **Accept**: application/json
   204  
   205  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   206  
   207  # **GetLegacySwagger_0**
   208  > interface{} GetLegacySwagger_0(ctx, optional)
   209  Get legacy swagger spec
   210  
   211  The legacy ESI swagger specification.
   212  
   213  ### Required Parameters
   214  
   215  Name | Type | Description  | Notes
   216  ------------- | ------------- | ------------- | -------------
   217   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   218   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   219  
   220  ### Optional Parameters
   221  Optional parameters are passed through a map[string]interface{}.
   222  
   223  Name | Type | Description  | Notes
   224  ------------- | ------------- | ------------- | -------------
   225   **userAgent** | **string**| Client identifier, takes precedence over headers | 
   226   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
   227   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   228  
   229  ### Return type
   230  
   231  [**interface{}**](interface{}.md)
   232  
   233  ### Authorization
   234  
   235  No authorization required
   236  
   237  ### HTTP request headers
   238  
   239   - **Content-Type**: Not defined
   240   - **Accept**: application/json
   241  
   242  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   243  
   244  # **GetMetaSwagger**
   245  > interface{} GetMetaSwagger(ctx, optional)
   246  Get meta swagger spec
   247  
   248  The meta ESI swagger specification.
   249  
   250  ### Required Parameters
   251  
   252  Name | Type | Description  | Notes
   253  ------------- | ------------- | ------------- | -------------
   254   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   255   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   256  
   257  ### Optional Parameters
   258  Optional parameters are passed through a map[string]interface{}.
   259  
   260  Name | Type | Description  | Notes
   261  ------------- | ------------- | ------------- | -------------
   262   **userAgent** | **string**| Client identifier, takes precedence over headers | 
   263   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
   264   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   265  
   266  ### Return type
   267  
   268  [**interface{}**](interface{}.md)
   269  
   270  ### Authorization
   271  
   272  No authorization required
   273  
   274  ### HTTP request headers
   275  
   276   - **Content-Type**: Not defined
   277   - **Accept**: application/json
   278  
   279  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   280  
   281  # **GetV1Swagger**
   282  > interface{} GetV1Swagger(ctx, optional)
   283  Get v1 swagger spec
   284  
   285  The v1 ESI swagger specification.
   286  
   287  ### Required Parameters
   288  
   289  Name | Type | Description  | Notes
   290  ------------- | ------------- | ------------- | -------------
   291   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   292   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   293  
   294  ### Optional Parameters
   295  Optional parameters are passed through a map[string]interface{}.
   296  
   297  Name | Type | Description  | Notes
   298  ------------- | ------------- | ------------- | -------------
   299   **userAgent** | **string**| Client identifier, takes precedence over headers | 
   300   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
   301   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   302  
   303  ### Return type
   304  
   305  [**interface{}**](interface{}.md)
   306  
   307  ### Authorization
   308  
   309  No authorization required
   310  
   311  ### HTTP request headers
   312  
   313   - **Content-Type**: Not defined
   314   - **Accept**: application/json
   315  
   316  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   317  
   318  # **GetV2Swagger**
   319  > interface{} GetV2Swagger(ctx, optional)
   320  Get v2 swagger spec
   321  
   322  The v2 ESI swagger specification.
   323  
   324  ### Required Parameters
   325  
   326  Name | Type | Description  | Notes
   327  ------------- | ------------- | ------------- | -------------
   328   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   329   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   330  
   331  ### Optional Parameters
   332  Optional parameters are passed through a map[string]interface{}.
   333  
   334  Name | Type | Description  | Notes
   335  ------------- | ------------- | ------------- | -------------
   336   **userAgent** | **string**| Client identifier, takes precedence over headers | 
   337   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
   338   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   339  
   340  ### Return type
   341  
   342  [**interface{}**](interface{}.md)
   343  
   344  ### Authorization
   345  
   346  No authorization required
   347  
   348  ### HTTP request headers
   349  
   350   - **Content-Type**: Not defined
   351   - **Accept**: application/json
   352  
   353  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   354  
   355  # **GetV3Swagger**
   356  > interface{} GetV3Swagger(ctx, optional)
   357  Get v3 swagger spec
   358  
   359  The v3 ESI swagger specification.
   360  
   361  ### Required Parameters
   362  
   363  Name | Type | Description  | Notes
   364  ------------- | ------------- | ------------- | -------------
   365   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   366   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   367  
   368  ### Optional Parameters
   369  Optional parameters are passed through a map[string]interface{}.
   370  
   371  Name | Type | Description  | Notes
   372  ------------- | ------------- | ------------- | -------------
   373   **userAgent** | **string**| Client identifier, takes precedence over headers | 
   374   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
   375   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   376  
   377  ### Return type
   378  
   379  [**interface{}**](interface{}.md)
   380  
   381  ### Authorization
   382  
   383  No authorization required
   384  
   385  ### HTTP request headers
   386  
   387   - **Content-Type**: Not defined
   388   - **Accept**: application/json
   389  
   390  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   391  
   392  # **GetV4Swagger**
   393  > interface{} GetV4Swagger(ctx, optional)
   394  Get v4 swagger spec
   395  
   396  The v4 ESI swagger specification.
   397  
   398  ### Required Parameters
   399  
   400  Name | Type | Description  | Notes
   401  ------------- | ------------- | ------------- | -------------
   402   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   403   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   404  
   405  ### Optional Parameters
   406  Optional parameters are passed through a map[string]interface{}.
   407  
   408  Name | Type | Description  | Notes
   409  ------------- | ------------- | ------------- | -------------
   410   **userAgent** | **string**| Client identifier, takes precedence over headers | 
   411   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
   412   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   413  
   414  ### Return type
   415  
   416  [**interface{}**](interface{}.md)
   417  
   418  ### Authorization
   419  
   420  No authorization required
   421  
   422  ### HTTP request headers
   423  
   424   - **Content-Type**: Not defined
   425   - **Accept**: application/json
   426  
   427  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   428  
   429  # **GetV5Swagger**
   430  > interface{} GetV5Swagger(ctx, optional)
   431  Get v5 swagger spec
   432  
   433  The v5 ESI swagger specification.
   434  
   435  ### Required Parameters
   436  
   437  Name | Type | Description  | Notes
   438  ------------- | ------------- | ------------- | -------------
   439   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   440   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   441  
   442  ### Optional Parameters
   443  Optional parameters are passed through a map[string]interface{}.
   444  
   445  Name | Type | Description  | Notes
   446  ------------- | ------------- | ------------- | -------------
   447   **userAgent** | **string**| Client identifier, takes precedence over headers | 
   448   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
   449   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   450  
   451  ### Return type
   452  
   453  [**interface{}**](interface{}.md)
   454  
   455  ### Authorization
   456  
   457  No authorization required
   458  
   459  ### HTTP request headers
   460  
   461   - **Content-Type**: Not defined
   462   - **Accept**: application/json
   463  
   464  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   465  
   466  # **GetV6Swagger**
   467  > interface{} GetV6Swagger(ctx, optional)
   468  Get v6 swagger spec
   469  
   470  The v6 ESI swagger specification.
   471  
   472  ### Required Parameters
   473  
   474  Name | Type | Description  | Notes
   475  ------------- | ------------- | ------------- | -------------
   476   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   477   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   478  
   479  ### Optional Parameters
   480  Optional parameters are passed through a map[string]interface{}.
   481  
   482  Name | Type | Description  | Notes
   483  ------------- | ------------- | ------------- | -------------
   484   **userAgent** | **string**| Client identifier, takes precedence over headers | 
   485   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
   486   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   487  
   488  ### Return type
   489  
   490  [**interface{}**](interface{}.md)
   491  
   492  ### Authorization
   493  
   494  No authorization required
   495  
   496  ### HTTP request headers
   497  
   498   - **Content-Type**: Not defined
   499   - **Accept**: application/json
   500  
   501  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   502