Skip to content

Commit 93be037

Browse files
authored
Fix curl command name, syntax, and url (#2377)
* Fix curl command name * Fix curl url * Fix command syntax [deploy site]
1 parent ff4dc5e commit 93be037

File tree

12 files changed

+109
-109
lines changed

12 files changed

+109
-109
lines changed

website_and_docs/content/documentation/grid/advanced_features/endpoints.en.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Grid status provides the current state of the Grid. It consists of details about
1616
For every Node, the status includes information regarding Node availability, sessions, and slots.
1717

1818
```shell
19-
cURL GET 'http://localhost:4444/status'
19+
curl --request GET 'http://localhost:4444/status'
2020
```
2121

2222
### Delete session
@@ -25,7 +25,7 @@ Deleting the session terminates the WebDriver session, quits the driver and remo
2525
Any request using the removed session-id or reusing the driver instance will throw an error.
2626

2727
```shell
28-
cURL --request DELETE 'http://localhost:4444/session/<session-id>'
28+
curl --request DELETE 'http://localhost:4444/session/<session-id>'
2929
```
3030

3131
### Which URL should I use?
@@ -42,7 +42,7 @@ Default URL for all the above modes is http://localhost:4444.
4242

4343
### Remove Node
4444

45-
To remove the Node from the Grid, use the cURL command enlisted below.
45+
To remove the Node from the Grid, use the curl command enlisted below.
4646
It does not stop any ongoing session running on that Node.
4747
The Node continues running as it is unless explicitly killed.
4848
The Distributor is no longer aware of the Node and hence any matching new session request
@@ -52,15 +52,15 @@ In the Standalone mode, the Distributor URL is the Standalone server address.
5252

5353
In the Hub-Node mode, the Distributor URL is the Hub server address.
5454
```shell
55-
cURL --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret> '
55+
curl --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret> '
5656
```
5757
In the fully distributed mode, the URL is the Router server address.
5858
```shell
59-
cURL --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret>'
59+
curl --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret>'
6060
```
6161
If no registration secret has been configured while setting up the Grid, then use
6262
```shell
63-
cURL --request DELETE 'http://<Router-URL>/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET;'
63+
curl --request DELETE 'http://<Router-URL>/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET;'
6464
```
6565

6666
### Drain Node
@@ -73,15 +73,15 @@ In the Standalone mode, the Distributor URL is the Standalone server address.
7373

7474
In the Hub-Node mode, the Distributor URL is the Hub server address.
7575
```shell
76-
cURL --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret> '
76+
curl --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret> '
7777
```
7878
In the fully distributed mode, the URL is the Router server address.
7979
```shell
80-
cURL --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret>'
80+
curl --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret>'
8181
```
8282
If no registration secret has been configured while setting up the Grid, then use
8383
```shell
84-
cURL --request POST 'http://<Router-URL>/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET;'
84+
curl --request POST 'http://<Router-URL>/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET;'
8585
```
8686

8787
## Node
@@ -94,37 +94,37 @@ In case of multiple Nodes, use [Grid status](#grid-status) to get all Node detai
9494
### Status
9595

9696
The Node status is essentially a health-check for the Node.
97-
Distributor pings the node status are regular intervals and updates the Grid Model accordingly.
97+
Distributor pings the node status at regular intervals and updates the Grid Model accordingly.
9898
The status includes information regarding availability, sessions, and slots.
9999

100100
```shell
101-
cURL --request GET 'http://localhost:5555/status'
101+
curl --request GET 'http://localhost:5555/status'
102102
```
103103

104104
### Drain
105105

106106
Distributor passes the [drain](#drain-node) command to the appropriate node identified by the node-id.
107-
To drain the Node directly, use the cuRL command enlisted below.
107+
To drain the Node directly, use the curl command enlisted below.
108108
Both endpoints are valid and produce the same result. Drain finishes the ongoing sessions before stopping the Node.
109109

110110
```shell
111-
cURL --request POST 'http://localhost:5555/se/grid/node/drain' --header 'X-REGISTRATION-SECRET: <secret>'
111+
curl --request POST 'http://localhost:5555/se/grid/node/drain' --header 'X-REGISTRATION-SECRET: <secret>'
112112
```
113113
If no registration secret has been configured while setting up the Grid, then use
114114
```shell
115-
cURL --request POST 'http://<node-URL>/se/grid/node/drain' --header 'X-REGISTRATION-SECRET;'
115+
curl --request POST 'http://<node-URL>/se/grid/node/drain' --header 'X-REGISTRATION-SECRET;'
116116
```
117117

118118
### Check session owner
119119

120-
To check if a session belongs to a Node, use the cURL command enlisted below.
120+
To check if a session belongs to a Node, use the curl command enlisted below.
121121

122122
```shell
123-
cURL --request GET 'http://localhost:5555/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
123+
curl --request GET 'http://localhost:5555/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
124124
```
125125
If no registration secret has been configured while setting up the Grid, then use
126126
```shell
127-
cURL --request GET 'http://<node-URL>/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET;'
127+
curl --request GET 'http://<node-URL>/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET;'
128128
```
129129

130130
It will return true if the session belongs to the Node else it will return false.
@@ -135,19 +135,19 @@ Deleting the session terminates the WebDriver session, quits the driver and remo
135135
Any request using the removed session-id or reusing the driver instance will throw an error.
136136

137137
```shell
138-
cURL --request DELETE 'http://localhost:5555/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
138+
curl --request DELETE 'http://localhost:5555/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
139139
```
140140
If no registration secret has been configured while setting up the Grid, then use
141141
```shell
142-
cURL --request DELETE 'http://<node-URL>/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET;'
142+
curl --request DELETE 'http://<node-URL>/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET;'
143143
```
144144

145145
## New Session Queue
146146

147147
### Clear New Session Queue
148148

149149
New Session Request Queue holds the new session requests.
150-
To clear the queue, use the cURL command enlisted below.
150+
To clear the queue, use the curl command enlisted below.
151151
Clearing the queue rejects all the requests in the queue. For each such request, the server returns an error response to the respective client.
152152
The result of the clear command is the total number of deleted requests.
153153

@@ -156,33 +156,33 @@ In the Standalone mode, the Queue URL is the Standalone server address.
156156
In the Hub-Node mode, the Queue URL is the Hub server address.
157157

158158
```shell
159-
cURL --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
159+
curl --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
160160
```
161161

162162
In the fully distributed mode, the Queue URL is Router server address.
163163
```shell
164-
cURL --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
164+
curl --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
165165
```
166166

167167
If no registration secret has been configured while setting up the Grid, then use
168168
```shell
169-
cURL --request DELETE 'http://<Router-URL>/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET;'
169+
curl --request DELETE 'http://<Router-URL>/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET;'
170170
```
171171

172172
### Get New Session Queue Requests
173173

174174
New Session Request Queue holds the new session requests.
175-
To get the current requests in the queue, use the cURL command enlisted below.
175+
To get the current requests in the queue, use the curl command enlisted below.
176176
The response returns the total number of requests in the queue and the request payloads.
177177

178178
In the Standalone mode, the Queue URL is the Standalone server address.
179179

180180
In the Hub-Node mode, the Queue URL is the Hub server address.
181181

182182
```shell
183-
cURL --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
183+
curl --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
184184
```
185185

186186
In the fully distributed mode, the Queue URL is Router server address.
187187
```shell
188-
cURL --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
188+
curl --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'

website_and_docs/content/documentation/grid/advanced_features/endpoints.ja.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Grid ステータスは Grid の現在の状態を提供します。 登録さ
1616
各ノードのステータスには、ノードの稼働状況、セッション、およびスロットに関する情報が含まれます。
1717

1818
```shell
19-
cURL GET 'http://localhost:4444/status'
19+
curl --request GET 'http://localhost:4444/status'
2020
```
2121

2222
### セッションの削除
@@ -25,7 +25,7 @@ cURL GET 'http://localhost:4444/status'
2525
削除されたセッション ID を使用するリクエストや、ドライバのインスタンスを再利用しようとすると、エラーとなります。
2626

2727
```shell
28-
cURL --request DELETE 'http://localhost:4444/session/<session-id>'
28+
curl --request DELETE 'http://localhost:4444/session/<session-id>'
2929
```
3030

3131
### Which URL should I use?
@@ -42,7 +42,7 @@ cURL --request DELETE 'http://localhost:4444/session/<session-id>'
4242

4343
### ノード削除
4444

45-
ノードを Grid から削除するには、以下の cURL コマンドを使用します。
45+
ノードを Grid から削除するには、以下の curl コマンドを使用します。
4646
このコマンドは、そのノード上で実行中のセッションを停止させるものではありません。
4747
ノードは明示的に強制終了されない限り、そのまま動作し続けます。
4848
ディストリビューターはそのノードを認識しなくなるため、マッチする新しいセッションのリクエストは はその Node に転送されません。
@@ -52,19 +52,19 @@ cURL --request DELETE 'http://localhost:4444/session/<session-id>'
5252
ハブ&ノードモードでは、ディストリビューターの URL は ハブのアドレスになります。
5353

5454
```shell
55-
cURL --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret> '
55+
curl --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret> '
5656
```
5757

5858
完全分散モードでは、ディストリビューター URL は ディストリビューターのアドレスになります。
5959

6060
```shell
61-
cURL --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret>'
61+
curl --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret>'
6262
```
6363

6464
Grid の設定時に登録用の secret を設定していない場合は次のようにします:
6565

6666
```shell
67-
cURL --request DELETE 'http://<Router-URL>/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET;'
67+
curl --request DELETE 'http://<Router-URL>/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET;'
6868
```
6969

7070
### ノードのドレイン
@@ -78,19 +78,19 @@ cURL --request DELETE 'http://<Router-URL>/se/grid/distributor/node/<node-id>' -
7878
ハブ&ノードモードでは、ディストリビューターの URL は ハブのアドレスになります。
7979

8080
```shell
81-
cURL --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret> '
81+
curl --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret> '
8282
```
8383

8484
完全分散モードでは、ディストリビューター URL は ディストリビューターのアドレスになります。
8585

8686
```shell
87-
cURL --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret>'
87+
curl --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret>'
8888
```
8989

9090
Grid の設定時に登録用の secret を設定していない場合は次のようにします:
9191

9292
```shell
93-
cURL --request POST 'http://<Router-URL>/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET;'
93+
curl --request POST 'http://<Router-URL>/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET;'
9494
```
9595

9696
## ノード
@@ -106,38 +106,38 @@ cURL --request POST 'http://<Router-URL>/se/grid/distributor/node/<node-id>/drai
106106
ステータスには稼働状況、セッション、およびスロットに関する情報が含まれます。
107107

108108
```shell
109-
cURL --request GET 'http://localhost:5555/status'
109+
curl --request GET 'http://localhost:5555/status'
110110
```
111111

112112
### ドレイン
113113

114114
ディストリビューターは [ドレイン](#ノードのドレイン)コマンドを適切なノードに渡します。
115-
ノードを直接ドレインするには以下の cURL コマンドを使います。
115+
ノードを直接ドレインするには以下の curl コマンドを使います。
116116
どちらのエンドポイントも有効であり、同じ結果になります。
117117
ドレインは、ノードを停止する前に進行中のセッションを終了させます。
118118

119119
```shell
120-
cURL --request POST 'http://localhost:5555/se/grid/node/drain' --header 'X-REGISTRATION-SECRET: <secret>'
120+
curl --request POST 'http://localhost:5555/se/grid/node/drain' --header 'X-REGISTRATION-SECRET: <secret>'
121121
```
122122

123123
Grid の設定時に登録用の secret を設定していない場合は次のようにします:
124124

125125
```shell
126-
cURL --request POST 'http://<node-URL>/se/grid/node/drain' --header 'X-REGISTRATION-SECRET;'
126+
curl --request POST 'http://<node-URL>/se/grid/node/drain' --header 'X-REGISTRATION-SECRET;'
127127
```
128128

129129
### セッションオーナーのチェック
130130

131-
あるセッションがノードに属しているかどうかをチェックするには、以下の cURL コマンドを使います。
131+
あるセッションがノードに属しているかどうかをチェックするには、以下の curl コマンドを使います。
132132

133133
```shell
134-
cURL --request GET 'http://localhost:5555/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
134+
curl --request GET 'http://localhost:5555/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
135135
```
136136

137137
Grid の設定時に登録用の secret を設定していない場合は次のようにします:
138138

139139
```shell
140-
cURL --request GET 'http://<node-URL>/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET;'
140+
curl --request GET 'http://<node-URL>/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET;'
141141
```
142142

143143
もしセッションがノードに属していたら true を返し、そうでなければ false が返ります。
@@ -148,21 +148,21 @@ cURL --request GET 'http://<node-URL>/se/grid/node/owner/<session-id>' --header
148148
削除されたセッション ID を使用するリクエストや、ドライバのインスタンスを再利用しようとすると、エラーとなります。
149149

150150
```shell
151-
cURL --request DELETE 'http://localhost:5555/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
151+
curl --request DELETE 'http://localhost:5555/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
152152
```
153153

154154
Grid の設定時に登録用の secret を設定していない場合は次のようにします:
155155

156156
```shell
157-
cURL --request DELETE 'http://<node-URL>/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET;'
157+
curl --request DELETE 'http://<node-URL>/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET;'
158158
```
159159

160160
## 新規セッションキュー
161161

162162
### 新規セッションキューのクリア
163163

164164
新規セッションキューには、新規セッションリクエストが格納されます。
165-
キューをクリアするには、以下に挙げる cURL コマンドを使用します。
165+
キューをクリアするには、以下に挙げる curl コマンドを使用します。
166166
キューを消去すると、キューにあるすべてのリクエストを拒否します。
167167
サーバーは各リクエストのそれぞれのクライアントにエラーレスポンスを返します。
168168
クリアコマンドの結果は、削除されたリクエストの数です。
@@ -172,37 +172,37 @@ cURL --request DELETE 'http://<node-URL>/se/grid/node/session/<session-id>' --he
172172
ハブ&ノードモードでは、キューの URL は ハブのアドレスになります。
173173

174174
```shell
175-
cURL --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
175+
curl --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
176176
```
177177

178178
完全分散モードでは、キューの URL は 新規セッションキューのアドレスになります。
179179

180180
```shell
181-
cURL --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
181+
curl --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
182182
```
183183

184184
Grid の設定時に登録用の secret を設定していない場合は次のようにします:
185185

186186
```shell
187-
cURL --request DELETE 'http://<Router-URL>/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET;'
187+
curl --request DELETE 'http://<Router-URL>/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET;'
188188
```
189189

190190
### 新規セッションリクエストの取得
191191

192192
新規セッションキューには、新規セッションリクエストが格納されます。
193-
キューにある現在のリクエストを取得するには、以下に挙げる cURL コマンドを使用します。
193+
キューにある現在のリクエストを取得するには、以下に挙げる curl コマンドを使用します。
194194
レスポンスはキュー内のリクエストの数とリクエストのペイロードを返します。
195195

196196
スタンドアロンモードでは、キューの URL はスタンドアロンサーバーのアドレスとなります。
197197

198198
ハブ&ノードモードでは、キューの URL は ハブのアドレスになります。
199199

200200
```shell
201-
cURL --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
201+
curl --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
202202
```
203203

204204
完全分散モードでは、キューの URL は 新規セッションキューのアドレスになります。
205205

206206
```shell
207-
cURL --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
207+
curl --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
208208
```

0 commit comments

Comments
 (0)