Skip to content

Latest commit

 

History

History
146 lines (94 loc) · 4.61 KB

GithubAppAPI.md

File metadata and controls

146 lines (94 loc) · 4.61 KB
Raw

\GithubAppAPI

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

Method HTTP request Description
OrganizationGithubAppConnect Post /organization/{organizationId}/github/connect Connect a github account to an organization
OrganizationGithubAppDisconnect Delete /organization/{organizationId}/github/disconnect Disconnect a github account from an organization

OrganizationGithubAppConnect

OrganizationGithubAppConnect(ctx, organizationId).OrganizationGithubAppConnectRequest(organizationGithubAppConnectRequest).Execute()

Connect a github account to an organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	organizationGithubAppConnectRequest := *openapiclient.NewOrganizationGithubAppConnectRequest("InstallationId_example", "Code_example") // OrganizationGithubAppConnectRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.GithubAppAPI.OrganizationGithubAppConnect(context.Background(), organizationId).OrganizationGithubAppConnectRequest(organizationGithubAppConnectRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GithubAppAPI.OrganizationGithubAppConnect``: %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.
organizationId string Organization ID

Other Parameters

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

Name Type Description Notes

organizationGithubAppConnectRequest | OrganizationGithubAppConnectRequest | |

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

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

OrganizationGithubAppDisconnect

OrganizationGithubAppDisconnect(ctx, organizationId).Force(force).Execute()

Disconnect a github account from an organization

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	force := true // bool | Indicates if the github app should be disconnected despite github applications linked to organization (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.GithubAppAPI.OrganizationGithubAppDisconnect(context.Background(), organizationId).Force(force).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GithubAppAPI.OrganizationGithubAppDisconnect``: %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.
organizationId string Organization ID

Other Parameters

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

Name Type Description Notes

force | bool | Indicates if the github app should be disconnected despite github applications linked to organization |

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

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