GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves NuGet symbol files from a specific project in GitLab using the GitLab API. It is useful for developers who need to access symbol files for debugging or symbolication purposes in their CI/CD pipelines or development workflows. For example, it can fetch symbol files by specifying the project ID, file name, signature, and a parameter to match the same file name.

Use Case Examples

  1. Fetching a symbol file for a NuGet package in a GitLab project to debug an application error.
  2. Automating the retrieval of symbol files during a build process to ensure symbols are available for crash reporting.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically an API key credential.
baseUrl The base URL of the GitLab instance to send the request to.
Method The HTTP method to use for the request (GET, POST, PUT, DELETE, HEAD, PATCH).
Parameter Schema Defines the required parameters for the API call including header, path, and query parameters.
Request Body Schema Schema for the request body if applicable (null for this operation).
Request Path The API endpoint path with placeholders for path parameters.
Query Parameters Collection of query parameters including file_name, signature, and same_file_name used to specify the symbol file details.
Path Parameters Collection of path parameters including the project ID or URL-encoded path.
Header Parameters Collection of header parameters including Symbolchecksum required for the request.

Output

JSON

  • response - The JSON response from the GitLab API containing the requested NuGet symbol file data.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the project ID is correct and accessible with the provided authentication.
  • Verify that the Symbolchecksum header is correctly set and matches the expected checksum.
  • Check that the file_name, signature, and same_file_name query parameters are correctly specified and valid.
  • Common errors include 401 Unauthorized (authentication issues), 404 Not Found (incorrect project ID or file parameters), and 400 Bad Request (missing or invalid parameters).
  • To resolve errors, verify credentials, parameter values, and API endpoint correctness.

Links

Discussion