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

     1  # \WebUIApi
     2  
     3  All URIs are relative to *https://esi.evetech.net*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetDiffVersionAVersionB**](WebUIApi.md#GetDiffVersionAVersionB) | **Get** /diff/{version_a}/{version_b}/ | Diff route
     8  [**GetUi**](WebUIApi.md#GetUi) | **Get** /ui/ | SwaggerUI route (v3)
     9  
    10  
    11  # **GetDiffVersionAVersionB**
    12  > string GetDiffVersionAVersionB(ctx, versionA, versionB, optional)
    13  Diff route
    14  
    15  Diff two ESI specs
    16  
    17  ### Required Parameters
    18  
    19  Name | Type | Description  | Notes
    20  ------------- | ------------- | ------------- | -------------
    21   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    22    **versionA** | **string**| Swagger spec version to compare with | 
    23    **versionB** | **string**| Swagger spec version to compare against | 
    24   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
    25  
    26  ### Optional Parameters
    27  Optional parameters are passed through a map[string]interface{}.
    28  
    29  Name | Type | Description  | Notes
    30  ------------- | ------------- | ------------- | -------------
    31   **versionA** | **string**| Swagger spec version to compare with | 
    32   **versionB** | **string**| Swagger spec version to compare against | 
    33   **userAgent** | **string**| Client identifier, takes precedence over headers | 
    34   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
    35   **datasource** | **string**| The server name you would like data from | [default to tranquility]
    36  
    37  ### Return type
    38  
    39  **string**
    40  
    41  ### Authorization
    42  
    43  No authorization required
    44  
    45  ### HTTP request headers
    46  
    47   - **Content-Type**: Not defined
    48   - **Accept**: text/html; charset=utf-8
    49  
    50  [[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)
    51  
    52  # **GetUi**
    53  > string GetUi(ctx, optional)
    54  SwaggerUI route (v3)
    55  
    56  ESI web UI. This is an open source project. If you find ESI web UI specific bugs, please report them to https://github.com/esi/esi-swagger-ui/issues
    57  
    58  ### Required Parameters
    59  
    60  Name | Type | Description  | Notes
    61  ------------- | ------------- | ------------- | -------------
    62   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    63   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
    64  
    65  ### Optional Parameters
    66  Optional parameters are passed through a map[string]interface{}.
    67  
    68  Name | Type | Description  | Notes
    69  ------------- | ------------- | ------------- | -------------
    70   **userAgent** | **string**| Client identifier, takes precedence over headers | 
    71   **xUserAgent** | **string**| Client identifier, takes precedence over User-Agent | 
    72   **datasource** | **string**| The server name you would like data from | [default to tranquility]
    73   **version** | **string**| The Swagger spec version to display | [default to latest]
    74  
    75  ### Return type
    76  
    77  **string**
    78  
    79  ### Authorization
    80  
    81  No authorization required
    82  
    83  ### HTTP request headers
    84  
    85   - **Content-Type**: Not defined
    86   - **Accept**: text/html; charset=utf-8
    87  
    88  [[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)
    89