Skip to content

Latest commit

 

History

History
373 lines (231 loc) · 14.4 KB

README.md

File metadata and controls

373 lines (231 loc) · 14.4 KB
Raw

Github

Overview

Available Operations

check_access

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::OpenApiSDK::SpeakeasyClientSDK.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.github.check_access(org="<value>", repo="<value>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter Type Required Description
org ::String ✔️ N/A
repo ::String ✔️ N/A

Response

T.nilable(::OpenApiSDK::Operations::CheckGithubAccessResponse)

check_publishing_p_rs

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::OpenApiSDK::SpeakeasyClientSDK.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.github.check_publishing_p_rs(generate_gen_lock_id="<id>", org="<value>", repo="<value>")

if ! res.github_publishing_pr_response.nil?
  # handle response
end

Parameters

Parameter Type Required Description
generate_gen_lock_id ::String ✔️ N/A
org ::String ✔️ N/A
repo ::String ✔️ N/A

Response

T.nilable(::OpenApiSDK::Operations::GithubCheckPublishingPRsResponse)

check_publishing_secrets

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::OpenApiSDK::SpeakeasyClientSDK.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.github.check_publishing_secrets(generate_gen_lock_id="<id>")

if ! res.github_missing_publishing_secrets_response.nil?
  # handle response
end

Parameters

Parameter Type Required Description
generate_gen_lock_id ::String ✔️ N/A

Response

T.nilable(::OpenApiSDK::Operations::GithubCheckPublishingSecretsResponse)

store_publishing_secrets

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::OpenApiSDK::SpeakeasyClientSDK.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)


req = ::OpenApiSDK::Shared::GithubStorePublishingSecretsRequest.new(
  generate_gen_lock_id: "<id>",
)
    
res = s.github.store_publishing_secrets(req)

if res.status_code == 200
  # handle response
end

Parameters

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

Response

T.nilable(::OpenApiSDK::Operations::GithubStorePublishingSecretsResponse)

configure_code_samples

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::OpenApiSDK::SpeakeasyClientSDK.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)


req = ::OpenApiSDK::Shared::GithubConfigureCodeSamplesRequest.new(
  org: "<value>",
  repo: "<value>",
  target_name: "<value>",
)
    
res = s.github.configure_code_samples(req)

if ! res.github_configure_code_samples_response.nil?
  # handle response
end

Parameters

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

Response

T.nilable(::OpenApiSDK::Operations::GithubConfigureCodeSamplesResponse)

configure_mintlify_repo

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::OpenApiSDK::SpeakeasyClientSDK.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)


req = ::OpenApiSDK::Shared::GithubConfigureMintlifyRepoRequest.new(
  org: "<value>",
  repo: "<value>",
  input: "<value>",
  overlays: [
    "<value>",
  ],
)
    
res = s.github.configure_mintlify_repo(req)

if res.status_code == 200
  # handle response
end

Parameters

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

Response

T.nilable(::OpenApiSDK::Operations::GithubConfigureMintlifyRepoResponse)

configure_target

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::OpenApiSDK::SpeakeasyClientSDK.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)


req = ::OpenApiSDK::Shared::GithubConfigureTargetRequest.new(
  org: "<value>",
  repo_name: "<value>",
)
    
res = s.github.configure_target(req)

if res.status_code == 200
  # handle response
end

Parameters

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

Response

T.nilable(::OpenApiSDK::Operations::GithubConfigureTargetResponse)

trigger_action

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::OpenApiSDK::SpeakeasyClientSDK.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)


req = ::OpenApiSDK::Shared::GithubTriggerActionRequest.new(
  org: "<value>",
  repo_name: "<value>",
  gen_lock_id: "<id>",
)
    
res = s.github.trigger_action(req)

if res.status_code == 200
  # handle response
end

Parameters

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

Response

T.nilable(::OpenApiSDK::Operations::GithubTriggerActionResponse)

get_action

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::OpenApiSDK::SpeakeasyClientSDK.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.github.get_action(org="<value>", repo="<value>", target_name="<value>")

if ! res.github_get_action_response.nil?
  # handle response
end

Parameters

Parameter Type Required Description
org ::String ✔️ N/A
repo ::String ✔️ N/A
target_name T.nilable(::String) ➖ The targetName of the workflow target.

Response

T.nilable(::OpenApiSDK::Operations::GetGitHubActionResponse)