\GitProviderAPI

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

Method	HTTP request	Description
GetGitContext	Get /gitprovider/context/{gitUrl}	Get Git context
GetGitProviderForUrl	Get /gitprovider/for-url/{url}	Get Git provider
GetGitUser	Get /gitprovider/{gitProviderId}/user	Get Git context
GetNamespaces	Get /gitprovider/{gitProviderId}/namespaces	Get Git namespaces
GetRepoBranches	Get /gitprovider/{gitProviderId}/{namespaceId}/{repositoryId}/branches	Get Git repository branches
GetRepoPRs	Get /gitprovider/{gitProviderId}/{namespaceId}/{repositoryId}/pull-requests	Get Git repository PRs
GetRepositories	Get /gitprovider/{gitProviderId}/{namespaceId}/repositories	Get Git repositories
ListGitProviders	Get /gitprovider	List Git providers
RemoveGitProvider	Delete /gitprovider/{gitProviderId}	Remove Git provider
SetGitProvider	Put /gitprovider	Set Git provider

GetGitContext

GitRepository GetGitContext(ctx, gitUrl).Execute()

Get Git context

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/serverapiclient"
)

func main() {
	gitUrl := "gitUrl_example" // string | Git URL

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

GitRepository

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetGitProviderForUrl

GitProvider GetGitProviderForUrl(ctx, url).Execute()

Get Git provider

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/serverapiclient"
)

func main() {
	url := "url_example" // string | Url

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

GitProvider

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetGitUser

GitUser GetGitUser(ctx, gitProviderId).Execute()

Get Git context

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/serverapiclient"
)

func main() {
	gitProviderId := "gitProviderId_example" // string | Git Provider Id

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
gitProviderId	string	Git Provider Id

Other Parameters

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

Name	Type	Description	Notes

Return type

GitUser

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetNamespaces

[]GitNamespace GetNamespaces(ctx, gitProviderId).Execute()

Get Git namespaces

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/serverapiclient"
)

func main() {
	gitProviderId := "gitProviderId_example" // string | Git provider

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

[]GitNamespace

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetRepoBranches

[]GitBranch GetRepoBranches(ctx, gitProviderId, namespaceId, repositoryId).Execute()

Get Git repository branches

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/serverapiclient"
)

func main() {
	gitProviderId := "gitProviderId_example" // string | Git provider
	namespaceId := "namespaceId_example" // string | Namespace
	repositoryId := "repositoryId_example" // string | Repository

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.GitProviderAPI.GetRepoBranches(context.Background(), gitProviderId, namespaceId, repositoryId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GitProviderAPI.GetRepoBranches``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetRepoBranches`: []GitBranch
	fmt.Fprintf(os.Stdout, "Response from `GitProviderAPI.GetRepoBranches`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
gitProviderId	string	Git provider
namespaceId	string	Namespace
repositoryId	string	Repository

Other Parameters

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

Name	Type	Description	Notes

Return type

[]GitBranch

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetRepoPRs

[]GitPullRequest GetRepoPRs(ctx, gitProviderId, namespaceId, repositoryId).Execute()

Get Git repository PRs

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/serverapiclient"
)

func main() {
	gitProviderId := "gitProviderId_example" // string | Git provider
	namespaceId := "namespaceId_example" // string | Namespace
	repositoryId := "repositoryId_example" // string | Repository

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.GitProviderAPI.GetRepoPRs(context.Background(), gitProviderId, namespaceId, repositoryId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GitProviderAPI.GetRepoPRs``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetRepoPRs`: []GitPullRequest
	fmt.Fprintf(os.Stdout, "Response from `GitProviderAPI.GetRepoPRs`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
gitProviderId	string	Git provider
namespaceId	string	Namespace
repositoryId	string	Repository

Other Parameters

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

Name	Type	Description	Notes

Return type

[]GitPullRequest

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetRepositories

[]GitRepository GetRepositories(ctx, gitProviderId, namespaceId).Execute()

Get Git repositories

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/serverapiclient"
)

func main() {
	gitProviderId := "gitProviderId_example" // string | Git provider
	namespaceId := "namespaceId_example" // string | Namespace

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.GitProviderAPI.GetRepositories(context.Background(), gitProviderId, namespaceId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GitProviderAPI.GetRepositories``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetRepositories`: []GitRepository
	fmt.Fprintf(os.Stdout, "Response from `GitProviderAPI.GetRepositories`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
gitProviderId	string	Git provider
namespaceId	string	Namespace

Other Parameters

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

Name	Type	Description	Notes

Return type

[]GitRepository

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListGitProviders

[]GitProvider ListGitProviders(ctx).Execute()

List Git providers

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/serverapiclient"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]GitProvider

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

RemoveGitProvider

RemoveGitProvider(ctx, gitProviderId).Execute()

Remove Git provider

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/serverapiclient"
)

func main() {
	gitProviderId := "gitProviderId_example" // string | Git provider

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.GitProviderAPI.RemoveGitProvider(context.Background(), gitProviderId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GitProviderAPI.RemoveGitProvider``: %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.
gitProviderId	string	Git provider

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

SetGitProvider

SetGitProvider(ctx).GitProviderConfig(gitProviderConfig).Execute()

Set Git provider

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/serverapiclient"
)

func main() {
	gitProviderConfig := *openapiclient.NewGitProvider() // GitProvider | Git provider

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.GitProviderAPI.SetGitProvider(context.Background()).GitProviderConfig(gitProviderConfig).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GitProviderAPI.SetGitProvider``: %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 apiSetGitProviderRequest struct via the builder pattern

Name	Type	Description	Notes
gitProviderConfig	GitProvider	Git provider

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

Files

GitProviderAPI.md

Latest commit

History

GitProviderAPI.md

File metadata and controls

\GitProviderAPI

GetGitContext

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetGitProviderForUrl

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetGitUser

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetNamespaces

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetRepoBranches

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetRepoPRs

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetRepositories

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListGitProviders

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RemoveGitProvider

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SetGitProvider

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers