Skip to content

Commit 5b876f7

Browse files
author
Kevin Paulisse
committed
Add API doc for fact override
1 parent 206ad31 commit 5b876f7

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

doc/dev/api/v1.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,9 @@ The `OctocatalogDiff::API::V1::Catalog` object represents a compiled catalog and
3333
The `OctocatalogDiff::API::V1::Diff` object represents a difference between two catalogs and supports several methods to get information about the difference.
3434

3535
[Read more about the `OctocatalogDiff::API::V1::Diff` object](/doc/dev/api/v1/objects/diff.md)
36+
37+
#### OctocatalogDiff::API::V1::FactOverride
38+
39+
The `OctocatalogDiff::API::V1::FactOverride` object represents a user-supplied fact that will be used when compiling a catalog.
40+
41+
[Read more about the `OctocatalogDiff::API::V1::FactOverride` object](/doc/dev/api/v1/objects/fact_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::FactOverride
2+
3+
## Overview
4+
5+
`OctocatalogDiff::API::V1::FactOverride` is an object that represents a user-supplied fact 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+
- `:fact_name` (String) - The name of the fact (e.g. `operatingsystem` or `ipaddress`)
14+
- `:value` (?) - The value of the fact
15+
16+
## Methods
17+
18+
#### `#fact_name` (String)
19+
20+
Returns the name of the fact as supplied in the constructor.
21+
22+
#### `#value` (?)
23+
24+
Returns the value of the fact as supplied in the constructor.

0 commit comments

Comments
 (0)