module Octokit::Client::CodespacesSecrets
Methods for the Codespaces Secrets API
Public Instance Methods
Create or update secrets
@param repo [Integer, String, Hash, Repository] A GitHub repository @param name [String] Name of secret @param options [Hash] encrypted_value and key_id @see 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 secrets
@param org [String] A GitHub organization @param name [String] Name of secret @param options [Hash] encrypted_value and key_id @see 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 a secret
@param repo [Integer, String, Hash, Repository] A GitHub repository @param name [String] Name of secret @see 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 an org secret
@param org [String] A GitHub organization @param name [String] Name of secret @see 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 public key for secrets encryption
@param repo [Integer, String, Hash, Repository] A GitHub repository @return [Hash] key_id and key @see 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 a secret
@param repo [Integer, String, Hash, Repository] A GitHub repository @param name [String] Name of secret @return [Hash] name, created_at, updated_at, and visibility @see 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 public key for secrets encryption
@param org [String] A GitHub organization @return [Hash] key_id and key @see 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 an org secret
@param org [String] A GitHub organization @param name [String] Name of secret @return [Hash] name, created_at, updated_at, and visibility @see 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 secrets
@param repo [Integer, String, Hash, Repository] A GitHub repository @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at) @see 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 secrets
@param org [String] A GitHub organization @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at) @see 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