Skip to content

Latest commit

 

History

History
821 lines (525 loc) · 23.4 KB

File metadata and controls

821 lines (525 loc) · 23.4 KB

\AISkillsAPI

All URIs are relative to https://dashboard.quantcdn.io

Method HTTP request Description
CreateSkill Post /api/v3/organizations/{organisation}/ai/skills Create Inline Skill
DeleteSkill Delete /api/v3/organizations/{organisation}/ai/skills/{skillId} Delete Skill
DeleteSkillCollection Delete /api/v3/organizations/{organisation}/ai/skills/collections/{namespace} Delete Skill Collection
GetSkill Get /api/v3/organizations/{organisation}/ai/skills/{skillId} Get Skill Details
ImportSkill Post /api/v3/organizations/{organisation}/ai/skills/import Import Skill from External Source
ImportSkillCollection Post /api/v3/organizations/{organisation}/ai/skills/import-collection Import Skill Collection from GitHub
ListSkillCollections Get /api/v3/organizations/{organisation}/ai/skills/collections List Skill Collections
ListSkills Get /api/v3/organizations/{organisation}/ai/skills List Organization's Skills
SyncSkill Post /api/v3/organizations/{organisation}/ai/skills/{skillId}/sync Sync Skill from Source
SyncSkillCollection Post /api/v3/organizations/{organisation}/ai/skills/collections/{namespace}/sync Sync Skill Collection
UpdateSkill Put /api/v3/organizations/{organisation}/ai/skills/{skillId} Update Skill

CreateSkill

CreateSkill201Response CreateSkill(ctx, organisation).CreateSkillRequest(createSkillRequest).Execute()

