Forgejo icon

Forgejo

Interact with Forgejo API

Overview

This node interacts with the Forgejo API to perform various operations related to users, repositories, issues, pull requests, organizations, releases, webhooks, branches, tags, and commits. Specifically, for the User resource with the Search operation, it allows searching for users based on a query string, with support for pagination and limiting the number of results per page. This is useful for scenarios where you need to find users matching certain criteria, such as in user management or analytics applications.

Use Case Examples

  1. Searching for users by name or other attributes to find specific user profiles.
  2. Fetching a list of users matching a search query for display or further processing.

Properties

Name Meaning
Query The search query string used to find users matching the criteria.
Additional Options Optional parameters to control pagination, including the page number to start from and the maximum number of results per page.

Output

JSON

  • json - The JSON response from the Forgejo API containing the search results for users.

Dependencies

  • Forgejo API with authentication via an API key credential named 'forgejoApi'

Troubleshooting

  • Ensure the 'forgejoApi' credential is correctly configured with the server URL and authentication token to avoid authentication errors.
  • If the search query is empty or invalid, the API may return no results or an error; ensure the 'Query' property is properly set.
  • Pagination parameters 'Page' and 'Limit' should be within acceptable ranges to avoid server errors or empty responses.

Links

  • Forgejo API Documentation - Official documentation for the Forgejo API, useful for understanding available endpoints and parameters.

Discussion