SchemaRecord Documentation Quest

[runspired]

SchemaRecord Overview

• @warp-drive/schema-record has a meaningful README with an overview and setup instructions
• @warp-drive/schema-record has a meaningful overview for the APIDocs

New Guides Content

• 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
• ??

New API Docs Content

• @warp-drive/schema-record instantiateRecord
• @warp-drive/schema-record teardownRecord
• @warp-drive/schema-record withDefaults
• @warp-drive/schema-record SchemaService
• @warp-drive/schema-record registerDerivations
• @warp-drive/schema-record fromIdentity
• @warp-drive/schema-record instantiateRecord
• @warp-drive/schema-record Checkout

Existing Guides Content Changes

• use schemas, types and schema-record instead of Models in super-rentals tutorial
• EmberData Section
  • Defining Models should become Defining Schemas
  • Creating, Updating and Deleting should no longer show legacy model method
    • remove save hasDirtyAttributes changedAttributes rollbackAttributes
    • remove deleteRecord isDeleted and destroyRecord
    • validation errors should be handled from the request, no more record.errors
  • Relationships
    • this whole section needs a major rework, not just to remove Models. Likely we should use the in-repo relationship guides as a starting point instead.

APIDocs Content Changes

• use schemas, types and schema-record instead of Models in main examples
• update main, store and request overviews to show SchemaRecord usage
• mark Model as legacy (link to schema-record)

[runspired]

Highest priority items for 5.4 from above in priority order

• New API Docs overview for SchemaRecord
• New API Docs content
• field schema guide w/current "standard mode" limitations
• linksMode guide
• legacy mode guide