Module: Octokit::Client::CodespacesSecrets

Included in:

Octokit::Client

Defined in:

lib/octokit/client/codespaces_secrets.rb

Overview

Methods for the Codespaces Secrets API

See Also:

• https://docs.github.com/en/rest/codespaces/

Instance Method Summary

• #create_or_update_codespaces_secret(repo, name, options) ⇒ Object

  Create or update secrets.

• #create_or_update_org_codespaces_secret(org, name, options) ⇒ Object

  Create or update org secrets.

• #delete_codespaces_secret(repo, name) ⇒ Object

  Delete a secret.

• #delete_org_codespaces_secret(org, name) ⇒ Object

  Delete an org secret.

• #get_codespaces_public_key(repo) ⇒ Hash

  Get public key for secrets encryption.

• #get_codespaces_secret(repo, name) ⇒ Hash

  Get a secret.

• #get_org_codespaces_public_key(org) ⇒ Hash

  Get public key for secrets encryption.

• #get_org_codespaces_secret(org, name) ⇒ Hash

  Get an org secret.

• #list_codespaces_secrets(repo) ⇒ Hash

  List secrets.

• #list_org_codespaces_secrets(org) ⇒ Hash

  List org secrets.

Instance Method Details

#create_or_update_codespaces_secret(repo, name, options) ⇒ Object

Create or update secrets

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

• name (String) —

  Name of secret

• options (Hash) —

  encrypted_value and key_id

See Also:

• https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#create-or-update-a-repository-secret

# File 'lib/octokit/client/codespaces_secrets.rb', line 75

def create_or_update_codespaces_secret(repo, name, options)
  put "#{Repository.path repo}/codespaces/secrets/#{name}", options
end

#create_or_update_org_codespaces_secret(org, name, options) ⇒ Object

Create or update org secrets

Parameters:

• org (String) —

  A GitHub organization

• name (String) —

  Name of secret

• options (Hash) —

  encrypted_value and key_id

See Also:

• https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#create-or-update-an-organization-secret

# File 'lib/octokit/client/codespaces_secrets.rb', line 85

def create_or_update_org_codespaces_secret(org, name, options)
  put "#{Organization.path org}/codespaces/secrets/#{name}", options
end

#delete_codespaces_secret(repo, name) ⇒ Object

Delete a secret

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

• name (String) —

  Name of secret

See Also:

• https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#delete-a-repository-secret

# File 'lib/octokit/client/codespaces_secrets.rb', line 94

def delete_codespaces_secret(repo, name)
  boolean_from_response :delete, "#{Repository.path repo}/codespaces/secrets/#{name}"
end

#delete_org_codespaces_secret(org, name) ⇒ Object

Delete an org secret

Parameters:

• org (String) —

  A GitHub organization

• name (String) —

  Name of secret

See Also:

• https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#delete-an-organization-secret

# File 'lib/octokit/client/codespaces_secrets.rb', line 103

def delete_org_codespaces_secret(org, name)
  boolean_from_response :delete, "#{Organization.path org}/codespaces/secrets/#{name}"
end

#get_codespaces_public_key(repo) ⇒ Hash

Get public key for secrets encryption

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

Returns:

• (Hash) —

  key_id and key

See Also:

• https://docs.github.com/en/rest/codespaces/repository-secrets#get-a-repository-public-key

# File 'lib/octokit/client/codespaces_secrets.rb', line 14

def get_codespaces_public_key(repo)
  get "#{Repository.path repo}/codespaces/secrets/public-key"
end

#get_codespaces_secret(repo, name) ⇒ Hash

Get a secret

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

• name (String) —

  Name of secret

Returns:

• (Hash) —

  name, created_at, updated_at, and visibility

See Also:

• https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#get-a-repository-secret

# File 'lib/octokit/client/codespaces_secrets.rb', line 55

def get_codespaces_secret(repo, name)
  get "#{Repository.path repo}/codespaces/secrets/#{name}"
end

#get_org_codespaces_public_key(org) ⇒ Hash

Get public key for secrets encryption

Parameters:

• org (String) —

  A GitHub organization

Returns:

• (Hash) —

  key_id and key

See Also:

• https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#get-an-organization-public-key

# File 'lib/octokit/client/codespaces_secrets.rb', line 23

def get_org_codespaces_public_key(org)
  get "#{Organization.path org}/codespaces/secrets/public-key"
end

#get_org_codespaces_secret(org, name) ⇒ Hash

Get an org secret

Parameters:

• org (String) —

  A GitHub organization

• name (String) —

  Name of secret

Returns:

• (Hash) —

  name, created_at, updated_at, and visibility

See Also:

• https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#get-an-organization-secret

# File 'lib/octokit/client/codespaces_secrets.rb', line 65

def get_org_codespaces_secret(org, name)
  get "#{Organization.path org}/codespaces/secrets/#{name}"
end

#list_codespaces_secrets(repo) ⇒ Hash

List secrets

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

Returns:

• (Hash) —

  total_count and list of secrets (each item is hash with name, created_at and updated_at)

See Also:

• https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#list-repository-secrets

# File 'lib/octokit/client/codespaces_secrets.rb', line 32

def list_codespaces_secrets(repo)
  paginate "#{Repository.path repo}/codespaces/secrets" do |data, last_response|
    data.secrets.concat last_response.data.secrets
  end
end

#list_org_codespaces_secrets(org) ⇒ Hash

List org secrets

Parameters:

• org (String) —

  A GitHub organization

Returns:

• (Hash) —

  total_count and list of secrets (each item is hash with name, created_at and updated_at)

See Also:

• https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#list-organization-secrets

# File 'lib/octokit/client/codespaces_secrets.rb', line 43

def list_org_codespaces_secrets(org)
  paginate "#{Organization.path org}/codespaces/secrets" do |data, last_response|
    data.secrets.concat last_response.data.secrets
  end
end