Skip to content

Commit e9ff110

Browse files
committed
Correct example property name
1 parent 9af1d95 commit e9ff110

File tree

1,037 files changed

+1037
-1037
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,037 files changed

+1037
-1037
lines changed

src/Schema/Actions/CreateOrUpdateEnvironmentSecret/Request/Applicationjson.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
public const SCHEMA_JSON = '{"required":["encrypted_value","key_id"],"type":"object","properties":{"encrypted_value":{"pattern":"^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=|[A-Za-z0-9+\\/]{4})$","type":"string","description":"Value for your secret, encrypted with [LibSodium](https:\\/\\/libsodium.gitbook.io\\/doc\\/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https:\\/\\/docs.github.com\\/enterprise-cloud@latest\\/\\/rest\\/reference\\/actions#get-an-environment-public-key) endpoint."},"key_id":{"type":"string","description":"ID of the key you used to encrypt the secret."}}}';
1414
public const SCHEMA_TITLE = '';
1515
public const SCHEMA_DESCRIPTION = '';
16-
public const SCHEMA_EXAMPLE_DATA = '{"encryptedValue":"generated_encrypted_value_null","keyId":"generated_key_id_null"}';
16+
public const SCHEMA_EXAMPLE_DATA = '{"encrypted_value":"generated_encrypted_value_null","key_id":"generated_key_id_null"}';
1717
/**
1818
* encryptedValue: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-cloud@latest//rest/reference/actions#get-an-environment-public-key) endpoint.
1919
* keyId: ID of the key you used to encrypt the secret.

src/Schema/Actions/CreateOrUpdateOrgSecret/Request/Applicationjson.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
public const SCHEMA_JSON = '{"required":["visibility"],"type":"object","properties":{"encrypted_value":{"pattern":"^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=|[A-Za-z0-9+\\/]{4})$","type":"string","description":"Value for your secret, encrypted with [LibSodium](https:\\/\\/libsodium.gitbook.io\\/doc\\/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https:\\/\\/docs.github.com\\/enterprise-cloud@latest\\/\\/rest\\/reference\\/actions#get-an-organization-public-key) endpoint."},"key_id":{"type":"string","description":"ID of the key you used to encrypt the secret."},"visibility":{"enum":["all","private","selected"],"type":"string","description":"Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret."},"selected_repository_ids":{"type":"array","items":{"type":"integer"},"description":"An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https:\\/\\/docs.github.com\\/enterprise-cloud@latest\\/\\/rest\\/reference\\/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https:\\/\\/docs.github.com\\/enterprise-cloud@latest\\/\\/rest\\/reference\\/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https:\\/\\/docs.github.com\\/enterprise-cloud@latest\\/\\/rest\\/reference\\/actions#remove-selected-repository-from-an-organization-secret) endpoints."}}}';
1414
public const SCHEMA_TITLE = '';
1515
public const SCHEMA_DESCRIPTION = '';
16-
public const SCHEMA_EXAMPLE_DATA = '{"encryptedValue":"generated_encrypted_value_null","keyId":"generated_key_id_null","visibility":"all","selectedRepositoryIds":[13]}';
16+
public const SCHEMA_EXAMPLE_DATA = '{"encrypted_value":"generated_encrypted_value_null","key_id":"generated_key_id_null","visibility":"all","selected_repository_ids":[13]}';
1717
/**
1818
* encryptedValue: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/reference/actions#get-an-organization-public-key) endpoint.
1919
* keyId: ID of the key you used to encrypt the secret.

src/Schema/Actions/CreateOrUpdateRepoSecret/Request/Applicationjson.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
public const SCHEMA_JSON = '{"type":"object","properties":{"encrypted_value":{"pattern":"^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=|[A-Za-z0-9+\\/]{4})$","type":"string","description":"Value for your secret, encrypted with [LibSodium](https:\\/\\/libsodium.gitbook.io\\/doc\\/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https:\\/\\/docs.github.com\\/enterprise-cloud@latest\\/\\/rest\\/reference\\/actions#get-a-repository-public-key) endpoint."},"key_id":{"type":"string","description":"ID of the key you used to encrypt the secret."}}}';
1414
public const SCHEMA_TITLE = '';
1515
public const SCHEMA_DESCRIPTION = '';
16-
public const SCHEMA_EXAMPLE_DATA = '{"encryptedValue":"generated_encrypted_value_null","keyId":"generated_key_id_null"}';
16+
public const SCHEMA_EXAMPLE_DATA = '{"encrypted_value":"generated_encrypted_value_null","key_id":"generated_key_id_null"}';
1717
/**
1818
* encryptedValue: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest//rest/reference/actions#get-a-repository-public-key) endpoint.
1919
* keyId: ID of the key you used to encrypt the secret.

src/Schema/Actions/CreateOrgVariable/Request/Applicationjson.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
public const SCHEMA_JSON = '{"required":["name","value","visibility"],"type":"object","properties":{"name":{"type":"string","description":"The name of the variable."},"value":{"type":"string","description":"The value of the variable."},"visibility":{"enum":["all","private","selected"],"type":"string","description":"The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable."},"selected_repository_ids":{"type":"array","items":{"type":"integer"},"description":"An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`."}}}';
1414
public const SCHEMA_TITLE = '';
1515
public const SCHEMA_DESCRIPTION = '';
16-
public const SCHEMA_EXAMPLE_DATA = '{"name":"generated_name_null","value":"generated_value_null","visibility":"all","selectedRepositoryIds":[13]}';
16+
public const SCHEMA_EXAMPLE_DATA = '{"name":"generated_name_null","value":"generated_value_null","visibility":"all","selected_repository_ids":[13]}';
1717
/**
1818
* name: The name of the variable.
1919
* value: The value of the variable.

src/Schema/Actions/CreateRequiredWorkflow/Request/Applicationjson.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
public const SCHEMA_JSON = '{"required":["workflow_file_path","repository_id"],"type":"object","properties":{"workflow_file_path":{"type":"string","description":"Path of the workflow file to be configured as a required workflow."},"repository_id":{"type":"string","description":"The ID of the repository that contains the workflow file."},"scope":{"enum":["selected","all"],"type":"string","description":"Enable the required workflow for all repositories or selected repositories in the organization.","default":"all"},"selected_repository_ids":{"type":"array","items":{"type":"integer","description":"Unique identifier of the repository."},"description":"A list of repository IDs where you want to enable the required workflow. You can only provide a list of repository ids when the `scope` is set to `selected`."}}}';
1414
public const SCHEMA_TITLE = '';
1515
public const SCHEMA_DESCRIPTION = '';
16-
public const SCHEMA_EXAMPLE_DATA = '{"workflowFilePath":"generated_workflow_file_path_null","repositoryId":"generated_repository_id_null","scope":"selected","selectedRepositoryIds":[13]}';
16+
public const SCHEMA_EXAMPLE_DATA = '{"workflow_file_path":"generated_workflow_file_path_null","repository_id":"generated_repository_id_null","scope":"selected","selected_repository_ids":[13]}';
1717
/**
1818
* workflowFilePath: Path of the workflow file to be configured as a required workflow.
1919
* repositoryId: The ID of the repository that contains the workflow file.

src/Schema/Actions/CreateSelfHostedRunnerGroupForOrg/Request/Applicationjson.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
public const SCHEMA_JSON = '{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the runner group."},"visibility":{"enum":["selected","all","private"],"type":"string","description":"Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.","default":"all"},"selected_repository_ids":{"type":"array","items":{"type":"integer","description":"Unique identifier of the repository."},"description":"List of repository IDs that can access the runner group."},"runners":{"type":"array","items":{"type":"integer","description":"Unique identifier of the runner."},"description":"List of runner IDs to add to the runner group."},"allows_public_repositories":{"type":"boolean","description":"Whether the runner group can be used by `public` repositories.","default":false},"restricted_to_workflows":{"type":"boolean","description":"If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.","default":false},"selected_workflows":{"type":"array","items":{"type":"string","description":"Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.","examples":["octo-org\\/octo-repo\\/.github\\/workflows\\/deploy.yaml@main"]},"description":"List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`."}}}';
1414
public const SCHEMA_TITLE = '';
1515
public const SCHEMA_DESCRIPTION = '';
16-
public const SCHEMA_EXAMPLE_DATA = '{"name":"generated_name_null","visibility":"selected","selectedRepositoryIds":[13],"runners":[13],"allowsPublicRepositories":false,"restrictedToWorkflows":false,"selectedWorkflows":["generated_selected_workflows_null"]}';
16+
public const SCHEMA_EXAMPLE_DATA = '{"name":"generated_name_null","visibility":"selected","selected_repository_ids":[13],"runners":[13],"allows_public_repositories":false,"restricted_to_workflows":false,"selected_workflows":["generated_selected_workflows_null"]}';
1717
/**
1818
* name: Name of the runner group.
1919
* visibility: Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

src/Schema/Actions/ReRunJobForWorkflowRun/Request/Applicationjson.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
public const SCHEMA_JSON = '{"type":["object","null"],"properties":{"enable_debug_logging":{"type":"boolean","description":"Whether to enable debug logging for the re-run.","default":false}}}';
1414
public const SCHEMA_TITLE = '';
1515
public const SCHEMA_DESCRIPTION = '';
16-
public const SCHEMA_EXAMPLE_DATA = '{"enableDebugLogging":false}';
16+
public const SCHEMA_EXAMPLE_DATA = '{"enable_debug_logging":false}';
1717
/**
1818
* enableDebugLogging: Whether to enable debug logging for the re-run.
1919
*/

