Skip to content

Commit 803383e

Browse files
author
Kevin Paulisse
committed
Documentation update for create_with_input
1 parent ccdb4dc commit 803383e

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

doc/dev/api/v1/objects/override.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,21 @@
66

77
## Constructor
88

9-
#### `#new(<Hash>)`
9+
#### `#new(<Hash> { key: <String>, value: <Object> })`
1010

1111
The hash must contain the following keys:
1212

1313
- `:key` (String) - The name of the fact or ENC parameter (e.g. `operatingsystem` or `parameters::fooclass::fooparam`)
1414
- `:value` (?) - The value of the fact or ENC parameter
1515

16+
See also: `#create_from_input`
17+
1618
## Methods
1719

20+
#### `#create_from_input(<String> key=value)` (OctocatalogDiff::API::V1::Override)
21+
22+
Parses the string (see [Overriding facts](/doc/advanced-override-facts.md) for the format to use). Returns a `OctocatalogDiff::API::V1::Override` object with key and value parsed from the string.
23+
1824
#### `#key` (String)
1925

2026
Returns the key as supplied in the constructor.

0 commit comments

Comments
 (0)