Add descriptions to GraphQL V2 fields #642
Merged
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
jazairi
force-pushed
the
timx-116-add-descriptions
branch
from
5ce7bda to
e685b85
Compare
JPrevost
reviewed
Jan 26, 2023
| field :physical_description, String, null: true, description: 'Physical description of item' | ||
| field :publication_frequency, [String], null: true, | ||
| description: 'Publication frequency of item (used for serials)' | ||
| field :numbering, String, null: true |
There was a problem hiding this comment.
@hakbailey do you have suggestion as to what wording we might use to describe numbering? It wasn't defined in the data model documents used to add descriptions to the other fields.
|
@JPrevost I just pushed another commit to address your feedback and document subfields and aggregations. Please let me know if I missed anything, and if any of the subfield descriptions can be improved (some are better than others). |
JPrevost
reviewed
Jan 27, 2023
JPrevost
approved these changes
Jan 27, 2023
Why these changes are being introduced: Many of the GraphQL fields are not documented. Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/TIMX-116 How this addresses that need: This adds descriptions to all V2 fields and search arguments, using the TIMDEX Data Model v2.0 document as a guide. Side effects of this change: * Descriptions have been modified from the data model where applicable, or newly written where unavailable (specifically, subfields and aggregations). * One field, 'numbering', does not have a description in the data model. I've set this aside until we have a better understanding of what it does.
jazairi
force-pushed
the
timx-116-add-descriptions
branch
from
5712eed to
432bf01
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.
Why these changes are being introduced:
Many of the GraphQL fields are not documented.
Relevant ticket(s):
How this addresses that need:
This adds descriptions to all V2 fields and search arguments, using the TIMDEX Data Model v2.0 document as a guide.
Side effects of this change:
Developer
our guide and
all issues introduced by these changes have been resolved or opened as new
issues (link to those issues in the Pull Request details above)
Code Reviewer
(not just this pull request message)
Requires database migrations?
NO
Includes new or updated dependencies?
NO