Skip to content

README.md

Latest commit

 

History

History
469 lines (322 loc) · 25.1 KB

README.md

File metadata and controls

469 lines (322 loc) · 25.1 KB

Github

Overview

REST APIs for managing the github integration

Available Operations

CheckAccess

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

CheckGithubAccessRequest req = new CheckGithubAccessRequest() {
    Org = "<value>",
    Repo = "<value>",
};

var res = await sdk.Github.CheckAccessAsync(req);

// handle response

Parameters

Parameter Type Required Description
request CheckGithubAccessRequest ✔️ The request object to use for the request.

Response

CheckGithubAccessResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

CheckPublishingPRs

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

GithubCheckPublishingPRsRequest req = new GithubCheckPublishingPRsRequest() {
    GenerateGenLockId = "<id>",
    Org = "<value>",
    Repo = "<value>",
};

var res = await sdk.Github.CheckPublishingPRsAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GithubCheckPublishingPRsRequest ✔️ The request object to use for the request.

Response

GithubCheckPublishingPRsResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

CheckPublishingSecrets

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

GithubCheckPublishingSecretsRequest req = new GithubCheckPublishingSecretsRequest() {
    GenerateGenLockId = "<id>",
};

var res = await sdk.Github.CheckPublishingSecretsAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GithubCheckPublishingSecretsRequest ✔️ The request object to use for the request.

Response

GithubCheckPublishingSecretsResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

ConfigureCodeSamples

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

GithubConfigureCodeSamplesRequest req = new GithubConfigureCodeSamplesRequest() {
    Org = "<value>",
    Repo = "<value>",
    TargetName = "<value>",
};

var res = await sdk.Github.ConfigureCodeSamplesAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GithubConfigureCodeSamplesRequest ✔️ The request object to use for the request.

Response

Models.Operations.GithubConfigureCodeSamplesResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

ConfigureMintlifyRepo

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;
using System.Collections.Generic;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

GithubConfigureMintlifyRepoRequest req = new GithubConfigureMintlifyRepoRequest() {
    Input = "<value>",
    Org = "<value>",
    Overlays = new List<string>() {
        "<value 1>",
    },
    Repo = "<value>",
};

var res = await sdk.Github.ConfigureMintlifyRepoAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GithubConfigureMintlifyRepoRequest ✔️ The request object to use for the request.

Response

GithubConfigureMintlifyRepoResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

ConfigureTarget

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

GithubConfigureTargetRequest req = new GithubConfigureTargetRequest() {
    Org = "<value>",
    RepoName = "<value>",
};

var res = await sdk.Github.ConfigureTargetAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GithubConfigureTargetRequest ✔️ The request object to use for the request.

Response

GithubConfigureTargetResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

GetAction

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

GetGitHubActionRequest req = new GetGitHubActionRequest() {
    Org = "<value>",
    Repo = "<value>",
};

var res = await sdk.Github.GetActionAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GetGitHubActionRequest ✔️ The request object to use for the request.

Response

GetGitHubActionResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

GetSetup

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

GetGithubSetupStateRequest req = new GetGithubSetupStateRequest() {
    GenerateGenLockId = "<id>",
    Org = "<value>",
    Repo = "<value>",
};

var res = await sdk.Github.GetSetupAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GetGithubSetupStateRequest ✔️ The request object to use for the request.

Response

GetGithubSetupStateResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

LinkGithub

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

LinkGithubAccessRequest? req = null;

var res = await sdk.Github.LinkGithubAsync(req);

// handle response

Parameters

Parameter Type Required Description
request LinkGithubAccessRequest ✔️ The request object to use for the request.

Response

LinkGithubAccessResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

StorePublishingSecrets

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

GithubStorePublishingSecretsRequest req = new GithubStorePublishingSecretsRequest() {
    GenerateGenLockId = "<id>",
};

var res = await sdk.Github.StorePublishingSecretsAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GithubStorePublishingSecretsRequest ✔️ The request object to use for the request.

Response

GithubStorePublishingSecretsResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

TriggerAction

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

GithubTriggerActionRequest req = new GithubTriggerActionRequest() {
    GenLockId = "<id>",
    Org = "<value>",
    RepoName = "<value>",
};

var res = await sdk.Github.TriggerActionAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GithubTriggerActionRequest ✔️ The request object to use for the request.

Response

GithubTriggerActionResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*