Skip to content

Commit df914aa

Browse files
authored
Update README.md
This commit makes minor edits.
1 parent 22f5f34 commit df914aa

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

language/resource-api/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -418,23 +418,23 @@ A transport connects providers to the remote target. It consists of the schema a
418418
419419
Password attributes should also set `sensitive: true` to ensure that the data is handled securely. Attributes marked with this flag allow any UI based off this schema to make appropriate presentation choices. The value will be passed to the transport wrapped in a `Puppet::Pops::Types::PSensitiveType::Sensitive`. This will keep the value from being logged or saved inadvertently while it is being transmitted between components. To access the value within the Transport use the `unwrap` method. e.g. `connection_info[:password].unwrap`.
420420
421-
The following keywords are encouraged within the transport schema:
422-
423-
* `uri` - Use when you need to specify a specific URL to connect to. All of the following keys will be computed from the `uri` if possible. In the future more url parts may be computed from the URI as well.
424-
* `host` - Use to specify and IP or address to connect to.
425-
* `protocol` - Use to specify which protocol the transport should use for example `http`, `https`, `ssh` or `tcp`
426-
* `user` - The user the transport should connect as.
427-
* `port` - The port the transport should connect to.
428-
429-
The following keywords must not be used by the transport schema:
430-
431-
* `name` - transports should use `uri` instead of name.
432-
* `path` - reserved as a uri part
433-
* `query` - reserved as a uri part
434-
* `run-on` - This is used by bolt to determine which target to proxy to. Transports should not rely on this key.
435-
* `remote-transport` - This is used to determine which transport to load. It should always be the transport class name "declassified".
436-
* `remote-*` Any key starting with `remote-` is reserved for future use.
437-
* `implementations`: reserved by bolt
421+
A transport schema accepts the following keywords:
422+
423+
* `uri`: use when you need to specify a specific URL to connect to. All of the following keys will be computed from the `uri` when possible. In the future more url parts may be computed from the URI.
424+
* `host`: use to specify an IP or address to connect to.
425+
* `protocol`: use to specify which protocol the transport should use for example `http`, `https`, `ssh` or `tcp`.
426+
* `user`: the user the transport should connect as.
427+
* `port`: the port the transport should connect to.
428+
429+
Do not use the following keywords when writing a schema:
430+
431+
* `name`: transports should use `uri` instead of name.
432+
* `path`: reserved as a uri part.
433+
* `query`: reserved as a uri part.
434+
* `run-on`: This is used by Bolt to determine which target to proxy to. Transports should not rely on this key.
435+
* `remote-transport`: This is used to determine which transport to load. It should always be the transport class named "declassified".
436+
* `remote-*`: any key starting with `remote-` is reserved for future use.
437+
* `implementations`: reserved by Bolt.
438438
439439
The transport implementation must implement the following methods:
440440

0 commit comments

Comments
 (0)