Skip to content

Commit 61d80da

Browse files
ory-botory-bot
committed
autogen(docs): generate cli docs
1 parent fb542ed commit 61d80da

7 files changed

Lines changed: 165 additions & 4 deletions

‎docs/cli/ory-create-event-stream.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ ory create event-stream [--project=PROJECT_ID] --type={sns,https} {--aws-iam-rol
2727
--https-endpoint string The URL of the HTTPS endpoint.
2828
--project string The project to use, either project ID or a (partial) slug.
2929
-q, --quiet Be quiet with output printing.
30+
--status string The status of the event stream, either "active" or "paused". When unset, a new stream defaults to "active" and an existing stream keeps its current status.
3031
--type string The type of the event stream destination. Supported values are "sns" for AWS SNS topics and "https" for generic HTTPS endpoints.
3132
--workspace string The workspace to use, either workspace ID or a (partial) name.
3233
```

‎docs/cli/ory-pause-event-stream.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
id: ory-pause-event-stream
3+
title: ory pause event-stream
4+
description: ory pause event-stream
5+
---
6+
7+
<!--
8+
This file is auto-generated.
9+
10+
To improve this file please make your change against the appropriate "./cmd/*.go" file.
11+
-->
12+
## ory pause event-stream
13+
14+
Pause the event stream with the given ID
15+
16+
### Synopsis
17+
18+
Pause the event stream with the given ID
19+
20+
A paused event stream does not forward any events until it is resumed.
21+
22+
```
23+
ory pause event-stream <id> [--project=PROJECT_ID] [flags]
24+
```
25+
26+
### Options
27+
28+
```
29+
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "table")
30+
-h, --help help for event-stream
31+
--project string The project to use, either project ID or a (partial) slug.
32+
-q, --quiet Be quiet with output printing.
33+
--workspace string The workspace to use, either workspace ID or a (partial) name.
34+
```
35+
36+
### Options inherited from parent commands
37+
38+
```
39+
-c, --config string Path to the Ory Network configuration file.
40+
-y, --yes Confirm all dialogs with yes.
41+
```
42+
43+
### See also
44+
45+
* [ory pause](ory-pause) Pause Ory Network resources
46+

‎docs/cli/ory-pause.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
id: ory-pause
3+
title: ory pause
4+
description: ory pause
5+
---
6+
7+
<!--
8+
This file is auto-generated.
9+
10+
To improve this file please make your change against the appropriate "./cmd/*.go" file.
11+
-->
12+
## ory pause
13+
14+
Pause Ory Network resources
15+
16+
### Options
17+
18+
```
19+
-c, --config string Path to the Ory Network configuration file.
20+
--format string Set the output format. One of default, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
21+
-h, --help help for pause
22+
-q, --quiet Be quiet with output printing.
23+
-y, --yes Confirm all dialogs with yes.
24+
```
25+
26+
### See also
27+
28+
* [ory](ory) The Ory CLI
29+
* [ory pause event-stream](ory-pause-event-stream) - Pause the event stream with the given ID
30+

‎docs/cli/ory-resume-event-stream.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
id: ory-resume-event-stream
3+
title: ory resume event-stream
4+
description: ory resume event-stream
5+
---
6+
7+
<!--
8+
This file is auto-generated.
9+
10+
To improve this file please make your change against the appropriate "./cmd/*.go" file.
11+
-->
12+
## ory resume event-stream
13+
14+
Resume the event stream with the given ID
15+
16+
### Synopsis
17+
18+
Resume the event stream with the given ID
19+
20+
Resuming a paused event stream makes it forward events again.
21+
22+
```
23+
ory resume event-stream <id> [--project=PROJECT_ID] [flags]
24+
```
25+
26+
### Options
27+
28+
```
29+
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "table")
30+
-h, --help help for event-stream
31+
--project string The project to use, either project ID or a (partial) slug.
32+
-q, --quiet Be quiet with output printing.
33+
--workspace string The workspace to use, either workspace ID or a (partial) name.
34+
```
35+
36+
### Options inherited from parent commands
37+
38+
```
39+
-c, --config string Path to the Ory Network configuration file.
40+
-y, --yes Confirm all dialogs with yes.
41+
```
42+
43+
### See also
44+
45+
* [ory resume](ory-resume) Resume Ory Network resources
46+

‎docs/cli/ory-resume.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
id: ory-resume
3+
title: ory resume
4+
description: ory resume
5+
---
6+
7+
<!--
8+
This file is auto-generated.
9+
10+
To improve this file please make your change against the appropriate "./cmd/*.go" file.
11+
-->
12+
## ory resume
13+
14+
Resume Ory Network resources
15+
16+
### Options
17+
18+
```
19+
-c, --config string Path to the Ory Network configuration file.
20+
--format string Set the output format. One of default, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
21+
-h, --help help for resume
22+
-q, --quiet Be quiet with output printing.
23+
-y, --yes Confirm all dialogs with yes.
24+
```
25+
26+
### See also
27+
28+
* [ory](ory) The Ory CLI
29+
* [ory resume event-stream](ory-resume-event-stream) - Resume the event stream with the given ID
30+

‎docs/cli/ory-update-event-stream.md‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,16 @@ ory update event-stream id [--project=PROJECT_ID] --type={sns,https} {--aws-iam-
2020
### Options
2121

2222
```
23-
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "table")
24-
-h, --help help for event-stream
25-
--project string The project to use, either project ID or a (partial) slug.
26-
-q, --quiet Be quiet with output printing.
23+
--aws-iam-role-arn string The ARN of the AWS IAM role to assume when publishing messages to the SNS topic.
24+
--aws-sns-topic-arn string The ARN of the AWS SNS topic.
25+
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "table")
26+
-h, --help help for event-stream
27+
--https-endpoint string The URL of the HTTPS endpoint.
28+
--project string The project to use, either project ID or a (partial) slug.
29+
-q, --quiet Be quiet with output printing.
30+
--status string The status of the event stream, either "active" or "paused". When unset, a new stream defaults to "active" and an existing stream keeps its current status.
31+
--type string The type of the event stream destination. Supported values are "sns" for AWS SNS topics and "https" for generic HTTPS endpoints.
32+
--workspace string The workspace to use, either workspace ID or a (partial) name.
2733
```
2834

2935
### Options inherited from parent commands

‎docs/cli/ory.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,10 @@ The Ory CLI
3434
* [ory open](ory-open) - Open Ory Account Experience Pages
3535
* [ory parse](ory-parse) - Parse Ory Network resources
3636
* [ory patch](ory-patch) - Patch resources
37+
* [ory pause](ory-pause) - Pause Ory Network resources
3738
* [ory perform](ory-perform) - Perform a flow
3839
* [ory proxy](ory-proxy) - Run your app and Ory on the same domain using a reverse proxy
40+
* [ory resume](ory-resume) - Resume Ory Network resources
3941
* [ory revoke](ory-revoke) - Revoke resources
4042
* [ory tunnel](ory-tunnel) - Mirror Ory APIs on your local machine for local development and testing
4143
* [ory update](ory-update) - Update resources

0 commit comments

Comments
 (0)