Skip to content
This repository was archived by the owner on Jan 19, 2025. It is now read-only.

Conversation

nvollroth
Copy link
Contributor

Closes #902

Summary of Changes

See Issue.

Screenshots (if necessary)

JSON File of API - data:

DefaultValue_JSON

Result in API-Eidtor:

DefaultValue_APIeditor

Testing Instructions

  1. Load your api-data in the api-editor
  2. Look after the default values

@nvollroth nvollroth linked an issue Jul 8, 2022 that may be closed by this pull request
@github-actions
Copy link

github-actions bot commented Jul 8, 2022

MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ CREDENTIALS secretlint yes no 3.82s
✅ GIT git_diff yes no 0.01s
✅ TSX eslint 1 0 0 8.8s
✅ TYPESCRIPT eslint 3 0 0 8.03s
✅ TYPESCRIPT prettier 4 0 0 1.32s

See errors details in artifact MegaLinter reports on CI Job page
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

@lars-reimann lars-reimann changed the title feat: default value of the code and the default value of the documentation in Paramter View feat(gui): show default value from code and documentation in selection view Jul 8, 2022
Copy link
Member

@lars-reimann lars-reimann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current solution does not work well if the fields are empty:

image

If the code field is empty, the message "The parameter is required." should be shown and both fields omitted:

image

If the documentation field is empty, the message "The documentation does not specify a default value." should be shown.

image

Both should be formatted like the text about missing documentation:

image

nvollroth added 2 commits July 8, 2022 15:06
…mentation-in-selection-view-of-parameters' into 902-show-default-value-from-documentation-in-selection-view-of-parameters

# Conflicts:
#	api-editor/gui/src/features/packageData/selectionView/ParameterView.tsx
@nvollroth
Copy link
Contributor Author

Changes were applied.

@nvollroth nvollroth requested a review from lars-reimann July 8, 2022 13:08
@lars-reimann lars-reimann enabled auto-merge (squash) July 8, 2022 13:42
@lars-reimann lars-reimann merged commit fa4687f into main Jul 8, 2022
@lars-reimann lars-reimann deleted the 902-show-default-value-from-documentation-in-selection-view-of-parameters branch July 8, 2022 13:45
@github-actions
Copy link

github-actions bot commented Jul 8, 2022

🎉 This PR is included in version 1.52.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

released Included in a release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Show default value from documentation in selection view of parameters

2 participants