spacetraders/docs/DefaultApi.md

1.8 KiB

\DefaultApi

All URIs are relative to https://api.spacetraders.io/v2

Method HTTP request Description
Register Post /register Register New Agent

Register

Register201Response Register(ctx).RegisterRequest(registerRequest).Execute()

Register New Agent

Example

package main

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

func main() {
    registerRequest := *openapiclient.NewRegisterRequest("Faction_example", "BADGER") // RegisterRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
registerRequest RegisterRequest

Return type

Register201Response

Authorization

AgentToken

HTTP request headers

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

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