Skip to content

Commit

Permalink
autogen(docs): generate cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ory-bot committed Jan 18, 2024
1 parent 36ac893 commit 67f6059
Show file tree
Hide file tree
Showing 8 changed files with 166 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/cli/ory-create-event-stream.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
id: ory-create-event-stream
title: ory create event-stream
description: ory create event-stream Create a new event stream
---

<!--
This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->
## ory create event-stream

Create a new event stream

```
ory create event-stream [--project=PROJECT_ID] --type=sns --aws-iam-role-arn=arn:aws:iam::123456789012:role/MyRole --aws-sns-topic-arn=arn:aws:sns:us-east-1:123456789012:MyTopic [flags]
```

### Options

```
--aws-iam-role-arn string The ARN of the AWS IAM role to assume when publishing messages to the SNS topic.
--aws-sns-topic-arn string The ARN of the AWS SNS topic.
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for event-stream
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
--type string The type of the event stream destination. Only "sns" is supported at the moment.
```

### Options inherited from parent commands

```
-c, --config string Path to the Ory Network configuration file.
-y, --yes Confirm all dialogs with yes.
```

### SEE ALSO

* [ory create](ory-create) - Create Ory Network resources

1 change: 1 addition & 0 deletions docs/cli/ory-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Create Ory Network resources
### SEE ALSO

* [ory](ory) - The ORY CLI
* [ory create event-stream](ory-create-event-stream) - Create a new event stream
* [ory create jwk](ory-create-jwk) - Create a JSON Web Key Set with a JSON Web Key
* [ory create oauth2-client](ory-create-oauth2-client) - Create an OAuth 2.0 Client
* [ory create organization](ory-create-organization) - Create a new Ory Network organization
Expand Down
39 changes: 39 additions & 0 deletions docs/cli/ory-delete-event-stream.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
id: ory-delete-event-stream
title: ory delete event-stream
description: ory delete event-stream Delete the event stream with the given ID
---

<!--
This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->
## ory delete event-stream

Delete the event stream with the given ID

```
ory delete event-stream id [--project=PROJECT_ID] [flags]
```

### Options

```
-h, --help help for event-stream
--project string The project to use, either project ID or a (partial) slug.
```

### Options inherited from parent commands

```
-c, --config string Path to the Ory Network configuration file.
--format string Set the output format. One of default, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-q, --quiet Be quiet with output printing.
-y, --yes Confirm all dialogs with yes.
```

### SEE ALSO

* [ory delete](ory-delete) - Delete resources

1 change: 1 addition & 0 deletions docs/cli/ory-delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Delete resources

* [ory](ory) - The ORY CLI
* [ory delete access-tokens](ory-delete-access-tokens) - Delete all OAuth2 Access Tokens of an OAuth2 Client
* [ory delete event-stream](ory-delete-event-stream) - Delete the event stream with the given ID
* [ory delete identity](ory-delete-identity) - Delete one or more identities by their ID(s)
* [ory delete jwk](ory-delete-jwk) - Delete one or more JSON Web Key Sets by their set ID
* [ory delete oauth2-client](ory-delete-oauth2-client) - Delete one or more OAuth 2.0 Clients by their ID(s)
Expand Down
39 changes: 39 additions & 0 deletions docs/cli/ory-list-event-streams.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
id: ory-list-event-streams
title: ory list event-streams
description: ory list event-streams List your event streams
---

<!--
This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->
## ory list event-streams

List your event streams

```
ory list event-streams [flags]
```

### Options

```
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for event-streams
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
```

### Options inherited from parent commands

```
-c, --config string Path to the Ory Network configuration file.
-y, --yes Confirm all dialogs with yes.
```

### SEE ALSO

* [ory list](ory-list) - List resources

1 change: 1 addition & 0 deletions docs/cli/ory-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ List resources
### SEE ALSO

* [ory](ory) - The ORY CLI
* [ory list event-streams](ory-list-event-streams) - List your event streams
* [ory list identities](ory-list-identities) - List identities
* [ory list oauth2-clients](ory-list-oauth2-clients) - List OAuth 2.0 Clients
* [ory list organizations](ory-list-organizations) - List your Ory Network organizations
Expand Down
42 changes: 42 additions & 0 deletions docs/cli/ory-update-event-stream.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
id: ory-update-event-stream
title: ory update event-stream
description: ory update event-stream Update the event stream with the given ID
---

<!--
This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->
## ory update event-stream

Update the event stream with the given ID

```
ory update event-stream id [--project=PROJECT_ID] [--type=sns] [--aws-iam-role-arn=arn:aws:iam::123456789012:role/MyRole] [--aws-sns-topic-arn=arn:aws:sns:us-east-1:123456789012:MyTopic] [flags]
```

### Options

```
--aws-iam-role-arn string The ARN of the AWS IAM role to assume when publishing messages to the SNS topic.
--aws-sns-topic-arn string The ARN of the AWS SNS topic.
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for event-stream
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
--type string The type of the event stream destination. Only "sns" is supported at the moment.
```

### Options inherited from parent commands

```
-c, --config string Path to the Ory Network configuration file.
-y, --yes Confirm all dialogs with yes.
```

### SEE ALSO

* [ory update](ory-update) - Update resources

1 change: 1 addition & 0 deletions docs/cli/ory-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Update resources
### SEE ALSO

* [ory](ory) - The ORY CLI
* [ory update event-stream](ory-update-event-stream) - Update the event stream with the given ID
* [ory update identity-config](ory-update-identity-config) - Update the Ory Identities configuration of the specified Ory Network project.
* [ory update oauth2-client](ory-update-oauth2-client) - Update an OAuth 2.0 Client
* [ory update oauth2-config](ory-update-oauth2-config) - Update the Ory OAuth2 & OpenID Connect configuration of the specified Ory Network project.
Expand Down

0 comments on commit 67f6059

Please sign in to comment.