Skip to content

Commit ccdb4dc

Browse files
author
Kevin Paulisse
committed
Update API documentation FactOverride -> Override
1 parent 97aacfe commit ccdb4dc

3 files changed

Lines changed: 27 additions & 27 deletions

File tree

doc/dev/api/v1.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ The `OctocatalogDiff::API::V1::Diff` object represents a difference between two
3434

3535
[Read more about the `OctocatalogDiff::API::V1::Diff` object](/doc/dev/api/v1/objects/diff.md)
3636

37-
#### OctocatalogDiff::API::V1::FactOverride
37+
#### OctocatalogDiff::API::V1::Override
3838

39-
The `OctocatalogDiff::API::V1::FactOverride` object represents a user-supplied fact that will be used when compiling a catalog.
39+
The `OctocatalogDiff::API::V1::Override` object represents a user-supplied fact or ENC parameter that will be used when compiling a catalog.
4040

41-
[Read more about the `OctocatalogDiff::API::V1::FactOverride` object](/doc/dev/api/v1/objects/fact_override.md)
41+
[Read more about the `OctocatalogDiff::API::V1::Override` object](/doc/dev/api/v1/objects/override.md)

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

Lines changed: 0 additions & 24 deletions
This file was deleted.

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

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# octocatalog-diff v1 API documentation: OctocatalogDiff::API::V1::Override
2+
3+
## Overview
4+
5+
`OctocatalogDiff::API::V1::Override` is an object that represents a user-supplied fact or ENC parameter that will be used when compiling a catalog.
6+
7+
## Constructor
8+
9+
#### `#new(<Hash>)`
10+
11+
The hash must contain the following keys:
12+
13+
- `:key` (String) - The name of the fact or ENC parameter (e.g. `operatingsystem` or `parameters::fooclass::fooparam`)
14+
- `:value` (?) - The value of the fact or ENC parameter
15+
16+
## Methods
17+
18+
#### `#key` (String)
19+
20+
Returns the key as supplied in the constructor.
21+
22+
#### `#value` (?)
23+
24+
Returns the value as supplied in the constructor.

0 commit comments

Comments
 (0)