Add description on activity types, parameters and resources in mission models #1714
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
tratsko
changed the title
tratsko
force-pushed
the
feature/model-description-annotations
branch
from
4d2d758 to
023e8d7
Compare
tratsko
force-pushed
the
feature/model-description-annotations
branch
from
6adae16 to
6c52a1e
Compare
|
Per discussion with @shaheerk94 and @tratsko today, we decided to:
|
tratsko
force-pushed
the
feature/model-description-annotations
branch
from
5d56f74 to
0958370
Compare
tratsko
force-pushed
the
feature/model-description-annotations
branch
2 times, most recently
from
5d56f74 to
1e8315a
Compare
added 13 commits
September 4, 2025 11:17
…descriptions on parameters and fields on activities
… database with the parameter descriptions defined in an uploaded mission model jar
tratsko
force-pushed
the
feature/model-description-annotations
branch
from
0d96208 to
e6ce4b2
Compare
|
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.
Description
This adds description as an annotation to add on an activity definition in the mission model. @description on each activity. This is an optional annotation that takes in a string as the description under an activity.
This annotation can also be added onto parameters in activities to define a description for said parameter.
The mission model compiles with this annotation stored in the activity type and or parameters depending on which the annotation was placed onto.
Also there is a description the user can now add to resources when registering them. This is passed in as another parameter in the function that registers the resources.
Once the compiled model is uploaded to the Merlin server it gets the description and adds it to the activity type and or parameters in the database when each activity is created. Also when the resources are loaded into the database, the description is added to the description column on the resource type if it was defined in the mission model.
Verification
It compiles and picks up tags when the mission model is uploaded with annotations to the database. This verification was done in the e2e test in MissionModelTests for the activty types, parameters and resources.
Documentation
https://nasa-ammos.github.io/aerie-docs/mission-modeling/activity-types/introduction/#activity-type-metadata
This documentation on putting tags in the javadoc on mission models is invalidated by these changes. This documentation on the activity annotations is inaccurate so it will need to get changed.
Future work
Potentially add more annotations on activity types.