Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Issue #22] Update data models #68

Merged
merged 10 commits into from
Feb 4, 2025
Merged

Conversation

widal001
Copy link
Collaborator

@widal001 widal001 commented Feb 4, 2025

Summary

Updates the data models in the v0.1.0-alpha version of the CommonGrants TypeSpec library

Changes proposed

What was added, updated, or removed in this PR.

  • Adds the following models:
    • SystemMetadata which can be spread into other models to include createdAt and lastModifiedAt
    • OppTimeline which updates how key dates in the opportunity timeline are represented
    • CustomEnumValue which provides a flexible way of extending default enum values
  • Reorganizes the models related to Opportunity
  • Improves docstrings for the models in the package
  • Updates Opportunity model in the following ways:
    • Removes templating -- that just added complexity
    • Adds a status property
    • Adds a keyDates property

Context for reviewers

Testing instructions, background context, more in-depth details of the implementation, and anything else you'd like to call out or ask reviewers. Explain how the changes were verified.

  1. Checkout the PR
  2. Run npm run docs to preview the updated library

Additional information

Screenshots, GIF demos, code examples or output to help show the changes working as expected.

Screenshot 2025-02-04 at 11 53 38 AM

@widal001 widal001 merged commit b35240a into main Feb 4, 2025
2 checks passed
@widal001 widal001 deleted the issue-22-update-data-models branch February 4, 2025 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Spec] Opportunity data model and base types
1 participant