From cf8112597317d6526f7b5d3356e5130c11c9ea10 Mon Sep 17 00:00:00 2001 From: "andrzej.janczak" Date: Fri, 11 Oct 2024 11:43:16 +0200 Subject: [PATCH 1/4] add more endpoints for audit log --- .../audit-logs-for-organizations.md | 60 +++++++++++-------- 1 file changed, 36 insertions(+), 24 deletions(-) diff --git a/docs/organizations/audit-logs-for-organizations.md b/docs/organizations/audit-logs-for-organizations.md index d986761c2a..a7c910d140 100644 --- a/docs/organizations/audit-logs-for-organizations.md +++ b/docs/organizations/audit-logs-for-organizations.md @@ -33,30 +33,31 @@ The sections below list the events that Codacy logs for your organization at use ### Organization -|Event|Description|Action| -|-----|-----------|------| -|[Add organization](./what-are-organizations.md#adding-an-organization)|Organization added to Codacy|`organizations.create`| -|[Add people](./managing-people.md#adding-people) to organization|New people added to the organization|`organizations.people.create`| -|[Join organization](./managing-people.md#joining)|User joined the organization|`organizations.join`| -|Update [repository management permissions](./roles-and-permissions-for-organizations.md#change-analysis-configuration)|Repository management permissions updated|`organizations.analysisconfigurationminimumpermission.update`| -|Assign [organization manager role](./roles-and-permissions-for-organizations.md#managing-the-organization-manager-role)|Organization manager role assigned to a team member|`organizations.security.managers.create`| -|Revoke organization manager role|Organization manager role revoked from a team member|`organizations.security.managers.delete`| -|Update [default Git provider configuration](./integrations/default-git-provider-integration-settings.md)|Default Git provider configuration for the organization updated|`organizations.integrations.providersettings.update`| -|Apply default Git provider configuration to all repositories|Default Git provider configuration applied to all repositories of the organization|`organizations.integrations.providersettings.apply`| -|Create new organization hook|New organization webhook created|`organizations.settings.hooks.create`| -|Create new [gate policy](./using-gate-policies.md)|New gate policy created|`organizations.gatepolicies.create`| -|Update gate policy|Quality gate definition updated|`organizations.gatepolicies.update`| -|Apply gate policy to repositories|Gate policy applied to a list of repositories|`organizations.gatepolicies.repositories.apply`| -|Make gate policy default|Gate policy was made the default for the organization|`organizations.gatepolicies.setdefault`| -|Make Codacy gate policy default|Built-in Codacy gate policy was made the default for the organization|`organizations.gatepolicies.setcodacydefault`| -|Delete gate policy|Gate policy deleted|`organizations.gatepolicies.delete`| -|Create new [coding standard](./using-coding-standards.md) using preset sensitivity levels|New coding standard created|`organizations.presetsstandards.create`| -|Create new coding standard draft using individual language and code pattern settings|New coding standard draft created|`organizations.codingstandards.create`| -|Create new coding standard from draft|New coding standard created|`organizations.codingstandards.promote`| -|Update coding standard from draft|Coding standard updated|`organizations.codingstandards.promote`| -|Apply coding standard to repositories|Coding standard applied to a list of repositories|`organizations.codingstandards.repositories.apply`| -|Make coding standard default|Coding standard was made the default|`organizations.codingstandards.setdefault`| -|Delete coding standard|Coding standard deleted|`organizations.codingstandards.delete`| +| Event |Description|Action| +|----------------------------------------------------------------------------------------------------------------------|-----------|------| +| [Add organization](./what-are-organizations.md#adding-an-organization) |Organization added to Codacy|`organizations.create`| +| [Add people](./managing-people.md#adding-people) to organization |New people added to the organization|`organizations.people.create`| +| [Join organization](./managing-people.md#joining) |User joined the organization|`organizations.join`| +| Update [repository management permissions](./roles-and-permissions-for-organizations.md#change-analysis-configuration) |Repository management permissions updated|`organizations.analysisconfigurationminimumpermission.update`| +| Assign [organization manager role](./roles-and-permissions-for-organizations.md#managing-the-organization-manager-role) |Organization manager role assigned to a team member|`organizations.security.managers.create`| +| Revoke organization manager role |Organization manager role revoked from a team member|`organizations.security.managers.delete`| +| Update [default Git provider configuration](./integrations/default-git-provider-integration-settings.md) |Default Git provider configuration for the organization updated|`organizations.integrations.providersettings.update`| +| Apply default Git provider configuration to all repositories |Default Git provider configuration applied to all repositories of the organization|`organizations.integrations.providersettings.apply`| +| Create new organization hook |New organization webhook created|`organizations.settings.hooks.create`| +| Create new [gate policy](./using-gate-policies.md) |New gate policy created|`organizations.gatepolicies.create`| +| Update gate policy |Quality gate definition updated|`organizations.gatepolicies.update`| +| Apply gate policy to repositories |Gate policy applied to a list of repositories|`organizations.gatepolicies.repositories.apply`| +| Make gate policy default |Gate policy was made the default for the organization|`organizations.gatepolicies.setdefault`| +| Make Codacy gate policy default |Built-in Codacy gate policy was made the default for the organization|`organizations.gatepolicies.setcodacydefault`| +| Delete gate policy |Gate policy deleted|`organizations.gatepolicies.delete`| +| Create new [coding standard](./using-coding-standards.md) using preset sensitivity levels |New coding standard created|`organizations.presetsstandards.create`| +| Create new coding standard draft using individual language and code pattern settings |New coding standard draft created|`organizations.codingstandards.create`| +| Create new coding standard from draft |New coding standard created|`organizations.codingstandards.promote`| +| Update coding standard from draft |Coding standard updated|`organizations.codingstandards.promote`| +| Apply coding standard to repositories |Coding standard applied to a list of repositories|`organizations.codingstandards.repositories.apply`| +| Make coding standard default |Coding standard was made the default|`organizations.codingstandards.setdefault`| +| Delete coding standard |Coding standard deleted|`organizations.codingstandards.delete`| +| Export [security items](./managing-security-and-risk.md) |Export security items|`organizations.security.items.export`| ### Repository @@ -68,3 +69,14 @@ The sections below list the events that Codacy logs for your organization at use |Delete repository API token|Repository API token deleted|`repositories.tokens.delete`| |Update Git provider integration settings
([GitHub](../repositories-configure/integrations/github-integration.md#configuring), [Bitbucket](../repositories-configure/integrations/bitbucket-integration.md#configuring), or [GitLab](../repositories-configure/integrations/gitlab-integration.md#configuring))|Git provider integration settings for the repository updated|`repositories.integrations.providersettings.update`| |Refresh Git provider integration
(applies only to [Bitbucket](../repositories-configure/integrations/bitbucket-integration.md#refreshing) and [GitLab](../repositories-configure/integrations/gitlab-integration.md#refreshing))|Git provider integration for the repository refreshed|`repositories.integrations.refreshprovider`| +| Update issue |Update issue|`repositories.issues.update`| +| Update tool |Update tool|`repositories.tools.update`| +| Bypass pull request |Bypass pull request|`repositories.pullrequests.bypass`| +| Update repository language |Update repository language|`repositories.settings.language.update`| +| Update branch |Update branch|`repositories.branches.update`| +| Update analysis settings |Update analysis settings|`repositories.settings.analysis.update`| +| Reanalyze commit |Reanalyze commit|`repositories.reanalyzeCommit`| +| Synchronize repository with provider |Synchronize repository with provider|`repositories.settings.provider.sync`| +| Update quality settings for repository |Update quality settings for repository|`repositories.settings.quality.repository.update`| +| Update quality settings for pull requests |Update quality settings for pull requests|`repositories.settings.quality.pullrequests.update`| +| Update file state |Update file state|`repositories.file.update`| \ No newline at end of file From a93ff44b73da9b31b9f82e77ccf6c8e15e95bc4a Mon Sep 17 00:00:00 2001 From: "andrzej.janczak" Date: Fri, 11 Oct 2024 14:59:17 +0200 Subject: [PATCH 2/4] improve description --- .../audit-logs-for-organizations.md | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/organizations/audit-logs-for-organizations.md b/docs/organizations/audit-logs-for-organizations.md index a7c910d140..43c4a9d7f3 100644 --- a/docs/organizations/audit-logs-for-organizations.md +++ b/docs/organizations/audit-logs-for-organizations.md @@ -61,22 +61,22 @@ The sections below list the events that Codacy logs for your organization at use ### Repository -|Event|Description|Action| -|-----|-----------|------| -|Create new [post-commit hook](../repositories-configure/integrations/post-commit-hooks.md)|New repository hook created|`repositories.integrations.postcommithook`| -|Create [repository API token](../codacy-api/api-tokens.md#repository-api-tokens)|New repository API token created|`repositories.tokens.create`| -|Read repository API token|List of repository API tokens retrieved|`repositories.tokens.read`| -|Delete repository API token|Repository API token deleted|`repositories.tokens.delete`| -|Update Git provider integration settings
([GitHub](../repositories-configure/integrations/github-integration.md#configuring), [Bitbucket](../repositories-configure/integrations/bitbucket-integration.md#configuring), or [GitLab](../repositories-configure/integrations/gitlab-integration.md#configuring))|Git provider integration settings for the repository updated|`repositories.integrations.providersettings.update`| -|Refresh Git provider integration
(applies only to [Bitbucket](../repositories-configure/integrations/bitbucket-integration.md#refreshing) and [GitLab](../repositories-configure/integrations/gitlab-integration.md#refreshing))|Git provider integration for the repository refreshed|`repositories.integrations.refreshprovider`| -| Update issue |Update issue|`repositories.issues.update`| -| Update tool |Update tool|`repositories.tools.update`| -| Bypass pull request |Bypass pull request|`repositories.pullrequests.bypass`| -| Update repository language |Update repository language|`repositories.settings.language.update`| -| Update branch |Update branch|`repositories.branches.update`| -| Update analysis settings |Update analysis settings|`repositories.settings.analysis.update`| -| Reanalyze commit |Reanalyze commit|`repositories.reanalyzeCommit`| -| Synchronize repository with provider |Synchronize repository with provider|`repositories.settings.provider.sync`| -| Update quality settings for repository |Update quality settings for repository|`repositories.settings.quality.repository.update`| -| Update quality settings for pull requests |Update quality settings for pull requests|`repositories.settings.quality.pullrequests.update`| -| Update file state |Update file state|`repositories.file.update`| \ No newline at end of file +|Event| Description |Action| +|-----|--------------------------------------------------------------|------| +|Create new [post-commit hook](../repositories-configure/integrations/post-commit-hooks.md)| New repository hook created |`repositories.integrations.postcommithook`| +|Create [repository API token](../codacy-api/api-tokens.md#repository-api-tokens)| New repository API token created |`repositories.tokens.create`| +|Read repository API token| List of repository API tokens retrieved |`repositories.tokens.read`| +|Delete repository API token| Repository API token deleted |`repositories.tokens.delete`| +|Update Git provider integration settings
([GitHub](../repositories-configure/integrations/github-integration.md#configuring), [Bitbucket](../repositories-configure/integrations/bitbucket-integration.md#configuring), or [GitLab](../repositories-configure/integrations/gitlab-integration.md#configuring))| Git provider integration settings for the repository updated |`repositories.integrations.providersettings.update`| +|Refresh Git provider integration
(applies only to [Bitbucket](../repositories-configure/integrations/bitbucket-integration.md#refreshing) and [GitLab](../repositories-configure/integrations/gitlab-integration.md#refreshing))| Git provider integration for the repository refreshed |`repositories.integrations.refreshprovider`| +| Update issue | For example ignore issue |`repositories.issues.update`| +| Update tool | Can be change parameters or disable/enable tool |`repositories.tools.update`| +| Bypass pull request | Bypass pull request by authorized person |`repositories.pullrequests.bypass`| +| Update repository language | Change languages analyzed in repository |`repositories.settings.language.update`| +| Update branch | Enable or Disable branch for analyse |`repositories.branches.update`| +| Update analysis settings | Update analysis settings |`repositories.settings.analysis.update`| +| Reanalyze commit | Reanalyze commit or pull request |`repositories.reanalyzeCommit`| +| Synchronize repository with provider | Synchronize repository with provider |`repositories.settings.provider.sync`| +| Update quality settings for repository | Update quality settings for repository |`repositories.settings.quality.repository.update`| +| Update quality settings for pull requests | Update quality settings for pull requests |`repositories.settings.quality.pullrequests.update`| +| Update file state | Igonre or Unignore file |`repositories.file.update`| \ No newline at end of file From 6747f3906e52f64efa4e17dacb3b004d0dd49413 Mon Sep 17 00:00:00 2001 From: "andrzej.janczak" Date: Fri, 11 Oct 2024 15:24:22 +0200 Subject: [PATCH 3/4] improve description 2 --- docs/organizations/audit-logs-for-organizations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/organizations/audit-logs-for-organizations.md b/docs/organizations/audit-logs-for-organizations.md index 43c4a9d7f3..823d0b1f4f 100644 --- a/docs/organizations/audit-logs-for-organizations.md +++ b/docs/organizations/audit-logs-for-organizations.md @@ -75,7 +75,7 @@ The sections below list the events that Codacy logs for your organization at use | Update repository language | Change languages analyzed in repository |`repositories.settings.language.update`| | Update branch | Enable or Disable branch for analyse |`repositories.branches.update`| | Update analysis settings | Update analysis settings |`repositories.settings.analysis.update`| -| Reanalyze commit | Reanalyze commit or pull request |`repositories.reanalyzeCommit`| +| Reanalyze commit | Reanalyze commit or pull request |`repositories.reanalyzecommit`| | Synchronize repository with provider | Synchronize repository with provider |`repositories.settings.provider.sync`| | Update quality settings for repository | Update quality settings for repository |`repositories.settings.quality.repository.update`| | Update quality settings for pull requests | Update quality settings for pull requests |`repositories.settings.quality.pullrequests.update`| From e202b63c485b56acb0e9d0a3e9df86f3c3e28a74 Mon Sep 17 00:00:00 2001 From: Andrzej Janczak <122018786+andrzej-janczak@users.noreply.github.com> Date: Mon, 14 Oct 2024 12:34:24 +0200 Subject: [PATCH 4/4] Update audit-logs-for-organizations.md fix typo --- docs/organizations/audit-logs-for-organizations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/organizations/audit-logs-for-organizations.md b/docs/organizations/audit-logs-for-organizations.md index 823d0b1f4f..e9eb523b48 100644 --- a/docs/organizations/audit-logs-for-organizations.md +++ b/docs/organizations/audit-logs-for-organizations.md @@ -79,4 +79,4 @@ The sections below list the events that Codacy logs for your organization at use | Synchronize repository with provider | Synchronize repository with provider |`repositories.settings.provider.sync`| | Update quality settings for repository | Update quality settings for repository |`repositories.settings.quality.repository.update`| | Update quality settings for pull requests | Update quality settings for pull requests |`repositories.settings.quality.pullrequests.update`| -| Update file state | Igonre or Unignore file |`repositories.file.update`| \ No newline at end of file +| Update file state | Ignore or Unignore file |`repositories.file.update`|