GET /api/repos/:repoId/gaps

Summary

Retrieves the latest gap report for a specified repository.

Intent

Allows clients to fetch the most recent documentation gap analysis for a repository, enabling them to identify missing or incomplete API documentation coverage.

Parameters

Name	Type	Required	Description
repoId	string	Yes	The unique identifier of the repository whose gap report should be retrieved.
customerId	string	No	Optional customer identifier used to verify ownership of the repository. If provided, the request will be rejected with 403 if the repo does not belong to this customer.

Request example

curl -X GET "https://maps.google.com/api/repos/repo-123/gaps?customerId=cust-456" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response example

{
  "gapReport": {
    "repoId": "repo-123",
    "gaps": [
      {
        "field": "base_url",
        "severity": "critical",
        "reason": "No base URL configured"
      },
      {
        "field": "auth",
        "severity": "warning",
        "reason": "Authentication method not specified"
      }
    ],
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}

Error cases

• 404 — No repository exists with the given repoId
• 403 — A customerId query parameter was provided but does not match the customerId associated with the repository

Gotchas

• The gapReport field in the response may be null or undefined if no gap report has been generated yet for the repository — always check for its presence before accessing nested fields.
• The customerId query parameter acts as an ownership guard: if supplied and it does not match the repo’s stored customerId, the request returns 403 even if the repoId is valid.
• Authentication is not enforced at the handler level (auth required: false), but the customerId check provides a secondary access control mechanism.
• This endpoint returns the latest gap report only — there is no pagination or historical access to previous reports.