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

     1  # \MetaApi
     2  
     3  All URIs are relative to *https://esi.evetech.net*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetHeaders**](MetaApi.md#GetHeaders) | **Get** /headers/ | Debug request headers
     8  [**GetPing**](MetaApi.md#GetPing) | **Get** /ping | Ping route
     9  [**GetStatus**](MetaApi.md#GetStatus) | **Get** /status.json | ESI health status
    10  [**GetVerify**](MetaApi.md#GetVerify) | **Get** /verify/ | Verify access token
    11  [**GetVersions**](MetaApi.md#GetVersions) | **Get** /versions/ | List versions
    12  
    13  
    14  # **GetHeaders**
    15  > map[string]string GetHeaders(ctx, )
    16  Debug request headers
    17  
    18  Echo the request headers for debugging purposes. Note that the 'Connection' header and any 'X-' headers are not included
    19  
    20  ### Required Parameters
    21  This endpoint does not need any parameter.
    22  
    23  ### Return type
    24  
    25  **map[string]string**
    26  
    27  ### Authorization
    28  
    29  No authorization required
    30  
    31  ### HTTP request headers
    32  
    33   - **Content-Type**: Not defined
    34   - **Accept**: application/json
    35  
    36  [[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)
    37  
    38  # **GetPing**
    39  > string GetPing(ctx, )
    40  Ping route
    41  
    42  Ping the ESI routers
    43  
    44  ### Required Parameters
    45  This endpoint does not need any parameter.
    46  
    47  ### Return type
    48  
    49  **string**
    50  
    51  ### Authorization
    52  
    53  No authorization required
    54  
    55  ### HTTP request headers
    56  
    57   - **Content-Type**: Not defined
    58   - **Accept**: text/plain; charset=utf-8
    59  
    60  [[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)
    61  
    62  # **GetStatus**
    63  > []GetStatusItem GetStatus(ctx, optional)
    64  ESI health status
    65  
    66  Provides a general health indicator per route and method
    67  
    68  ### Required Parameters
    69  
    70  Name | Type | Description  | Notes
    71  ------------- | ------------- | ------------- | -------------
    72   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    73   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
    74  
    75  ### Optional Parameters
    76  Optional parameters are passed through a map[string]interface{}.
    77  
    78  Name | Type | Description  | Notes
    79  ------------- | ------------- | ------------- | -------------
    80   **version** | **string**| The version of metrics to request. Note that alternate versions are grouped together | [default to latest]
    81  
    82  ### Return type
    83  
    84  [**[]GetStatusItem**](get_status_item.md)
    85  
    86  ### Authorization
    87  
    88  No authorization required
    89  
    90  ### HTTP request headers
    91  
    92   - **Content-Type**: Not defined
    93   - **Accept**: application/json
    94  
    95  [[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)
    96  
    97  # **GetVerify**
    98  > GetVerifyOk GetVerify(ctx, optional)
    99  Verify access token
   100  
   101  Verify authorization tokens in ESI's auth cache
   102  
   103  ### Required Parameters
   104  
   105  Name | Type | Description  | Notes
   106  ------------- | ------------- | ------------- | -------------
   107   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   108   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   109  
   110  ### Optional Parameters
   111  Optional parameters are passed through a map[string]interface{}.
   112  
   113  Name | Type | Description  | Notes
   114  ------------- | ------------- | ------------- | -------------
   115   **userAgent** | **string**| Client identifier, takes precedence over headers | 
   116   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
   117   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   118   **token** | **string**| Access token to use if unable to set a header | 
   119   **authorization** | **string**| Access token, in the format of \"Bearer <access token>\" | 
   120  
   121  ### Return type
   122  
   123  [**GetVerifyOk**](get_verify_ok.md)
   124  
   125  ### Authorization
   126  
   127  No authorization required
   128  
   129  ### HTTP request headers
   130  
   131   - **Content-Type**: Not defined
   132   - **Accept**: application/json
   133  
   134  [[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)
   135  
   136  # **GetVersions**
   137  > []string GetVersions(ctx, optional)
   138  List versions
   139  
   140  List all endpoint versions
   141  
   142  ### Required Parameters
   143  
   144  Name | Type | Description  | Notes
   145  ------------- | ------------- | ------------- | -------------
   146   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   147   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   148  
   149  ### Optional Parameters
   150  Optional parameters are passed through a map[string]interface{}.
   151  
   152  Name | Type | Description  | Notes
   153  ------------- | ------------- | ------------- | -------------
   154   **userAgent** | **string**| Client identifier, takes precedence over headers | 
   155   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
   156  
   157  ### Return type
   158  
   159  **[]string**
   160  
   161  ### Authorization
   162  
   163  No authorization required
   164  
   165  ### HTTP request headers
   166  
   167   - **Content-Type**: Not defined
   168   - **Accept**: application/json
   169  
   170  [[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)
   171