Skip to content

Conversation

@yosebyte
Copy link
Owner

@yosebyte yosebyte commented Oct 6, 2025

This pull request makes substantial changes to both the English (docs/en/api.md, docs/en/configuration.md) and Chinese (docs/zh/api.md, docs/zh/configuration.md) documentation for the NodePass API and configuration. The most important changes are the complete removal of tag management functionality and documentation from the API, and a significant update to the description and usage of the read parameter to clarify its dual role in both data read timeout and connection reuse. Additionally, several default values and configuration details have been updated for accuracy.

API Documentation Changes

Tag Management Removal

  • All references to instance tags, including tag fields in examples, tag management endpoints, request bodies, and tag management rules, have been removed from both the English and Chinese API documentation. This includes the removal of sample code for updating/deleting tags and explanations of tag logic. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16]

PATCH Endpoint Simplification

  • The PATCH /instances/{id} endpoint documentation now only allows updating state, alias, and restart policy, removing support for tag operations. Example requests have been updated accordingly. [1] [2]

Auto-Start Policy Logic Update

  • The logic for determining whether to enable auto-start for an instance now uses the critical boolean field, instead of checking for a critical tag in the tags array. [1] [2]

Configuration Documentation Changes

read Parameter Redefinition and Expansion

  • The documentation for the read parameter has been rewritten to clarify that it now controls both data read timeout and connection pool reuse. The default is now 0 (no timeout, no connection recycling), and positive values enable both timeout and connection reuse. Several examples and use cases have been added to illustrate this behavior. [1] [2]

Configuration Table Updates

  • The configuration tables in both English and Chinese documentation have been updated to reflect the new meaning and default value for the read parameter.

Environment Variable Defaults

  • The default value for NP_TCP_DATA_BUF_SIZE has been changed from 32768 to 16384, and for NP_POOL_GET_TIMEOUT from 30s to 5s, to better reflect current recommended settings.

These changes remove all tag management features from the documentation, clarify the behavior of the read parameter for connection reuse, and update configuration defaults to match current best practices.

@yosebyte yosebyte merged commit 1d9a4ed into yosebyte:main Oct 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant