-
Couldn't load subscription status.
- Fork 1
docs: user guide for dashboard version and operation group creation from CSV file #47
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Changes from 1 commit
3b62e92
44f249d
0ce7de6
927a2ce
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1172,6 +1172,36 @@ You cannot add the same package more than one time, i.e. as soon as you add any | |
|
|
||
| If such situation occurs during configuration of dashboard version, the system highlights all conflicted packages. If you do not resolve conflicts manually and publish such dashboard version, the system will automatically resolve conflicts and will skip some link(s) to the conflicted package. After publication of dashboard version, you can see in Packages menu if some link(s) to package version(s) were automatically skipped. | ||
|
|
||
| ## Configure Dashboard and Operation Groups by Importing CSV File | ||
| This functionality allows you to configure both dashboards and operation groups directly by uploading a CSV file. You can use this method to automatically create dashboard version and operation groups based on the data provided in the CSV file. | ||
|
|
||
| 1. Navigate to the Dashboard Version page (either an empty dashboard or an existing dashboard version). | ||
| 2. Click the **Create Version** dropdown and select **Import via CSV**. | ||
| 3. In the Publish Dashboard Version popup, upload your CSV file in the **Dashboard version config** section. Only .csv files are supported. | ||
| 4. In the **Package Search Scope for Dashboard Version** section, select the workspace in which package versions for services from the CSV configuration will be searched. By default, the field will be pre-filled with the default workspace. If no default workspace is configured or it doesn’t exist, the field will be empty. | ||
| 5. Fill out the required fields in the Publish Info section as per the standard publishing process. | ||
| 6. Once everything is set, click **Publish**. The publication process follows the same steps as for publishing a package version. The new dashboard version will open automatically once published. | ||
| 7. You will receive a confirmation notification once the dashboard version is successfully published. | ||
|
|
||
| ### CSV file must have the following structure: | ||
| - **serviceName** - required column; name of the service (e.g., account-mgmt-core), will be used to identify the relevant package in APIHUB. | ||
| - **serviceVersion** - required column; version of the specified service; package of this version will be included into dashboard. Only one service version must be specified for a specific service, i.e. CSV file must not contain the same service name with different version. If there will be different versions of one service, then only one package version will be included into dashboard. | ||
| - **method** - HTTP method of the REST API operation (e.g., GET, POST, PATCH, DELETE). | ||
| - **path** - endpoint of the API operation (e.g., /accountManagement/v2/billingAccount). | ||
|
||
|
|
||
| The file must use a semicolon ; as the delimiter. | ||
|
|
||
| ### Operation Groups: | ||
| If both **method** and **path** columns are specified in the CSV file, the system will search for operations based on the method and path in the found package versions. It will then create a manual operation group and include all matching operations into this group. The operation group will be created with the following attributes: | ||
| - **Group Name**: The name of the dashboard. | ||
| - **API Type**: Set to rest. | ||
| - **Group Type**: Set to manual. | ||
|
|
||
| ### Report Generation: | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How can a user see this report? |
||
| A CSV report will be generated after publishing, containing: | ||
| - The original data from the uploaded CSV file. | ||
| - Any issues encountered (e.g., missing packages or operations). | ||
|
|
||
| ## Publish Dashboard Version | ||
| After you configured your dashboard version, you can publish it by clicking **Publish**. The publication process for dashboard version is the same as for package version, see more details in *publish package version* section. | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add some description of the use case for which this functionality could be used?