Skip to content

Commit a1db20d

Browse files
authored
Improve process stats instance_ports API doc (#4405)
A non-existing port can be represented as `0` or as `null`. Clients should understand both values. See also #4403 for more details on inconstant representation of non-existing ports.
1 parent f05e01c commit a1db20d

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/v3/source/includes/resources/processes/_stats_object.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Name | Type | Description
2424
**usage.log_rate** | _integer_ | The current logging usage of the instance
2525
**host** | _string_ | The host the instance is running on
2626
**instance_internal_ip** | _string_ | The internal IP address of the instance
27-
**instance_ports** | _object_ | JSON array of port mappings between the network-exposed port used to communicate with the app (`external`) and port opened to the running process that it can listen on (`internal`)
27+
**instance_ports** | _object_ | JSON array of port mappings between the network-exposed port used to communicate with the app (`external`) and port opened to the running process that it can listen on (`internal`). Clients shall interprete `0` and `null` as non-existing port.
2828
**uptime** | _integer_ | The uptime in seconds for the instance
2929
**mem_quota** | _integer_ | The current maximum memory allocated for the instance; the value is `null` when memory quota data is unavailable
3030
**disk_quota** | _integer_ | The current maximum disk allocated for the instance; the value is `null` when disk quota data is unavailable

0 commit comments

Comments
 (0)