Skip to content

Latest commit

 

History

History
208 lines (132 loc) · 5.79 KB

DevelopmentConfigAPI.md

File metadata and controls

208 lines (132 loc) · 5.79 KB

\DevelopmentConfigAPI

All URIs are relative to http://localhost:8787

Method HTTP request Description
GetDevelopmentConfig Get /api/v1/config/development
GetDevelopmentConfigById Get /api/v1/config/development/{id}
UpdateDevelopmentConfig Put /api/v1/config/development/{id}

GetDevelopmentConfig

DevelopmentConfigResource GetDevelopmentConfig(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

DevelopmentConfigResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

GetDevelopmentConfigById

DevelopmentConfigResource GetDevelopmentConfigById(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {
	id := int32(56) // int32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32

Other Parameters

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

Name Type Description Notes

Return type

DevelopmentConfigResource

Authorization

apikey, X-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]

UpdateDevelopmentConfig

DevelopmentConfigResource UpdateDevelopmentConfig(ctx, id).DevelopmentConfigResource(developmentConfigResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {
	id := "id_example" // string | 
	developmentConfigResource := *readarrClient.NewDevelopmentConfigResource() // DevelopmentConfigResource |  (optional)

	configuration := readarrClient.NewConfiguration()
	apiClient := readarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.DevelopmentConfigAPI.UpdateDevelopmentConfig(context.Background(), id).DevelopmentConfigResource(developmentConfigResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DevelopmentConfigAPI.UpdateDevelopmentConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateDevelopmentConfig`: DevelopmentConfigResource
	fmt.Fprintf(os.Stdout, "Response from `DevelopmentConfigAPI.UpdateDevelopmentConfig`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

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

Name Type Description Notes

developmentConfigResource | DevelopmentConfigResource | |

Return type

DevelopmentConfigResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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