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

feat: SchemaRecord guide #9691

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: SchemaRecord guide #9691

wants to merge 1 commit into from

Conversation

runspired
Copy link
Contributor

This PR is a Mega Guides/Docs Push for the 5.4 release.

Roughly speaking we probably want to ensure we have coverage of

  • How to author a resource/object schema
  • kinds of FieldSchema and what they do
  • which FieldSchema kinds / features are not yet supported in standard mode
  • configuring SchemaRecord
  • configuring SchemaRecord AND Model
  • immutability/remoteState expectations of SchemaRecord
  • editing and saving an immutable SchemaRecord
  • editing and saving deep-object changes
  • using legacy mode for SchemaRecord (and its expectations)
  • linksMode with Model relationships
  • linksMode with SchemaRecord relationships
  • using Types with SchemaRecord
  • registering and using transformations
  • registering and using derivations
  • registering and using hash functions
  • registering and using default derivations for legacy mode
  • registering and using default derivations for standard mode
  • "rules" for registering schema information
  • withDefaults for legacy mode
  • withDefaults for standard mode
  • migrating between Model and SchemaRecord
  • advanced migration via Proxy + legacy mode
  • ??

@runspired runspired added 🎯 canary PR is targeting canary (default) 🏷️ doc This PR adds/improves/or fixes documentation labels Feb 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🎯 canary PR is targeting canary (default) 🏷️ doc This PR adds/improves/or fixes documentation
Projects
Status: needs triage
Development

Successfully merging this pull request may close these issues.

1 participant