feat(docs): enhance general information output with model details #4000
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
Added a new section to the general information output in the docs service to display the models defined in the script configuration. The output now includes a label for 'Model' or 'Models' based on the count of models, improving clarity for users.
|
Your mrge subscription is currently inactive. Please reactivate your subscription to receive AI reviews and use mrge. |
bodinsamuel
reviewed
May 7, 2025
| const generalInfo = [ | ||
| `## General Information`, | ||
| ``, | ||
| `- **Description:** ${scriptConfig.description ?? ''}`, | ||
| `- **Version:** ${scriptConfig.version ? scriptConfig.version : '0.0.1'}`, | ||
| `- **Group:** ${endpoint && typeof endpoint !== 'string' && 'group' in endpoint ? endpoint?.group : 'Others'}`, | ||
| `- **Scopes:** ${scopes ? `\`${scopes}\`` : '_None_'}`, | ||
| `- **Endpoint Type:** ${endpointType.slice(0, 1).toUpperCase()}${endpointType.slice(1)}` | ||
| `- **Endpoint Type:** ${endpointType.slice(0, 1).toUpperCase()}${endpointType.slice(1)}`, | ||
| `- **${modelLabel}:** ${models}` |
There was a problem hiding this comment.
output undefined if an action has no output.
also it's probably missing Input for action too (when available)
There was a problem hiding this comment.
updated to include action inputs as well.
Just confirming that by undefined it is the string itself rather than omitting the Model info if there is no output model
current sample output
## General Information
- **Description:** Test action with no input and output models
- **Version:** 0.0.1
- **Group:** TestAction
- **Scopes:** _None_
- **Endpoint Type:** Action
- **Model:** `undefined`
- **Input Model:** _None_
There was a problem hiding this comment.
alt option
## General Information
- **Description:** Test action with no input and output models
- **Version:** 0.0.1
- **Group:** TestAction
- **Scopes:** _None_
- **Input Model:** _None_
- **Model:** _None_
…n the endpoint type is 'action'. - eslint fixes: There should be at least one empty line between import groups
bodinsamuel
approved these changes
May 12, 2025
…-the-general-information-section-of-the-docs
bodinsamuel
deleted the
victorlangat/ext-592/add-the-model-name-to-the-general-information-section-of-the-docs
branch
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.
Added a new section to the general information output in the docs service to display the models defined in the script configuration. The output now includes a label for 'Model' or 'Models' based on the count of models, improving clarity for users.
EXT-592
This PR enhances the documentation service by adding model information to the general information section. It displays the defined models with appropriate singular/plural labels based on the count, and includes input model details for 'action' endpoint types.
This summary was automatically generated by @propel-code-bot