Skip to content

ImplementationsAPI.md

Latest commit

 

History

History
310 lines (200 loc) · 9.81 KB

ImplementationsAPI.md

File metadata and controls

310 lines (200 loc) · 9.81 KB

\ImplementationsAPI

All URIs are relative to https://api.rankvectors.com

Method HTTP request Description
GetImplementation Get /api/projects/{projectId}/implementations/{implementationId} Get implementation details
ImplementLinks Post /api/projects/{projectId}/implementations Implement link suggestions
ListImplementations Get /api/projects/{projectId}/implementations List implementations
RollbackImplementation Post /api/projects/{projectId}/implementations/{implementationId}/rollback Rollback implementation

GetImplementation

GetImplementation200Response GetImplementation(ctx, projectId, implementationId).Execute()

Get implementation details

Example

package main

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

func main() {
	projectId := "proj-123" // string | Unique identifier for the project
	implementationId := "impl-123" // string | Unique identifier for the implementation

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Unique identifier for the project
implementationId string Unique identifier for the implementation

Other Parameters

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

Name Type Description Notes

Return type

GetImplementation200Response

Authorization

ApiKeyAuth

HTTP request headers

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

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

ImplementLinks

ImplementationResponse ImplementLinks(ctx, projectId).ImplementationRequest(implementationRequest).Execute()

Implement link suggestions

Example

package main

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

func main() {
	projectId := "proj-123" // string | Unique identifier for the project
	implementationRequest := *openapiclient.NewImplementationRequest([]string{"SuggestionIds_example"}, "custom", *openapiclient.NewCustomCredentials("https://yourapi.com/rankvectors-webhook", "your-webhook-secret-key")) // ImplementationRequest | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Unique identifier for the project

Other Parameters

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

Name Type Description Notes

implementationRequest | ImplementationRequest | |

Return type

ImplementationResponse

Authorization

ApiKeyAuth

HTTP request headers

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

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

ListImplementations

ListImplementations200Response ListImplementations(ctx, projectId).Status(status).Platform(platform).Limit(limit).Offset(offset).Execute()

List implementations

Example

package main

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

func main() {
	projectId := "proj-123" // string | Unique identifier for the project
	status := "status_example" // string | Filter by implementation status (optional)
	platform := "platform_example" // string | Filter by platform (optional)
	limit := int32(56) // int32 | Results per page (optional) (default to 50)
	offset := int32(56) // int32 | Pagination offset (optional) (default to 0)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ImplementationsAPI.ListImplementations(context.Background(), projectId).Status(status).Platform(platform).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ImplementationsAPI.ListImplementations``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListImplementations`: ListImplementations200Response
	fmt.Fprintf(os.Stdout, "Response from `ImplementationsAPI.ListImplementations`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Unique identifier for the project

Other Parameters

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

Name Type Description Notes

status | string | Filter by implementation status | platform | string | Filter by platform | limit | int32 | Results per page | [default to 50] offset | int32 | Pagination offset | [default to 0]

Return type

ListImplementations200Response

Authorization

ApiKeyAuth

HTTP request headers

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

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

RollbackImplementation

RollbackImplementation200Response RollbackImplementation(ctx, projectId, implementationId).RollbackImplementationRequest(rollbackImplementationRequest).Execute()

Rollback implementation

Example

package main

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

func main() {
	projectId := "proj-123" // string | Unique identifier for the project
	implementationId := "impl-123" // string | Unique identifier for the implementation
	rollbackImplementationRequest := *openapiclient.NewRollbackImplementationRequest() // RollbackImplementationRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ImplementationsAPI.RollbackImplementation(context.Background(), projectId, implementationId).RollbackImplementationRequest(rollbackImplementationRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ImplementationsAPI.RollbackImplementation``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RollbackImplementation`: RollbackImplementation200Response
	fmt.Fprintf(os.Stdout, "Response from `ImplementationsAPI.RollbackImplementation`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Unique identifier for the project
implementationId string Unique identifier for the implementation

Other Parameters

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

Name Type Description Notes

rollbackImplementationRequest | RollbackImplementationRequest | |

Return type

RollbackImplementation200Response

Authorization

ApiKeyAuth

HTTP request headers

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

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