src/Schema/Actions/ReviewPendingDeploymentsForRun/Request/Applicationjson.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
public const SCHEMA_JSON = '{"required":["environment_ids","state","comment"],"type":"object","properties":{"environment_ids":{"type":"array","items":{"type":"integer","examples":[161171787]},"description":"The list of environment ids to approve or reject","examples":[161171787,161171795]},"state":{"enum":["approved","rejected"],"type":"string","description":"Whether to approve or reject deployment to the specified environments.","examples":["approved"]},"comment":{"type":"string","description":"A comment to accompany the deployment review","examples":["Ship it!"]}}}';
1414
public const SCHEMA_TITLE = '';
1515
public const SCHEMA_DESCRIPTION = '';
16-
public const SCHEMA_EXAMPLE_DATA = '{"environmentIds":[161171787],"state":"approved","comment":"Ship it!"}';
16+
public const SCHEMA_EXAMPLE_DATA = '{"environment_ids":[161171787],"state":"approved","comment":"Ship it!"}';
1717
/**
1818
* environmentIds: The list of environment ids to approve or reject
1919
* @param array<int> $environmentIds

src/Schema/Actions/SetGithubActionsPermissionsOrganization/Request/Applicationjson.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
public const SCHEMA_JSON = '{"required":["enabled_repositories"],"type":"object","properties":{"enabled_repositories":{"enum":["all","none","selected"],"type":"string","description":"The policy that controls the repositories in the organization that are allowed to run GitHub Actions."},"allowed_actions":{"enum":["all","local_only","selected"],"type":"string","description":"The permissions policy that controls the actions and reusable workflows that are allowed to run."}}}';
1414
public const SCHEMA_TITLE = '';
1515
public const SCHEMA_DESCRIPTION = '';
16-
public const SCHEMA_EXAMPLE_DATA = '{"enabledRepositories":"all","allowedActions":"all"}';
16+
public const SCHEMA_EXAMPLE_DATA = '{"enabled_repositories":"all","allowed_actions":"all"}';
1717
/**
1818
* enabledRepositories: The policy that controls the repositories in the organization that are allowed to run GitHub Actions.
1919
* allowedActions: The permissions policy that controls the actions and reusable workflows that are allowed to run.

src/Schema/Actions/SetGithubActionsPermissionsRepository/Request/Applicationjson.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
public const SCHEMA_JSON = '{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether GitHub Actions is enabled on the repository."},"allowed_actions":{"enum":["all","local_only","selected"],"type":"string","description":"The permissions policy that controls the actions and reusable workflows that are allowed to run."}}}';
1414
public const SCHEMA_TITLE = '';
1515
public const SCHEMA_DESCRIPTION = '';
16-
public const SCHEMA_EXAMPLE_DATA = '{"enabled":false,"allowedActions":"all"}';
16+
public const SCHEMA_EXAMPLE_DATA = '{"enabled":false,"allowed_actions":"all"}';
1717
/**
1818
* enabled: Whether GitHub Actions is enabled on the repository.
1919
* allowedActions: The permissions policy that controls the actions and reusable workflows that are allowed to run.

0 commit comments

Comments
 (0)