You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
`catalog` allows you to build a catalog using the octocatalog-diff compiler or to obtain a catalog from a Puppet server.
6
8
7
-
[Read more about `catalog`](/doc/dev/api/v1/catalog.md)
9
+
[Read more about the `catalog` call](/doc/dev/api/v1/calls/catalog.md)
8
10
9
-
## catalog-diff
11
+
####catalog-diff
10
12
11
13
`catalog-diff` allows you compare two catalogs and obtain the differences between them. Catalogs can be built if necessary.
12
14
13
-
[Read more about `catalog-diff`](/doc/dev/api/v1/catalog-diff.md)
15
+
[Read more about the `catalog-diff` call](/doc/dev/api/v1/calls/catalog-diff.md)
14
16
15
-
## config
17
+
####config
16
18
17
19
`config` allows you read and parse an [octocatalog-diff configuration file](/doc/configuration.md).
18
20
19
-
[Read more about `config`](/doc/dev/api/v1/config)
21
+
[Read more about the `config` call](/doc/dev/api/v1/calls/config.md)
22
+
23
+
## Objects
24
+
25
+
#### OctocatalogDiff::API::V1::Catalog
26
+
27
+
The `OctocatalogDiff::API::V1::Catalog` object represents a compiled catalog and supports several methods to get information about the catalog.
28
+
29
+
[Read more about the `OctocatalogDiff::API::V1::Catalog` object](/doc/dev/api/v1/objects/catalog.md)
30
+
31
+
#### OctocatalogDiff::API::V1::Diff
32
+
33
+
The `OctocatalogDiff::API::V1::Diff` object represents a difference between two catalogs and supports several methods to get information about the difference.
34
+
35
+
[Read more about the `OctocatalogDiff::API::V1::Diff` object](/doc/dev/api/v1/objects/diff.md)
# octocatalog-diff v1 API documentation: OctocatalogDiff::API::V1::Catalog
2
+
3
+
## Overview
4
+
5
+
`OctocatalogDiff::API::V1::Catalog` is an object that represents a compiled catalog.
6
+
7
+
It wraps the [`OctocatalogDiff::Catalog`](/lib/octocatalog-diff/catalog.rb) object.
8
+
9
+
This object is the return value from the [`catalog`](/doc/dev/api/v1/calls/catalog.md) API call, and the `to` and `from` catalogs computed by the [`catalog-diff`](/doc/dev/api/v1/calls/catalog-diff.md) API call.
# octocatalog-diff v1 API documentation: OctocatalogDiff::API::V1::Diff
2
+
3
+
## Overview
4
+
5
+
`OctocatalogDiff::API::V1::Diff` is an object that represents a single difference between two catalogs.
6
+
7
+
The return value from the `diffs` computed by the [`catalog-diff`](/doc/dev/api/v1/calls/catalog-diff.md) API call is an Array of these `OctocatalogDiff::API::V1::Diff` objects.
0 commit comments