docs: user guide for dashboard version and operation group creation from CSV file #47
Conversation
This file contains hidden or 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
b41ex
reviewed
Mar 24, 2025
docs/Portal User Guide.md
Outdated
| - **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). |
There was a problem hiding this comment.
It is probably a good idea to describe how path parameters should be specified in the path.
| - **API Type**: Set to rest. | ||
| - **Group Type**: Set to manual. | ||
|
|
||
| ### Report Generation: |
There was a problem hiding this comment.
How can a user see this report?
| 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. |
There was a problem hiding this comment.
Can we add some description of the use case for which this functionality could be used?
b41ex
changed the title
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.
Updated UG with Dashboard Version & Operation Group Creation from CSV.