Create Inline Skill

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	createSkillRequest := *openapiclient.NewCreateSkillRequest("code-review", "You are an expert code reviewer...", "When the user asks for code review") // CreateSkillRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AISkillsAPI.CreateSkill(context.Background(), organisation).CreateSkillRequest(createSkillRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AISkillsAPI.CreateSkill``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateSkill`: CreateSkill201Response
	fmt.Fprintf(os.Stdout, "Response from `AISkillsAPI.CreateSkill`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

createSkillRequest | CreateSkillRequest | |

Return type

CreateSkill201Response

Authorization

BearerAuth

HTTP request headers

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

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

DeleteSkill

DeleteSkill200Response DeleteSkill(ctx, organisation, skillId).Execute()

Delete Skill

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	skillId := "skillId_example" // string | The skill ID

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation string The organisation ID
skillId string The skill ID

Other Parameters

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

Name Type Description Notes

Return type

DeleteSkill200Response

Authorization

BearerAuth

HTTP request headers

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

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

DeleteSkillCollection

DeleteSkillCollection200Response DeleteSkillCollection(ctx, organisation, namespace).Execute()

Delete Skill Collection

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	namespace := "namespace_example" // string | Collection namespace

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation string The organisation ID
namespace string Collection namespace

Other Parameters

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

Name Type Description Notes

Return type

DeleteSkillCollection200Response

Authorization

BearerAuth

HTTP request headers

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

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

GetSkill

GetSkill200Response GetSkill(ctx, organisation, skillId).Execute()

Get Skill Details

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	skillId := "skillId_example" // string | The skill ID

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation string The organisation ID
skillId string The skill ID

Other Parameters

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

Name Type Description Notes

Return type

GetSkill200Response

Authorization

BearerAuth

HTTP request headers

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

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

ImportSkill

ImportSkill201Response ImportSkill(ctx, organisation).ImportSkillRequest(importSkillRequest).Execute()

Import Skill from External Source

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	importSkillRequest := *openapiclient.NewImportSkillRequest(*openapiclient.NewImportSkillRequestSource("Type_example")) // ImportSkillRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AISkillsAPI.ImportSkill(context.Background(), organisation).ImportSkillRequest(importSkillRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AISkillsAPI.ImportSkill``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ImportSkill`: ImportSkill201Response
	fmt.Fprintf(os.Stdout, "Response from `AISkillsAPI.ImportSkill`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

importSkillRequest | ImportSkillRequest | |

Return type

ImportSkill201Response

Authorization

BearerAuth

HTTP request headers

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

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

ImportSkillCollection

ImportSkillCollection201Response ImportSkillCollection(ctx, organisation).ImportSkillCollectionRequest(importSkillCollectionRequest).Execute()

Import Skill Collection from GitHub

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	importSkillCollectionRequest := *openapiclient.NewImportSkillCollectionRequest("superpowers", *openapiclient.NewImportSkillCollectionRequestSource("Type_example", "obra/superpowers")) // ImportSkillCollectionRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AISkillsAPI.ImportSkillCollection(context.Background(), organisation).ImportSkillCollectionRequest(importSkillCollectionRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AISkillsAPI.ImportSkillCollection``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ImportSkillCollection`: ImportSkillCollection201Response
	fmt.Fprintf(os.Stdout, "Response from `AISkillsAPI.ImportSkillCollection`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

importSkillCollectionRequest | ImportSkillCollectionRequest | |

Return type

ImportSkillCollection201Response

Authorization

BearerAuth

HTTP request headers

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

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

ListSkillCollections

ListSkillCollections200Response ListSkillCollections(ctx, organisation).Execute()

List Skill Collections

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

ListSkillCollections200Response

Authorization

BearerAuth

HTTP request headers

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

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

ListSkills

ListSkills200Response ListSkills(ctx, organisation).Tag(tag).Namespace(namespace).Limit(limit).Execute()

List Organization's Skills

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	tag := "tag_example" // string | Filter skills by tag (optional)
	namespace := "namespace_example" // string | Filter skills by collection namespace (e.g. 'superpowers') (optional)
	limit := int32(56) // int32 | Maximum number of skills to return (optional) (default to 50)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AISkillsAPI.ListSkills(context.Background(), organisation).Tag(tag).Namespace(namespace).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AISkillsAPI.ListSkills``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListSkills`: ListSkills200Response
	fmt.Fprintf(os.Stdout, "Response from `AISkillsAPI.ListSkills`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

tag | string | Filter skills by tag | namespace | string | Filter skills by collection namespace (e.g. 'superpowers') | limit | int32 | Maximum number of skills to return | [default to 50]

Return type

ListSkills200Response

Authorization

BearerAuth

HTTP request headers

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

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

SyncSkill

ImportSkill201Response SyncSkill(ctx, organisation, skillId).Execute()

Sync Skill from Source

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	skillId := "skillId_example" // string | The skill ID

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation string The organisation ID
skillId string The skill ID

Other Parameters

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

Name Type Description Notes

Return type

ImportSkill201Response

Authorization

BearerAuth

HTTP request headers

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

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

SyncSkillCollection

SyncSkillCollection200Response SyncSkillCollection(ctx, organisation, namespace).Execute()

Sync Skill Collection

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	namespace := "namespace_example" // string | Collection namespace

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation string The organisation ID
namespace string Collection namespace

Other Parameters

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

Name Type Description Notes

Return type

SyncSkillCollection200Response

Authorization

BearerAuth

HTTP request headers

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

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

UpdateSkill

UpdateSkill200Response UpdateSkill(ctx, organisation, skillId).UpdateSkillRequest(updateSkillRequest).Execute()

Update Skill

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	skillId := "skillId_example" // string | The skill ID
	updateSkillRequest := *openapiclient.NewUpdateSkillRequest() // UpdateSkillRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AISkillsAPI.UpdateSkill(context.Background(), organisation, skillId).UpdateSkillRequest(updateSkillRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AISkillsAPI.UpdateSkill``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateSkill`: UpdateSkill200Response
	fmt.Fprintf(os.Stdout, "Response from `AISkillsAPI.UpdateSkill`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation string The organisation ID
skillId string The skill ID

Other Parameters

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

Name Type Description Notes

updateSkillRequest | UpdateSkillRequest | |

Return type

UpdateSkill200Response

Authorization

BearerAuth

HTTP request headers

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

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