docs: updates for PR #3868

[dosubot]

Update documentation for #3868

Generated by Dosu

Greptile Summary

This documentation-only PR (generated by Dosu) adds ~234 lines to apps/api/README.md, documenting environment variables, the GET /jobs endpoint, and a set of search endpoints. However, the documentation contains significant factual errors and documents non-existent functionality that will confuse users:

Critical Issues:

1. Two fictional environment variables — INNGEST_JOBS_MAX_EVENTS and INNGEST_EVENTS_RECEIVED_AFTER are documented as configurable, but neither is read anywhere in the codebase. The max-events limit is hardcoded at 500, not the documented default of 100.
2. Missing required API_KEY variable — All protected routes enforce X-API-Key authentication in the middleware, yet this critical environment variable is entirely absent from the documented env var list.
3. Misplaced search endpoint documentation — The large "Search Endpoints" section describes tRPC procedures that do not exist in this standalone Hono server. This service only exposes /deploy, /cancel-deployment, /health, /jobs, and /api/inngest. Documenting tRPC endpoints here implies they can be called against http://localhost:3000, which is incorrect.
4. Minor: missing trailing newline — The file ends without a trailing newline.

Recommendation: This PR should not be merged as-is. The documentation requires significant corrections before it is accurate enough to guide users.

Confidence Score: 0/5

• This PR should not be merged — the documentation contains multiple factual errors that will mislead users.
• Multiple verified issues prevent safe merge: (1) two environment variables documented but not implemented in code, with incorrect default values; (2) critical authentication variable (API_KEY) missing from docs; (3) entire search endpoints section describes tRPC procedures unrelated to this standalone Hono service, creating serious user confusion about available API endpoints; (4) missing trailing newline. These are not speculative issues — they are concrete inaccuracies in the documentation that directly contradict the implementation.
• apps/api/README.md — requires significant corrections before merging (remove search endpoints section, add API_KEY, correct max-events docs, add trailing newline)

_{Last reviewed commit: f233ae0}

_{(2/5) Greptile learns from your feedback when you react with thumbs up/down!}

Context used:

• Rule from dashboard - AGENTS.md (source)

[greptile-apps]

The INNGEST_JOBS_MAX_EVENTS variable is undocumented in the implementation. In service.ts, the maximum is hardcoded:

const DEFAULT_MAX_EVENTS = 500;
const MAX_EVENTS = DEFAULT_MAX_EVENTS;

The environment variable is never read. This means setting INNGEST_JOBS_MAX_EVENTS has no effect, and the actual default is 500 (not 100 as documented, and it's not configurable to a maximum of 10000).

[greptile-apps]

INNGEST_EVENTS_RECEIVED_AFTER is not implemented. The environment variable is never read in the codebase, and fetchInngestEvents() in service.ts constructs its query with only limit and cursor — there is no date filtering capability. Documenting this implies users can configure this behavior, which is misleading.

[greptile-apps]

The API_KEY environment variable is missing from the documentation. However, index.ts enforces authentication via API_KEY for all routes except /health and /api/inngest:

const authHeader = c.req.header("X-API-Key");
if (process.env.API_KEY !== authHeader) {
  return c.json({ message: "Invalid API Key" }, 403);
}

This is a required environment variable — callers must send it as the X-API-Key header or protected endpoints return 403. It should be documented prominently in the environment variables section.

[greptile-apps]

The "Search Endpoints" section documents tRPC procedures that do not exist in this service. This apps/api package is a standalone Hono HTTP server that only exposes /deploy, /cancel-deployment, /health, /jobs, and /api/inngest.

The search endpoints (application.search, compose.search, environment.search, project.search, postgres.search, mysql.search, mariadb.search, mongo.search, redis.search) are tRPC procedures from the main application's API, not endpoints available in this standalone service.

This section should be removed from this README to avoid confusion.

[greptile-apps]

Add a trailing newline at the end of the file. The file currently ends without one.

Suggested change

	- Returns total count for pagination UI
	- Returns total count for pagination UI
	\ No newline at end of file
	+ Returns total count for pagination UI

_{Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!}