Work for aviate catalog plugin #575
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
pierre
approved these changes
Nov 26, 2024
userguide/aviate/aviate-catalog.adoc
Outdated
|
|
||
| The Aviate plugin can be used as a catalog plugin. The Aviate catalog plugin serves as an alternative to the XML catalog managed within Kill Bill core. It provides APIs that operate at the plan/product/pricelist level, offering greater flexibility and granularity compared to the catalog version level. These APIs enable users to create individual catalog entries such as plans, products, and pricelists without the need to manage entire catalog versions. The catalog data created through the plugin is stored in tables managed by the Aviate plugin. | ||
|
|
||
| When the aviate catalog plugin features are enabled, the catalog served by the plugin takes priority over any _existing catalog entries_ created from regular KB catalog APIs (`/1.0/kb/catalog`) documented https://killbill.github.io/slate/catalog.html#upload-a-catalog-as-xml[here]. |
userguide/aviate/aviate-catalog.adoc
Outdated
|
|
||
| ``` | ||
| com.killbill.billing.plugin.aviate.enableCatalogApis=true | ||
| com.killbill.billing.plugin.aviate.enableHealthReporter=false //TODO is this required? |
There was a problem hiding this comment.
Nope, both properties shouldn't be required.
|
|
||
| This section lists the steps to be followed for the Aviate plugin installation. | ||
|
|
||
| //TODO - Steps to create the DB tables are not mentioned here, I'm assuming that com.killbill.billing.plugin.aviate.enableMigrations=true will automatically create the tables? |
There was a problem hiding this comment.
Yes, they should. We should explain how the flyway migration process works and also share the DDL somewhere (https://docs.killbill.io/latest/aviate-mysql.ddl ?)
There was a problem hiding this comment.
I'll gather more information about this and address this in a subsequent PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.