Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 1.75 KB

ModApi.md

File metadata and controls

79 lines (49 loc) · 1.75 KB

\ModApi

All URIs are relative to https://localhost/api/v0

Method HTTP request Description
Get Get /mod/{mod_name} Get mod

Get

Mod Get(ctx, modName).Execute()

Get mod

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/turbot/flowpipe-sdk-go"
)

func main() {
    modName := "modName_example" // string | The name of the mod

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ModApi.Get(context.Background(), modName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ModApi.Get``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Get`: Mod
    fmt.Fprintf(os.Stdout, "Response from `ModApi.Get`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
modName string The name of the mod

Other Parameters

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

Name Type Description Notes

Return type

Mod

Authorization

No authorization required

HTTP request headers

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

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