Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update resource methods #1218

Merged
merged 1 commit into from
Sep 10, 2024
Merged

update resource methods #1218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/content/reference/resource-schema/cache/redis/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,9 @@ The `redislabs.com/Redis` is a [resource]({{< ref portable-resources >}}) which

The following methods are available on the Redis cache:

| Method | Description |
|--------|-------------|
| connectionString() | Get the connection string for the Redis cache. |
| password() | Get the password for the Redis cache. |
| Method | Description | Example |
|--------|-------------|---------|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we expand on .value in the description, since it might not obvious until someone takes a closer look at the example?

| listSecrets() | Get the [secrets](#secrets) for the Redis cache. | `listSecrets().connectionString` |

## Resource provisioning

Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/resource-schema/core-schema/extender/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The following methods are available on the Extender resource:

| Method | Description |
|--------|-------------|
| secrets('SECRET_NAME') | Get the value of a secret. |
| .listSecrets('SECRET_NAME') | Get the value of a secret. |

## Resource provisioning

Expand Down
8 changes: 3 additions & 5 deletions docs/content/reference/resource-schema/databases/mongodb/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,9 @@ The `mongodb.com/MongoDatabase` [resource]({{< ref portable-resources >}}) repre

The following methods are available on the Mongo database resource:

| Method | Description |
|--------|-------------|
| connectionString() | Get the connection string for the MongoDb. |
| username() | Get the username for the MongoDB. |
| password() | Get the password for the MongoDB. |
| Method | Description | Example |
|--------|-------------|---------|
| listSecrets() | Get the [secrets](#secrets) for the MongoDb. | `listSecrets().connectionString` |

## Resource provisioning

Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/resource-schema/messaging/rabbitmq/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Secrets are used when defining a RabbitMQ resource with a container or external

| Property | Description | Example |
|----------|-------------|---------|
| `uri()` | Returns the RabbitMQ uri used to connect to the resource. | `amqp://guest:***@rabbitmq.svc.local.cluster:5672` |
| listSecrets() | Get the [secrets](#secrets) for the RabbitMQ. | `listSecrets().uri` |

## Resource provisioning

Expand Down
Loading