module Octokit::Client::CodespacesSecrets

def create_or_update_codespaces_secret(repo, name, options)

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

Parameters:
  • options (Hash) -- encrypted_value and key_id
  • name (String) -- Name of secret
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def create_or_update_codespaces_secret(repo, name, options)
  put "#{Repository.path repo}/codespaces/secrets/#{name}", options
end

def create_or_update_org_codespaces_secret(org, name, options)

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

Parameters:
  • options (Hash) -- encrypted_value and key_id
  • name (String) -- Name of secret
  • org (String) -- A GitHub organization 
def create_or_update_org_codespaces_secret(org, name, options)
  put "#{Organization.path org}/codespaces/secrets/#{name}", options
end

def delete_codespaces_secret(repo, name)

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

Parameters:
  • name (String) -- Name of secret
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def delete_codespaces_secret(repo, name)
  boolean_from_response :delete, "#{Repository.path repo}/codespaces/secrets/#{name}"
end

def delete_org_codespaces_secret(org, name)

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

Parameters:
  • name (String) -- Name of secret
  • org (String) -- A GitHub organization 
def delete_org_codespaces_secret(org, name)
  boolean_from_response :delete, "#{Organization.path org}/codespaces/secrets/#{name}"
end

def get_codespaces_public_key(repo)

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

Returns:
  • (Hash) - key_id and key

Parameters:
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def get_codespaces_public_key(repo)
  get "#{Repository.path repo}/codespaces/secrets/public-key"
end

def get_codespaces_secret(repo, name)

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

Returns:
  • (Hash) - name, created_at, updated_at, and visibility

Parameters:
  • name (String) -- Name of secret
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def get_codespaces_secret(repo, name)
  get "#{Repository.path repo}/codespaces/secrets/#{name}"
end

def get_org_codespaces_public_key(org)

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

Returns:
  • (Hash) - key_id and key

Parameters:
  • org (String) -- A GitHub organization 
def get_org_codespaces_public_key(org)
  get "#{Organization.path org}/codespaces/secrets/public-key"
end

def get_org_codespaces_secret(org, name)

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

Returns:
  • (Hash) - name, created_at, updated_at, and visibility

Parameters:
  • name (String) -- Name of secret
  • org (String) -- A GitHub organization 
def get_org_codespaces_secret(org, name)
  get "#{Organization.path org}/codespaces/secrets/#{name}"
end

def list_codespaces_secrets(repo)

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

Returns:
  • (Hash) - total_count and list of secrets (each item is hash with name, created_at and updated_at)

Parameters:
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def list_codespaces_secrets(repo)
  paginate "#{Repository.path repo}/codespaces/secrets" do |data, last_response|
    data.secrets.concat last_response.data.secrets
  end
end

def list_org_codespaces_secrets(org)

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

Returns:
  • (Hash) - total_count and list of secrets (each item is hash with name, created_at and updated_at)

Parameters:
  • org (String) -- A GitHub organization 
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