Skip to content

Commit c53b201

Browse files
Will MeekDavidS
authored andcommitted
(FM-7819) Updates on keywords
1 parent 7369c9d commit c53b201

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -242,11 +242,11 @@ Puppet::ResourceAPI.register_transport(
242242
desc: 'Connects to a device_type',
243243
# features: [], # future extension points
244244
connection_info: {
245-
hostname: {
245+
host: {
246246
type: 'String',
247247
desc: 'The host to connect to.',
248248
},
249-
username: {
249+
user: {
250250
type: 'String',
251251
desc: 'The user.',
252252
},
@@ -287,8 +287,8 @@ The following keywords are encouraged within the Transport schema:
287287
The following keywords are keywords that must not be used by the transport schema:
288288

289289
* `name` - transports should use `uri` instead of name.
290-
* `path`
291-
* `query`
290+
* `path` - reserved as a uri part
291+
* `query` - reserved as a uri part
292292
* `run-on` - This is used by bolt to determine which target to proxy to. Transports should not rely on this key.
293293
* `remote-transport` - This is used to determine which transport to load. It should always be the transport class name "declassified".
294294
* `remote-*` Any key starting with `remote-` is reserved for future use.
@@ -299,7 +299,7 @@ After the device class, transport class and transport schema have been implement
299299

300300
#### Transport/device specific providers
301301

302-
To allow modules to deal with different backends independently, the Resource API implements a mechanism to use different API providers side by side. For a given transport/device class (see above), the Resource API will first try to load a `Puppet::Provider::TypeName::DeviceType` class from `lib/puppet/provider/type_name/device_type.rb`, before falling back to the regular provider at `Puppet::Provider::TypeName::TypeName`.
302+
To allow modules to deal with different backends independently, the Resource API implements a mechanism to use different API providers side by side. For a given transport/device class (see above), the Resource API will first try to load a `Puppet::Provider::TypeName::<DeviceType>` class from `lib/puppet/provider/type_name/device_type.rb`, before falling back to the regular provider at `Puppet::Provider::TypeName::TypeName`.
303303

304304
## Further reading
305305

0 commit comments

Comments
 (0)