Skip to content

Latest commit

 

History

History
596 lines (378 loc) · 14.7 KB

MetadataAPI.md

File metadata and controls

596 lines (378 loc) · 14.7 KB

\MetadataAPI

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

Method HTTP request Description
CreateMetadata Post /api/v3/metadata
CreateMetadataActionByName Post /api/v3/metadata/action/{name}
DeleteMetadata Delete /api/v3/metadata/{id}
GetMetadataById Get /api/v3/metadata/{id}
ListMetadata Get /api/v3/metadata
ListMetadataSchema Get /api/v3/metadata/schema
TestMetadata Post /api/v3/metadata/test
TestallMetadata Post /api/v3/metadata/testall
UpdateMetadata Put /api/v3/metadata/{id}

CreateMetadata

MetadataResource CreateMetadata(ctx).ForceSave(forceSave).MetadataResource(metadataResource).Execute()

Example

package main

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

func main() {
	forceSave := true // bool |  (optional) (default to false)
	metadataResource := *radarrClient.NewMetadataResource() // MetadataResource |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
forceSave bool [default to false]
metadataResource MetadataResource

Return type

MetadataResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

CreateMetadataActionByName

CreateMetadataActionByName(ctx, name).MetadataResource(metadataResource).Execute()

Example

package main

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

func main() {
	name := "name_example" // string | 
	metadataResource := *radarrClient.NewMetadataResource() // MetadataResource |  (optional)

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	r, err := apiClient.MetadataAPI.CreateMetadataActionByName(context.Background(), name).MetadataResource(metadataResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MetadataAPI.CreateMetadataActionByName``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

metadataResource | MetadataResource | |

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

DeleteMetadata

DeleteMetadata(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)
	r, err := apiClient.MetadataAPI.DeleteMetadata(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MetadataAPI.DeleteMetadata``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

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 apiDeleteMetadataRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetMetadataById

MetadataResource GetMetadataById(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.MetadataAPI.GetMetadataById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MetadataAPI.GetMetadataById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMetadataById`: MetadataResource
	fmt.Fprintf(os.Stdout, "Response from `MetadataAPI.GetMetadataById`: %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 apiGetMetadataByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

MetadataResource

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]

ListMetadata

[]MetadataResource ListMetadata(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.MetadataAPI.ListMetadata(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MetadataAPI.ListMetadata``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListMetadata`: []MetadataResource
	fmt.Fprintf(os.Stdout, "Response from `MetadataAPI.ListMetadata`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]MetadataResource

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]

ListMetadataSchema

[]MetadataResource ListMetadataSchema(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.MetadataAPI.ListMetadataSchema(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MetadataAPI.ListMetadataSchema``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListMetadataSchema`: []MetadataResource
	fmt.Fprintf(os.Stdout, "Response from `MetadataAPI.ListMetadataSchema`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]MetadataResource

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]

TestMetadata

TestMetadata(ctx).ForceTest(forceTest).MetadataResource(metadataResource).Execute()

Example

package main

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

func main() {
	forceTest := true // bool |  (optional) (default to false)
	metadataResource := *radarrClient.NewMetadataResource() // MetadataResource |  (optional)

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	r, err := apiClient.MetadataAPI.TestMetadata(context.Background()).ForceTest(forceTest).MetadataResource(metadataResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MetadataAPI.TestMetadata``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

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

Name Type Description Notes
forceTest bool [default to false]
metadataResource MetadataResource

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

TestallMetadata

TestallMetadata(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)
	r, err := apiClient.MetadataAPI.TestallMetadata(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MetadataAPI.TestallMetadata``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

UpdateMetadata

MetadataResource UpdateMetadata(ctx, id).ForceSave(forceSave).MetadataResource(metadataResource).Execute()

Example

package main

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

func main() {
	id := int32(56) // int32 | 
	forceSave := true // bool |  (optional) (default to false)
	metadataResource := *radarrClient.NewMetadataResource() // MetadataResource |  (optional)

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

Name Type Description Notes

forceSave | bool | | [default to false] metadataResource | MetadataResource | |

Return type

MetadataResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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