Skip to content

Commit cff18f8

Browse files
ac000avahahn
authored andcommitted
docs/openapi: Add new config options
Add entries for the new 'backlog' and 'listen_threads' config options introduced in commits 57c88fd ("router: Make the number of router threads configurable") and 76489fb ("conf, router: Make the listen(2) backlog configurable"). Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
1 parent 05b1c76 commit cff18f8

File tree

1 file changed

+152
-0
lines changed

1 file changed

+152
-0
lines changed

docs/unit-openapi.yaml

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2791,6 +2791,72 @@ paths:
27912791
"404":
27922792
$ref: "#/components/responses/responseNotFound"
27932793

2794+
/config/listeners/{listenerName}/backlog:
2795+
summary: "Endpoint for the `listeners/{listenerName}/backlog` option"
2796+
get:
2797+
operationId: getListenerBacklog
2798+
summary: "Retrieve the backlog option in a listener"
2799+
description: "Retrieves the `backlog` option that configures the
2800+
listen(2) backlog parameter where the `{listenerName}` listener object
2801+
[passes its requests](https://unit.nginx.org/configuration/#listeners)."
2802+
2803+
tags:
2804+
- listeners
2805+
- config
2806+
2807+
parameters:
2808+
- $ref: "#/components/parameters/listenerName"
2809+
2810+
responses:
2811+
"200":
2812+
description: "OK; the `backlog` option exists in the configuration."
2813+
content:
2814+
application/json:
2815+
schema:
2816+
type: integer
2817+
2818+
examples:
2819+
example1:
2820+
$ref: "#/components/examples/configListenerBacklog"
2821+
2822+
"404":
2823+
$ref: "#/components/responses/responseNotFound"
2824+
2825+
put:
2826+
operationId: updateListenerBacklog
2827+
summary: "Update the backlog option in a listener"
2828+
description: "Overwrites the `backlog` option."
2829+
tags:
2830+
- listeners
2831+
- config
2832+
2833+
parameters:
2834+
- $ref: "#/components/parameters/listenerName"
2835+
2836+
requestBody:
2837+
required: true
2838+
content:
2839+
application/json:
2840+
schema:
2841+
type: integer
2842+
2843+
examples:
2844+
example1:
2845+
$ref: "#/components/examples/configListenerBacklog"
2846+
2847+
responses:
2848+
"200":
2849+
$ref: "#/components/responses/responseOkUpdated"
2850+
2851+
"400":
2852+
$ref: "#/components/responses/responseBadRequest"
2853+
2854+
"404":
2855+
$ref: "#/components/responses/responseNotFound"
2856+
2857+
"500":
2858+
$ref: "#/components/responses/responseInternalError"
2859+
27942860
/config/routes:
27952861
summary: "Endpoint for the `routes` entity in the configuration"
27962862
get:
@@ -2943,6 +3009,87 @@ paths:
29433009
"404":
29443010
$ref: "#/components/responses/responseNotFound"
29453011

3012+
/config/settings/listen_threads:
3013+
summary: "Endpoint for the `listen_threads` option in `settings`"
3014+
get:
3015+
operationId: getSettingsListenThreads
3016+
summary: "Retrieve the listen_threads option from settings"
3017+
description: "Retrieves the `listen_threads` option that represents
3018+
Unit's [listen threads]
3019+
(https://unit.nginx.org/configuration/#settings)."
3020+
3021+
tags:
3022+
- settings
3023+
- config
3024+
3025+
responses:
3026+
"200":
3027+
description: "OK; the `listen_threads` option exists in the
3028+
configuration."
3029+
3030+
content:
3031+
application/json:
3032+
schema:
3033+
type: integer
3034+
3035+
examples:
3036+
ListenThreads:
3037+
value: 16
3038+
3039+
"404":
3040+
$ref: "#/components/responses/responseNotFound"
3041+
3042+
put:
3043+
operationId: updateSettingsListenThreads
3044+
summary: "Create or overwrite the listen_threads option"
3045+
description: "Creates or overwrites the `listen_threads` option in
3046+
the configuration."
3047+
3048+
tags:
3049+
- settings
3050+
- config
3051+
3052+
requestBody:
3053+
required: true
3054+
content:
3055+
application/json:
3056+
schema:
3057+
type: integer
3058+
3059+
examples:
3060+
ListenThreads:
3061+
value: 30
3062+
3063+
responses:
3064+
"200":
3065+
$ref: "#/components/responses/responseOkUpdated"
3066+
3067+
"400":
3068+
$ref: "#/components/responses/responseBadRequest"
3069+
3070+
"404":
3071+
$ref: "#/components/responses/responseNotFound"
3072+
3073+
"500":
3074+
$ref: "#/components/responses/responseInternalError"
3075+
3076+
delete:
3077+
operationId: deleteSettingsListenThreads
3078+
summary: "Delete the listen_threads option"
3079+
description: "Deletes the `listen_threads` option from the
3080+
configuration."
3081+
3082+
tags:
3083+
- settings
3084+
- config
3085+
3086+
responses:
3087+
"200":
3088+
$ref: "#/components/responses/responseOkDeleted"
3089+
3090+
"404":
3091+
$ref: "#/components/responses/responseNotFound"
3092+
29463093
/config/settings/http:
29473094
summary: "Endpoint for the `http` object in `settings`"
29483095

@@ -4961,6 +5108,11 @@ components:
49615108
summary: "App target destination in a listener"
49625109
value: "applications/php_app/index_target"
49635110

5111+
# /config/listeners/listenerName}/backlog
5112+
configListenerBacklog:
5113+
summary: "listen(2) backlog in a listener"
5114+
value: 1024
5115+
49645116
# /config/listeners/{listenerName}/tls
49655117
configListenerTls:
49665118
summary: "TLS object in a listener"

0 commit comments

Comments
 (0)