openapi-generator/samples/openapi3/client/extensions/x-auth-id-alias/go-experimental/docs/UsageApi.md

\UsageApi

All URIs are relative to http://petstore.swagger.io:80/v2

Method	HTTP request	Description
AnyKey	Get /any	Use any API key
BothKeys	Get /both	Use both API keys
KeyInHeader	Get /header	Use API key in header
KeyInQuery	Get /query	Use API key in query

AnyKey

map[string]interface{} AnyKey(ctx).Execute()

Use any API key

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UsageApi.AnyKey(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsageApi.AnyKey``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AnyKey`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UsageApi.AnyKey`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiAnyKeyRequest struct via the builder pattern

Return type

map[string]interface{}

Authorization

api_key, api_key_query

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BothKeys

map[string]interface{} BothKeys(ctx).Execute()

Use both API keys

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UsageApi.BothKeys(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsageApi.BothKeys``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `BothKeys`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UsageApi.BothKeys`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiBothKeysRequest struct via the builder pattern

Return type

map[string]interface{}

Authorization

api_key, api_key_query

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

KeyInHeader

map[string]interface{} KeyInHeader(ctx).Execute()

Use API key in header

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UsageApi.KeyInHeader(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsageApi.KeyInHeader``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `KeyInHeader`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UsageApi.KeyInHeader`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiKeyInHeaderRequest struct via the builder pattern

Return type

map[string]interface{}

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

KeyInQuery

map[string]interface{} KeyInQuery(ctx).Execute()

Use API key in query

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UsageApi.KeyInQuery(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UsageApi.KeyInQuery``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `KeyInQuery`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UsageApi.KeyInQuery`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiKeyInQueryRequest struct via the builder pattern

Return type

map[string]interface{}

Authorization

api_key_query

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]