Skip to content

Commit 880f279

Browse files
author
Kevin Paulisse
committed
Stub documentation
1 parent 7de36fc commit 880f279

2 files changed

Lines changed: 25 additions & 0 deletions

File tree

doc/dev/api/v1/catalog-diff.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,17 @@
55
`catalog-diff` allows you compare two catalogs and obtain the differences between them. Catalogs can be built if necessary.
66

77
This is analogous to using the default arguments with the octocatalog-diff command-line script.
8+
9+
```
10+
catalog_diff_result = OctocatalogDiff::API::V1.catalog_diff(
11+
12+
)
13+
```
14+
15+
## Options
16+
17+
**NOTE**: Additional options as described in the [options reference](/doc/optionsref.md) may also have an effect on catalog difference generation.
18+
19+
## Return value
20+
21+
## Exceptions
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# octocatalog-diff v1 API documentation: OctocatalogDiff::Catalog
2+
3+
## Overview
4+
5+
`OctocatalogDiff::Catalog` is a class that represents a compiled catalog.
6+
7+
This object is the return value from the [`catalog`](/doc/dev/api/v1/catalog.md) API call.
8+
9+
## Methods
10+
11+
## Exceptions

0 commit comments

Comments
 (0)