Skip to content

Commit 3717fc7

Browse files
neurosnapneurosnap
committed
docs(pipe): formatting and block query param
1 parent 87eb6e4 commit 3717fc7

File tree

1 file changed

+69
-67
lines changed

1 file changed

+69
-67
lines changed

‎posts/pipe.md‎

Lines changed: 69 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -234,30 +234,30 @@ below. This example terminal also accepts query params like the following:
234234
235235
### Parameters
236236
237-
> | name | type | data type | description |
238-
> | ----- | -------- | --------- | -------------------------- |
239-
> | topic | required | string | topic name to subscribe to |
237+
| name | type | data type | description |
238+
| ----- | -------- | --------- | -------------------------- |
239+
| topic | required | string | topic name to subscribe to |
240240
241241
### Query Parameters
242242
243-
> | name | type | data type | description |
244-
> | ------ | -------- | --------- | --------------------------------------------- |
245-
> | status | optional | boolean | Receive pipe status messages |
246-
> | replay | optional | boolean | Whether or not to replay message |
247-
> | binary | optional | string | Connect the client as binary |
248-
> | access | optional | string | Comma separated list of permissible accessors |
243+
| name | type | data type | description |
244+
| ------ | -------- | --------- | --------------------------------------------- |
245+
| status | optional | boolean | Receive pipe status messages |
246+
| replay | optional | boolean | Whether or not to replay message |
247+
| binary | optional | string | Connect the client as binary |
248+
| access | optional | string | Comma separated list of permissible accessors |
249249
250250
### Responses
251251
252-
> | http code | content-type | response |
253-
> | --------- | ------------ | ------------------- |
254-
> | `101` | `N/A` | Switching Protocols |
252+
| http code | content-type | response |
253+
| --------- | ------------ | ------------------- |
254+
| `101` | `N/A` | Switching Protocols |
255255
256256
### Example websocat
257257
258-
> ```bash
259-
> websocat wss://pipe.pico.sh/socket/test
260-
> ```
258+
```bash
259+
websocat wss://pipe.pico.sh/socket/test
260+
```
261261
262262
</details>
263263
@@ -268,29 +268,30 @@ below. This example terminal also accepts query params like the following:
268268
269269
### Parameters
270270
271-
> | name | type | data type | description |
272-
> | ----- | -------- | --------- | -------------------------- |
273-
> | topic | required | string | topic name to subscribe to |
271+
| name | type | data type | description |
272+
| ----- | -------- | --------- | -------------------------- |
273+
| topic | required | string | topic name to subscribe to |
274274
275275
### Query Parameters
276276
277-
> | name | type | data type | description |
278-
> | ------- | -------- | --------- | --------------------------------------------------- |
279-
> | persist | optional | boolean | Persist the subscription after the publisher closes |
280-
> | access | optional | string | Comma separated list of permissible accessors |
281-
> | mime | optional | string | Content type to return to the client |
277+
| name | type | data type | description |
278+
| ------- | -------- | --------- | ----------------------------------------------------------- |
279+
| persist | optional | boolean | Persist the subscription after the publisher closes |
280+
| block | optional | boolean | Block writes until a subscriber is available (default true) |
281+
| access | optional | string | Comma separated list of permissible accessors |
282+
| mime | optional | string | Content type to return to the client |
282283
283284
### Responses
284285
285-
> | http code | content-type | response |
286-
> | --------- | ---------------------------------------------------- | ----------------------------------------------- |
287-
> | `200` | `text/plain;charset=UTF-8` or `mime` query parameter | Subscription data. Will hang until a pub occurs |
286+
| http code | content-type | response |
287+
| --------- | ---------------------------------------------------- | ----------------------------------------------- |
288+
| `200` | `text/plain;charset=UTF-8` or `mime` query parameter | Subscription data. Will hang until a pub occurs |
288289
289290
### Example cURL
290291
291-
> ```bash
292-
> curl -vvv https://pipe.pico.sh/topic/test?persist=true
293-
> ```
292+
```bash
293+
curl -vvv https://pipe.pico.sh/topic/test?persist=true
294+
```
294295
295296
</details>
296297
@@ -301,27 +302,27 @@ below. This example terminal also accepts query params like the following:
301302
302303
### Parameters
303304
304-
> | name | type | data type | description |
305-
> | ----- | -------- | --------- | -------------------------- |
306-
> | topic | required | string | topic name to subscribe to |
305+
| name | type | data type | description |
306+
| ----- | -------- | --------- | -------------------------- |
307+
| topic | required | string | topic name to subscribe to |
307308
308309
### Query Parameters
309310
310-
> | name | type | data type | description |
311-
> | ------ | -------- | --------- | --------------------------------------------- |
312-
> | access | optional | string | Comma separated list of permissible accessors |
311+
| name | type | data type | description |
312+
| ------ | -------- | --------- | --------------------------------------------- |
313+
| access | optional | string | Comma separated list of permissible accessors |
313314
314315
### Responses
315316
316-
> | http code | content-type | response |
317-
> | --------- | ------------ | ------------------- |
318-
> | `200` | | No content returned |
317+
| http code | content-type | response |
318+
| --------- | ------------ | ------------------- |
319+
| `200` | | No content returned |
319320
320321
### Example cURL
321322
322-
> ```bash
323-
> curl -vvvv https://pipe.pico.sh/topic/test -d "hello"
324-
> ```
323+
```bash
324+
curl -vvvv https://pipe.pico.sh/topic/test -d "hello"
325+
```
325326
326327
</details>
327328
@@ -332,29 +333,30 @@ below. This example terminal also accepts query params like the following:
332333
333334
### Parameters
334335
335-
> | name | type | data type | description |
336-
> | ----- | -------- | --------- | -------------------------- |
337-
> | topic | required | string | topic name to subscribe to |
336+
| name | type | data type | description |
337+
| ----- | -------- | --------- | -------------------------- |
338+
| topic | required | string | topic name to subscribe to |
338339
339340
### Query Parameters
340341
341-
> | name | type | data type | description |
342-
> | ------- | -------- | --------- | --------------------------------------------------- |
343-
> | persist | optional | boolean | Persist the subscription after the publisher closes |
344-
> | access | optional | string | Comma separated list of permissible accessors |
345-
> | mime | optional | string | Content type to return to the client |
342+
| name | type | data type | description |
343+
| ------- | -------- | --------- | ----------------------------------------------------------- |
344+
| persist | optional | boolean | Persist the subscription after the publisher closes |
345+
| block | optional | boolean | Block writes until a subscriber is available (default true) |
346+
| access | optional | string | Comma separated list of permissible accessors |
347+
| mime | optional | string | Content type to return to the client |
346348
347349
### Responses
348350
349-
> | http code | content-type | response |
350-
> | --------- | ---------------------------------------------------- | ----------------------------------------------- |
351-
> | `200` | `text/plain;charset=UTF-8` or `mime` query parameter | Subscription data. Will hang until a pub occurs |
351+
| http code | content-type | response |
352+
| --------- | ---------------------------------------------------- | ----------------------------------------------- |
353+
| `200` | `text/plain;charset=UTF-8` or `mime` query parameter | Subscription data. Will hang until a pub occurs |
352354
353355
### Example cURL
354356
355-
> ```bash
356-
> curl -vvv https://pipe.pico.sh/pubsub/test?persist=true
357-
> ```
357+
```bash
358+
curl -vvv https://pipe.pico.sh/pubsub/test?persist=true
359+
```
358360
359361
</details>
360362
@@ -365,27 +367,27 @@ below. This example terminal also accepts query params like the following:
365367
366368
### Parameters
367369
368-
> | name | type | data type | description |
369-
> | ----- | -------- | --------- | -------------------------- |
370-
> | topic | required | string | topic name to subscribe to |
370+
| name | type | data type | description |
371+
| ----- | -------- | --------- | -------------------------- |
372+
| topic | required | string | topic name to subscribe to |
371373
372374
### Query Parameters
373375
374-
> | name | type | data type | description |
375-
> | ------ | -------- | --------- | --------------------------------------------- |
376-
> | access | optional | string | Comma separated list of permissible accessors |
376+
| name | type | data type | description |
377+
| ------ | -------- | --------- | --------------------------------------------- |
378+
| access | optional | string | Comma separated list of permissible accessors |
377379
378380
### Responses
379381
380-
> | http code | content-type | response |
381-
> | --------- | ------------ | ------------------- |
382-
> | `200` | | No content returned |
382+
| http code | content-type | response |
383+
| --------- | ------------ | ------------------- |
384+
| `200` | | No content returned |
383385
384386
### Example cURL
385387
386-
> ```bash
387-
> curl -vvvv https://pipe.pico.sh/pubsub/test -d "hello"
388-
> ```
388+
```bash
389+
curl -vvvv https://pipe.pico.sh/pubsub/test -d "hello"
390+
```
389391
390392
</details>
391393

0 commit comments

Comments
 (0)