codacy-api/ and routing fixes

claudiacodacy · claudiacodacy · commit c9881b9f9a46 · 2025-12-22T10:04:06.000Z
diff --git a/docusaurus/docs/codacy-api/api-tokens.mdx b/docusaurus/docs/codacy-api/api-tokens.mdx
@@ -8,24 +8,24 @@ import ApiTokenWarning from './../_includes/ApiTokenWarning.mdx'
 Codacy provides **account** and **repository**-level API tokens that allow you to:
 
 -   [Upload coverage data](../coverage-reporter/index.md) to Codacy
--   Upload to Codacy the results of [running client-side analysis tools](../repositories-configure/local-analysis/client-side-tools.md)
--   [Authenticate when using the Codacy API](using-the-codacy-api.md#authenticating-requests)
+-   Upload to Codacy the results of [running client-side analysis tools](../repositories-configure/local-analysis/client-side-tools)
+-   [Authenticate when using the Codacy API](using-the-codacy-api#authenticating-requests)
 
 The sections below provide details about the two types of API tokens and instructions on how to generate and revoke them.
 
 <ApiTokenWarning />
 
-## Generating and revoking account API tokens ||account-api-tokens||
+## Generating and revoking account API tokens \{#account-api-tokens\}
 
-Account API tokens are defined at the **Codacy user account level**. Each account API token authorizes access to the same organizations, repositories, and operations as the [roles and permissions of the owner of the account](../organizations/roles-and-permissions-for-organizations.md).
+Account API tokens are defined at the **Codacy user account level**. Each account API token authorizes access to the same organizations, repositories, and operations as the [roles and permissions of the owner of the account](../organizations/roles-and-permissions-for-organizations).
 
 :::caution
-**If you're using an account API token to upload coverage** be sure to [check the roles](../organizations/roles-and-permissions-for-organizations.md) that your Git provider account must have to authorize uploading coverage to Codacy.
+**If you're using an account API token to upload coverage** be sure to [check the roles](../organizations/roles-and-permissions-for-organizations) that your Git provider account must have to authorize uploading coverage to Codacy.
 
 Use a dedicated service account to integrate Codacy with your repositories. This prevents disruption of service if the user who created an account API token loses access to the repositories, which may happen when a user leaves the team or the organization.
 :::
 
-You can create new account API tokens programmatically [using the Codacy API](examples/creating-repository-api-tokens-programmatically.md) or using the Codacy UI:
+You can create new account API tokens programmatically [using the Codacy API](examples/creating-repository-api-tokens-programmatically) or using the Codacy UI:
 
 1. Open your account, tab **Access management**.
 
@@ -47,11 +47,11 @@ When you have tokens created, you can view them inside the tokens table. By hove
 
 To delete an account API token, click the trash icon in the Actions column of the table. After this, all applications or services using that token to access the Codacy API will fail to authenticate and will receive the reply `{"error":"not found"}`.
 
-## Generating and revoking repository API tokens ||repository-api-tokens"||
+## Generating and revoking repository API tokens \{#repository-api-tokens\}
 
 Repository API tokens are defined on **individual repositories**. Each repository API token only authorizes access to the corresponding repository.
 
-You can create new repository API tokens programmatically [using the Codacy API](examples/creating-repository-api-tokens-programmatically.md) or using the Codacy UI:
+You can create new repository API tokens programmatically [using the Codacy API](examples/creating-repository-api-tokens-programmatically) or using the Codacy UI:
 
 1.  Open your repository **Settings**, tab **Integrations**.
 
@@ -67,5 +67,5 @@ To revoke a repository API token, click the **X** next to the token. After this,
 ## See also
 
 -   [Adding coverage to your repository](../coverage-reporter/index.md)
--   [Client-side tools](../repositories-configure/local-analysis/client-side-tools.md)
--   [Creating repository API tokens programmatically](examples/creating-repository-api-tokens-programmatically.md)
+-   [Client-side tools](../repositories-configure/local-analysis/client-side-tools)
+-   [Creating repository API tokens programmatically](examples/creating-repository-api-tokens-programmatically)
diff --git a/docusaurus/docs/codacy-api/examples/adding-people-to-codacy-programmatically.mdx b/docusaurus/docs/codacy-api/examples/adding-people-to-codacy-programmatically.mdx
@@ -16,7 +16,7 @@ curl -X POST https://app.codacy.com/api/v3/organizations/<GIT_PROVIDER>/<ORGANIZ
 
 Substitute the placeholders with your own values:
 
--   **API_KEY:** [Account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API.
+-   **API_KEY:** [Account API token](../api-tokens#account-api-tokens) used to authenticate on the Codacy API.
 -   **GIT_PROVIDER:** Git provider hosting of the organization, using one of the values in the table below. For example, `gh` for GitHub Cloud.
 
     | Value | Git provider      |
@@ -39,7 +39,7 @@ We provide an example Bash script that adds all emails in a text file to Codacy.
 
 The example script:
 
-1.  Defines the [account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API.
+1.  Defines the [account API token](../api-tokens#account-api-tokens) used to authenticate on the Codacy API.
 1.  Defines the path and filename of the file containing the email addresses list.
 1.  Uses `awk` and `sed` to read the email addresses list from a file.
 1.  Calls the endpoint [addPeopleToOrganization](https://app.codacy.com/api/api-docs#addpeopletoorganization) to add a list of email addresses to Codacy.
@@ -70,4 +70,4 @@ email4@codacy.com
 
 ## See also
 
-- [Adding people to your organization](/organizations/managing-people/#adding-people)
+- [Adding people to your organization](../../organizations/managing-people#adding-people)
diff --git a/docusaurus/docs/codacy-api/examples/adding-repositories-to-codacy-programmatically.mdx b/docusaurus/docs/codacy-api/examples/adding-repositories-to-codacy-programmatically.mdx
@@ -21,7 +21,7 @@ curl -X POST https://app.codacy.com/api/v3/repositories \
 
 Substitute the placeholders with your own values:
 
-- **API_KEY:** [Account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API.
+- **API_KEY:** [Account API token](../api-tokens#account-api-tokens) used to authenticate on the Codacy API.
 - **GIT_PROVIDER:** Git provider hosting of the repository, using one of the values in the table below. For example, `gh` for GitHub Cloud.
 
     | Value | Git provider      |
@@ -44,26 +44,27 @@ Substitute the placeholders with your own values:
 We provide an example Bash script that adds all repositories in a GitHub Cloud organization to Codacy. We suggest that you adapt the script to your specific scenario.
 
 :::caution
-    Since Codacy automatically analyzes new repositories, adding many repositories in a short time can cause delays in the analysis of other repositories depending on the size of the repositories, the sizing of the infrastructure, and the concurrent analysis configuration. For example:
+  Since Codacy automatically analyzes new repositories, adding many repositories in a short time can cause delays in the analysis of other repositories depending on the size of the repositories, the sizing of the infrastructure, and the concurrent analysis configuration. For example:
 
-    | Repositories added | Expected delay |
-    | ------------------ | -------------- |
-    | 1 to 10            | Small          |
-    | 11 to 100          | Considerable   |
-    | More than 100      | Extreme        |
+  | Repositories added | Expected delay |
+  | ------------------ | -------------- |
+  | 1 to 10            | Small          |
+  | 11 to 100          | Considerable   |
+  | More than 100      | Extreme        |
 
-    To avoid these delays, add repositories in small batches or space out adding new repositories over time.
+  To avoid these delays, add repositories in small batches or space out adding new repositories over time.
 :::
 
 The example script:
 
-1.  Defines a GitHub [personal access token](https://github.com/settings/tokens), the GitHub organization name, and the [account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API.
+1.  Defines a GitHub [personal access token](https://github.com/settings/tokens), the GitHub organization name, and the [account API token](../api-tokens#account-api-tokens) used to authenticate on the Codacy API.
 1.  Calls the GitHub API to [obtain the list of all repositories](https://docs.github.com/en/rest/repos/repos#list-organization-repositories) in the defined organization.
 1.  Uses [jq](https://github.com/stedolan/jq) to return the value of `full_name` for each repository obtained in the JSON response. The `full_name` already includes the organization and repository names using the format `<organization>/<repository>`.
 1.  For each repository, calls the endpoint [<span class="skip-vale">addRepository</span>](https://app.codacy.com/api/api-docs#addrepository) to add a new repository specifying `gh` as the Git provider and the value of `full_name` as the full path of the repository.
 1.  Checks the HTTP status code obtained in the response and performs basic error handling.
 1.  Pauses a few seconds between requests to the Codacy API to avoid rate limiting.
 
+
 ```bash
 #!/bin/bash
 
diff --git a/docusaurus/docs/codacy-api/examples/creating-repository-api-tokens-programmatically.mdx b/docusaurus/docs/codacy-api/examples/creating-repository-api-tokens-programmatically.mdx
@@ -5,7 +5,7 @@ description: Example of how to create new repository API tokens for all reposito
 import ApiExamplePaginationImportant from '../../_includes/ApiExamplePaginationImportant.mdx'
 
 
-To create new [repository API tokens](../api-tokens.md) for your Codacy repositories programmatically, use the Codacy API endpoint [createRepositoryApiToken](https://app.codacy.com/api/api-docs#createrepositoryapitoken). You can also list all repository API tokens for a repository using the endpoint [listRepositoryApiTokens](https://api.codacy.com/api/api-docs#listrepositoryapitokens).
+To create new [repository API tokens](../api-tokens) for your Codacy repositories programmatically, use the Codacy API endpoint [createRepositoryApiToken](https://app.codacy.com/api/api-docs#createrepositoryapitoken). You can also list all repository API tokens for a repository using the endpoint [listRepositoryApiTokens](https://api.codacy.com/api/api-docs#listrepositoryapitokens).
 
 For example, if you're [setting up coverage](../../coverage-reporter/index.md) for all your repositories and prefer not to use a single account API token that grants the same permissions as an administrator, you need to create an individual repository API token for each repository.
 
@@ -15,7 +15,7 @@ This example creates a new repository API token for a repository and outputs the
 
 The example script:
 
-1.  Defines the [account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API, the Git provider, the organization name, and the repository name passed as an argument to the script.
+1.  Defines the [account API token](../api-tokens#account-api-tokens) used to authenticate on the Codacy API, the Git provider, the organization name, and the repository name passed as an argument to the script.
 1.  Calls the endpoint [createRepositoryApiToken](https://app.codacy.com/api/api-docs#createrepositoryapitoken) to create a new repository API token and uses [jq](https://github.com/stedolan/jq) to obtain only the created token string.
 
 ```bash
@@ -95,7 +95,7 @@ This example lists all repository API tokens created for a repository.
 
 The example script:
 
-1.  Defines the [account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API, the Git provider, the organization name, and the repository name passed as an argument to the script.
+1.  Defines the [account API token](../api-tokens#account-api-tokens) used to authenticate on the Codacy API, the Git provider, the organization name, and the repository name passed as an argument to the script.
 1.  Calls the endpoint [listRepositoryApiTokens](https://api.codacy.com/api/api-docs#listrepositoryapitokens) to list the repository API tokens available on the repository and uses [jq](https://github.com/stedolan/jq) to obtain only the token strings, or exit with a non-zero status if the repository doesn't have any repository API tokens created yet.
 
 ```bash
diff --git a/docusaurus/docs/codacy-api/examples/identifying-commits-without-coverage-data.mdx b/docusaurus/docs/codacy-api/examples/identifying-commits-without-coverage-data.mdx
@@ -24,7 +24,7 @@ This example checks whether the open pull requests in a repository have received
 
 The example script:
 
-1.  Defines the [account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API, the Git provider, the organization name, and the repository name passed as an argument to the script.
+1.  Defines the [account API token](../api-tokens#account-api-tokens) used to authenticate on the Codacy API, the Git provider, the organization name, and the repository name passed as an argument to the script.
 1.  Calls the Codacy API endpoint [listRepositoryPullRequests](https://api.codacy.com/api/api-docs#listrepositorypullrequests) to retrieve the list of open pull requests on the repository.
 1.  Uses [jq](https://github.com/stedolan/jq) to select only the numbers that identify the pull requests on the Git provider.
 1.  For each pull request, outputs the pull request number and calls the Codacy API endpoint [getPullRequestCoverageReports](https://api.codacy.com/api/api-docs#getpullrequestcoveragereports) to obtain the information about the coverage data received for the head and common ancestor commits of the pull request.
diff --git a/docusaurus/docs/codacy-api/examples/obtaining-code-quality-metrics-for-files.mdx b/docusaurus/docs/codacy-api/examples/obtaining-code-quality-metrics-for-files.mdx
@@ -16,7 +16,7 @@ This example exports the grade, total issues, complexity, coverage, and duplicat
 
 The example script:
 
-1.  Defines the [account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API.
+1.  Defines the [account API token](../api-tokens#account-api-tokens) used to authenticate on the Codacy API.
 1.  Calls the endpoint [<span class="skip-vale">listFiles</span>](https://app.codacy.com/api/api-docs#listfiles) to retrieve the code quality metrics, filtering the results by files that include `src/router/` in the path.
 1.  Uses [jq](https://github.com/stedolan/jq) to select only the necessary data fields and convert the results to the CSV format.
 
@@ -45,5 +45,5 @@ Example output:
 
 ## See also
 
--   [Which metrics does Codacy calculate?](../../faq/code-analysis/which-metrics-does-codacy-calculate.md)
--   [Files page](../../repositories/files.md)
+-   [Which metrics does Codacy calculate?](../../faq/code-analysis/which-metrics-does-codacy-calculate)
+-   [Files page](../../repositories/files)
diff --git a/docusaurus/docs/codacy-api/examples/obtaining-current-issues-in-repositories.mdx b/docusaurus/docs/codacy-api/examples/obtaining-current-issues-in-repositories.mdx
@@ -15,7 +15,7 @@ This example exports the pattern ID, issue level, file path, and timestamp for a
 
 The example script:
 
-1.  Defines the [account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API.
+1.  Defines the [account API token](../api-tokens#account-api-tokens) used to authenticate on the Codacy API.
 1.  Calls the endpoint [searchRepositoryIssues](https://app.codacy.com/api/api-docs#searchrepositoryissues) to retrieve information about the issues, filtering the results by security issues with the relevant severity levels.
 1.  Uses [jq](https://github.com/stedolan/jq) to select only the necessary data fields and convert the results to the CSV format.
 
@@ -45,5 +45,5 @@ Example output:
 
 ## See also
 
--   [Which metrics does Codacy calculate?](../../faq/code-analysis/which-metrics-does-codacy-calculate.md)
--   [Issues page](../../repositories/issues.md)
+-   [Which metrics does Codacy calculate?](../../faq/code-analysis/which-metrics-does-codacy-calculate)
+-   [Issues page](../../repositories/issues)
diff --git a/docusaurus/docs/codacy-api/examples/triggering-dast-scans.mdx b/docusaurus/docs/codacy-api/examples/triggering-dast-scans.mdx
@@ -8,7 +8,7 @@ Thanks to the new app scanning capabilities available on the Security and risk m
 :::caution
 **App scanning is a business feature.** If you are a Codacy Pro customer, contact our customer success team to access a short trial.
 
-**Check your [permissions](../../organizations/roles-and-permissions-for-organizations.md).** Only git provider admins and organization managers will be able to create new targets and trigger scans (in app and via the API).
+**Check your [permissions](../../organizations/roles-and-permissions-for-organizations).** Only git provider admins and organization managers will be able to create new targets and trigger scans (in app and via the API).
 :::
 
 
@@ -52,12 +52,12 @@ Replace the placeholders with your own values:
 
 | Field | Required | Description |
 |-------|----------|-------------|
-| **API_KEY** | true | [Account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API |
+| **API_KEY** | true | [Account API token](../api-tokens#account-api-tokens) used to authenticate on the Codacy API |
 | **GIT_PROVIDER** | true | Git provider hosting of the organization, using one of the values in the table below. <br/>**Options:** `gh` (GitHub Cloud), `ghe`(GitHub Enterprise), `gl` (Gitlab Cloud), `gle` (Gitlab Enterprise), `bb` (Bitbucket Cloud), `bbe` (Bitbucket Server) | 
 | **ORGANIZATION** | true | Name of the organization on the Git provider. You must have admin permissions over the organization on the Git provider.<br/>For example, `codacy` |
 | **TARGET_URL** | true | URL of the Web app or API that will be scanned. <br/>Must start with `http://` or `https://`<br/>For example, `https://api.codacy.com/v1`|
 | **TARGET_TYPE** | false | Type of target to be scanned <br/> **Options:** `webapp` (default), `openapi` or `graphql`|
-| **API_DEFINITION_URL** | false * | The URL to a publicly accessible OpenAPI specification.<br/>*** Required for OpenAPI targets**|
+| **API_DEFINITION_URL** | false * | The URL to a publicly accessible OpenAPI specification.<br/>* **Required for OpenAPI targets**|
 | **HEADER_NAME** | false | Name of the authentication header. <br/>For example, `Authentication`|
 | **HEADER_VALUE** | false | Value of the authentication header. <br/>For example, a token or API key|
 
@@ -79,12 +79,12 @@ curl -X POST https://app.codacy.com/api/v3/organizations/{GIT_PROVIDER}/{ORGANIZ
 
 Replace the placeholders with your own values:
 
--   **API_KEY:** [Account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API.
+-   **API_KEY:** [Account API token](../api-tokens#account-api-tokens) used to authenticate on the Codacy API.
 -   **GIT_PROVIDER:** Git provider hosting of the organization (check the table on the example above). For example, `gh` for GitHub Cloud.
 -   **ORGANIZATION:** Name of the organization on the Git provider. For example, `codacy`. You must have admin permissions over the organization on the Git provider.
--   **DAST_TARGET_ID:** Identifier of a DAST target to analyze (obtained in the [previous section](./triggering-dast-scans.md#creating-targets). For example, `457`. You must have admin permissions over the organization on the Git provider.
+-   **DAST_TARGET_ID:** Identifier of a DAST target to analyze (obtained in the [previous section](./triggering-dast-scans#creating-targets). For example, `457`. You must have admin permissions over the organization on the Git provider.
 
-Scans occur asynchronously. To monitor an ongoing scan you can use the [target management page in Codacy](../../organizations/managing-security-and-risk.md#app-scanning). Once completed, you can access all scan results by navigating to the **Security dashboard**, selecting the **Findings tab** and filtering by **Scan types > DAST/App scanning**, or by clicking on a configured target to expand all of that target's results.
+Scans occur asynchronously. To monitor an ongoing scan you can use the [target management page in Codacy](../../organizations/managing-security-and-risk#app-scanning). Once completed, you can access all scan results by navigating to the **Security dashboard**, selecting the **Findings tab** and filtering by **Scan types > DAST/App scanning**, or by clicking on a configured target to expand all of that target's results.
 Additionaly, you can use the `SearchSRMItems` endpoint to filter findings by their DAST target URL with the following request:
 ```bash
 curl -X POST https://app.codacy.com/api/v3/organizations/gh/codacy/security/items/search \
diff --git a/docusaurus/docs/codacy-api/examples/uploading-dast-results.mdx b/docusaurus/docs/codacy-api/examples/uploading-dast-results.mdx
diff --git a/docusaurus/docs/index.mdx b/docusaurus/docs/index.mdx
diff --git a/docusaurus/docusaurus.config.ts b/docusaurus/docusaurus.config.ts
