Skip to content

Latest commit

 

History

History
208 lines (132 loc) · 5.56 KB

MetadataConfigAPI.md

File metadata and controls

208 lines (132 loc) · 5.56 KB

\MetadataConfigAPI

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

Method HTTP request Description
GetMetadataConfig Get /api/v3/config/metadata
GetMetadataConfigById Get /api/v3/config/metadata/{id}
UpdateMetadataConfig Put /api/v3/config/metadata/{id}

GetMetadataConfig

MetadataConfigResource GetMetadataConfig(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

MetadataConfigResource

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]

GetMetadataConfigById

MetadataConfigResource GetMetadataConfigById(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

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

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.MetadataConfigAPI.GetMetadataConfigById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MetadataConfigAPI.GetMetadataConfigById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMetadataConfigById`: MetadataConfigResource
	fmt.Fprintf(os.Stdout, "Response from `MetadataConfigAPI.GetMetadataConfigById`: %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 apiGetMetadataConfigByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

MetadataConfigResource

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]

UpdateMetadataConfig

MetadataConfigResource UpdateMetadataConfig(ctx, id).MetadataConfigResource(metadataConfigResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {
	id := "id_example" // string | 
	metadataConfigResource := *radarrClient.NewMetadataConfigResource() // MetadataConfigResource |  (optional)

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.MetadataConfigAPI.UpdateMetadataConfig(context.Background(), id).MetadataConfigResource(metadataConfigResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MetadataConfigAPI.UpdateMetadataConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateMetadataConfig`: MetadataConfigResource
	fmt.Fprintf(os.Stdout, "Response from `MetadataConfigAPI.UpdateMetadataConfig`: %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 apiUpdateMetadataConfigRequest struct via the builder pattern

Name Type Description Notes

metadataConfigResource | MetadataConfigResource | |

Return type

MetadataConfigResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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