docs: updates for PR #3894

[dosubot]

Update documentation for #3894

Generated by Dosu

Greptile Summary

This auto-generated documentation PR updates CONTRIBUTING.md and apps/api/README.md. While the intent is good, the apps/api/README.md additions contain three critical factual errors:

Key issues:

• Phantom environment variables (lines 26–28): INNGEST_EVENTS_RECEIVED_AFTER and INNGEST_JOBS_MAX_EVENTS do not exist in the codebase. The documented default of 100 for INNGEST_JOBS_MAX_EVENTS is incorrect; the actual hardcoded constant is 500.
• Docker variables documented for the wrong service (lines 35–45): DOCKER_API_VERSION, DOCKER_HOST, and DOCKER_PORT are consumed by packages/server/src/constants/index.ts, not apps/api. Documenting them here misleads users.
• Search endpoints misattributed (lines 80–83): application.search, compose.search, environment.search, project.search, and database service search endpoints are tRPC procedures from the main Dokploy app (apps/dokploy/server/api/routers), not REST endpoints exposed by apps/api. The API server only exposes: POST /deploy, POST /cancel-deployment, GET /health, GET /jobs, and GET|POST|PUT /api/inngest.
• Missing trailing newline (line 254): File formatting issue that linters typically flag.

The CONTRIBUTING.md changes are accurate, but the API README issues must be resolved before merging.

Confidence Score: 1/5

• Not safe to merge — multiple sections of the API README document non-existent environment variables, misattribute functionality to the wrong server, and will actively mislead developers.
• The apps/api/README.md contains three distinct factual errors: phantom environment variables with incorrect defaults, incorrect ownership of Docker configuration variables, and search endpoints documented under the wrong service. These inaccuracies in developer-facing documentation can cause real confusion and wasted debugging time. The CONTRIBUTING.md additions are fine, but the overall PR quality is low due to the README issues.
• apps/api/README.md requires significant revision before merging.

_{Last reviewed commit: 0c5d49c}

Greptile also left 4 inline comments on this PR.

_{(3/5) Reply to the agent's comments like "Can you suggest a fix for this @greptileai?" or ask follow-up questions!}

[greptile-apps]

Phantom environment variables with incorrect defaults

INNGEST_EVENTS_RECEIVED_AFTER and INNGEST_JOBS_MAX_EVENTS do not exist anywhere in the codebase. There are no reads from process.env.INNGEST_EVENTS_RECEIVED_AFTER or process.env.INNGEST_JOBS_MAX_EVENTS in apps/api/src/service.ts or any other file. Additionally, the documented default of 100 for INNGEST_JOBS_MAX_EVENTS is incorrect — the actual hardcoded constant in service.ts is DEFAULT_MAX_EVENTS = 500.

Documenting non-existent environment variables will confuse users who try to configure them and wonder why they have no effect. These entries should either be removed or, if they are intended to be added in a follow-up, the code should actually read from process.env.

[greptile-apps]

Docker configuration variables are not used by this API server

DOCKER_API_VERSION, DOCKER_HOST, and DOCKER_PORT are consumed by packages/server/src/constants/index.ts (the main Dokploy server package), not by the apps/api server. The apps/api source files (index.ts, service.ts, utils.ts, schema.ts) contain zero references to Docker or these environment variables.

Documenting them here implies they affect the behavior of apps/api, which is misleading. This section should either be removed from this README or moved to the documentation for the package that actually reads these variables.

[greptile-apps]

Search endpoints belong to the main Dokploy app, not this API server

application.search, compose.search, environment.search, project.search, and the database service search procedures are tRPC procedures defined in apps/dokploy/server/api/routers/*.ts. They are served by the main Next.js application, not by apps/api.

The apps/api HTTP server only exposes: POST /deploy, POST /cancel-deployment, GET /health, GET /jobs, and GET|POST|PUT /api/inngest. Adding a large "Search Endpoints" section here will mislead users into looking for these endpoints on the wrong server.

[greptile-apps]

Missing newline at end of file

The file does not end with a newline character. This is a minor formatting issue but is typically flagged by linters and can cause noisy diffs in future changes.

Suggested change

	- Returns total count for pagination UI
	- Returns total count for pagination UI
	+ 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!}