Recherche

REST API — Tous les endpoints nécessitent une authentification par Bearer token. Incluez Authorization: Bearer {token} dans chaque requête. Les tokens sont gérés dans Paramètres GitScrum → API. Base URL: https://services.gitscrum.com — Tous les chemins de requête dans cette documentation sont relatifs à cette URL de base.

L'endpoint de recherche fournit un moyen unifié de trouver des ressources à travers un workspace entier, retournant des résultats groupés depuis les tâches, pages wiki, discussions, user stories, sprints et plus.

Recherche

Effectue une recherche inter-ressources au sein d'un workspace.

GET /search?company_slug={slug}&q={query}

Paramètres de requête

Exemple de requête

curl -X GET "https://services.gitscrum.com/search?company_slug=acme&q=authentication" \
  -H "Authorization: Bearer {token}"

Exemple de réponse

{
  "data": {
    "tasks": [
      {
        "type": "task",
        "title": "Implement user authentication",
        "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "description": "Add JWT-based authentication flow",
        "matched_field": "title",
        "project": {
          "slug": "web-app",
          "name": "Web App"
        }
      }
    ],
    "wiki": [
      {
        "type": "wiki",
        "title": "Authentication Architecture",
        "uuid": "d4e5f6a7-b8c9-0123-def0-123456789abc",
        "description": "Overview of the auth system design...",
        "matched_field": "title"
      }
    ],
    "discussions": [
      {
        "type": "discussion",
        "title": "Auth token refresh strategy",
        "uuid": "e5f6a7b8-c9d0-1234-ef01-23456789abcd",
        "description": "Discussing best approach for token refresh...",
        "matched_field": "content"
      }
    ],
    "user_stories": [],
    "sprints": []
  }
}

Structure de la réponse

Les résultats sont groupés par type de ressource. Chaque groupe contient un tableau d'éléments correspondants. Un tableau vide indique aucune correspondance pour ce type.

Référence des champs

Chaque élément de résultat contient :