github.com/safedep/dry@v0.0.0-20241016050132-a15651f0548b/apiguard/tykgen/docs/SchemaApi.md (about)

     1  # {{classname}}
     2  
     3  All URIs are relative to *http://localhost/*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetSchema**](SchemaApi.md#GetSchema) | **Get** /tyk/schema | 
     8  
     9  # **GetSchema**
    10  > OasSchemaResponse GetSchema(ctx, optional)
    11  
    12  
    13  Get OAS schema
    14  
    15  ### Required Parameters
    16  
    17  Name | Type | Description  | Notes
    18  ------------- | ------------- | ------------- | -------------
    19   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    20   **optional** | ***SchemaApiGetSchemaOpts** | optional parameters | nil if no parameters
    21  
    22  ### Optional Parameters
    23  Optional parameters are passed through a pointer to a SchemaApiGetSchemaOpts struct
    24  Name | Type | Description  | Notes
    25  ------------- | ------------- | ------------- | -------------
    26   **oasVersion** | **optional.String**| The OAS version | 
    27  
    28  ### Return type
    29  
    30  [**OasSchemaResponse**](OASSchemaResponse.md)
    31  
    32  ### Authorization
    33  
    34  [api_key](../README.md#api_key)
    35  
    36  ### HTTP request headers
    37  
    38   - **Content-Type**: Not defined
    39   - **Accept**: application/json
    40  
    41  [[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)
    42