Skip to content

Commit

Permalink
Autogenerate reference docs (#1105)
Browse files Browse the repository at this point in the history
Signed-off-by: rad-ci-bot <[email protected]>
Co-authored-by: rad-ci-bot <[email protected]>
Co-authored-by: Reshma Abdul Rahim <[email protected]>
  • Loading branch information
3 people authored Apr 18, 2024
1 parent e7b6a64 commit a8df58d
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_resource_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ rad resource delete [resourceType] [resourceName] [flags]

```
sample list of resourceType: containers, gateways, httpRoutes, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores
sample list of resourceType: containers, gateways, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores
# Delete a container named orders
rad resource delete containers orders
Expand Down
3 changes: 1 addition & 2 deletions docs/content/reference/cli/rad_resource_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,12 @@ rad resource list [resourceType] [flags]

```
sample list of resourceType: containers, gateways, httpRoutes, pubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, stateStores, secretStores
sample list of resourceType: containers, gateways, pubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, stateStores, secretStores
# list all resources of a specified type in the default environment
rad resource list containers
rad resource list gateways
rad resource list httpRoutes
# list all resources of a specified type in an application
rad resource list containers --application icecream-store
Expand Down
3 changes: 1 addition & 2 deletions docs/content/reference/cli/rad_resource_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,12 @@ rad resource show [resourceType] [resourceName] [flags]

```
sample list of resourceType: containers, gateways, httpRoutes, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores
sample list of resourceType: containers, gateways, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores
# show details of a specified resource in the default environment
rad resource show containers orders
rad resource show gateways orders_gateways
rad resource show httpRoutes orders_routes
# show details of a specified resource in an application
rad resource show containers orders --application icecream-store
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,6 @@ description: "Detailed reference documentation for applications.core/containers@
| **containerPort** | int | The listening port number <br />_(required)_ |
| **port** | int | Specifies the port that will be exposed by this container. Must be set when value different from containerPort is desired |
| **protocol** | 'TCP' | 'UDP' | The protocol in use by the port |
| **provides** | string | Specifies a route provided by this port |
| **scheme** | string | Specifies the URL scheme of the communication protocol. Consumers can use the scheme to construct a URL. The value defaults to 'http' or 'https' depending on the port value |

### ContainerVolumes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ description: "Detailed reference documentation for applications.core/gateways@20

| Property | Type | Description |
|----------|------|-------------|
| **destination** | string | The HttpRoute to route to. Ex - myserviceroute.id. |
| **destination** | string | The URL or id of the service to route to. Ex - 'http://myservice'. |
| **path** | string | The path to match the incoming request path on. Ex - /myservice. |
| **replacePrefix** | string | Optionally update the prefix when sending the request to the service. Ex - replacePrefix: '/' and path: '/myservice' will transform '/myservice/myroute' to '/myroute' |

Expand Down

0 comments on commit a8df58d

Please sign in to comment.