README.md

IPLD Schemas

Status: Prescriptive - Draft

• IPLD Schemas Goals
• IPLD Schemas Feature Summary
• An Introduction to IPLD Schemas
  • A Quick IPLD Primer
  • Building on the Data Model
  • Use Cases
    • Schemas as a documentation tool
    • Schemas as a validation tool
    • Schemas as a versioning and migration tool
    • Schemas as a transformational tool
    • Schemas as a code generation tool
  • Schema Language: DSL and Reified Form
• Authoring IPLD Schemas
  • Basics
    • Records: type and advanced
    • Newlines and Whitespace
    • Comments
  • Schema Kinds
  • Naming Types
  • Named Scalar Types (typedefs)
  • Links
  • Inline Recursive Types
  • Representations
    • Representation Parameters
  • Structs
  • Enums
  • Unions
    • Introduction to Unions: Kinded Unions
    • Limitations of Union Discrimination
    • Alternative Discrimination Strategies
    • Byteprefix Unions for Bytes
  • Copy
  • Advanced Data Layouts
  • Schemas in Markdown
• Links and IPLD Schemas
  • Link Destination Type Hinting
• IPLD Schema Kinds
  • Extending the IPLD Data Model
    • Data Model Kinds
    • Schema Kinds
  • Value Type Modifiers
    • Nullable Values
    • Optional Fields
    • Fields with Implicit Values
    • Combining Nullable, Optional, and Implicit
    • Choosing between Optional and Implicit
  • Understanding Cardinality
    • Cardinality Examples
• Representations of IPLD Schema Kinds
  • Available Representation Strategies
  • Representation Strategy Reference
    • Struct map Representation
    • Struct tuple Representation
    • Struct stringpairs Representation
    • Struct stringjoin Representation
    • Struct listpairs Representation
    • Map map Representation
    • Map stringpairs Representation
    • Map listpairs Representation
    • Union keyed Representation
    • Union kinded Representation
    • Union envelope Representation
    • Union inline Representation
    • Union byteprefix Representation
    • Enum string Representation
    • Enum int Representation
• Advanced Layouts
  • Basic Schema Definition and Use

Additional Resources:

• IPLD Schemas represented as an IPLD Schema (schema-schema) and its canonical JSON representation form
• Basic typical usage examples and its canonical JSON representation form