Skip to content

Commit

Permalink
Add database information to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
reshmabidikar committed Nov 28, 2024
1 parent 268c117 commit 27c93dd
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions userguide/aviate/aviate-catalog-plugin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@ The Aviate plugin can be installed as documented in the https://docs.killbill.io

=== Enabling Catalog APIs

To use the catalog API capabilities provided by the Aviate plugin, ensure that KB is started with the following properties:
To use the catalog API capabilities provided by the Aviate plugin, ensure that KB is started with the following property:

[source,bash]
----
com.killbill.billing.plugin.aviate.enableCatalogApis=true
----

Refer to the https://docs.killbill.io/latest/userguide_configuration.html[__Kill Bill Configuration Guide__] to know more about setting configuration properties.

=== Using Catalog Plugin APIs

Once the plugin is installed and enabled, you can start using the Catalog Plugin APIs. As mentioned earlier, the Aviate catalog plugin exposes endpoints that operate at a plan/product/pricelist level. These endpoints allow plan/product/pricelist creation/modification and deletion. At the time of writing, only plan-level endpoints are supported. The catalog API endpoints are documented in our https://apidocs.killbill.io/aviate-catalog-apis[slate docs].
Expand All @@ -47,7 +49,7 @@ Assuming we have the following plans, Pa, Pb, Pc, and we create those at differe
...
----

== FAQ
== FAQs

*Is it possible to use the KB catalog APIs when the Aviate catalog plugin is enabled?*

Expand Down

0 comments on commit 27c93dd

Please sign in to comment.