Skip to content

Commit 006c1a7

Browse files
author
Kevin Paulisse
committed
Add note in options reference about using parameters in the API
1 parent ff2c178 commit 006c1a7

2 files changed

Lines changed: 17 additions & 1 deletion

File tree

doc/optionsref.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1092,4 +1092,12 @@ parameters are to be checked. (<a href="../lib/octocatalog-diff/cli/options/vali
10921092
</td>
10931093
</tr>
10941094

1095-
</table>
1095+
</table>
1096+
1097+
## Using these options in API calls
1098+
1099+
Most of these options can also be used when making calls to the [API](/doc/dev/api.md).
1100+
1101+
Generally, parameters for the API are named corresponding to the names of the command line parameters, with dashes (`-`) converted to underscores (`_`). For example, the command line option `--hiera-config` is passed to the API as the symbol `:hiera_config`.
1102+
1103+
Each of the options above has a link to the source file where it is declared, should you wish to review the specific parameter names and data structures that are being set.

rake/templates/optionsref.erb

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,11 @@ Usage: octocatalog-diff [command line options]
3434
</tr>
3535
<% end %>
3636
</table>
37+
38+
## Using these options in API calls
39+
40+
Most of these options can also be used when making calls to the [API](/doc/dev/api.md).
41+
42+
Generally, parameters for the API are named corresponding to the names of the command line parameters, with dashes (`-`) converted to underscores (`_`). For example, the command line option `--hiera-config` is passed to the API as the symbol `:hiera_config`.
43+
44+
Each of the options above has a link to the source file where it is declared, should you wish to review the specific parameter names and data structures that are being set.

0 commit comments

Comments
 (0)