Content

[JeelRajodiya]

The work is being done in the content branch

Things to keep in mind

• Each step builds upon the previous one
• The reader should not need to look ahead to find any unknown definitions, it should be covered or should be at least mentioned
• Do not bore the reader, teach practical concepts first.
• The steps should not be too long. They should be of appropriate length.
• Use some contexts for teaching the schema - API Design, Aviation, Finance etc.
• Make the starting steps of the chapter intriguing so the reader keeps reading
• Add a chapter summary after in the last steps if necessary
• Teach through complex examples

Topics to Cover

Note: This list will keep getting updated

Basics

• 1. JSON Schema Syntax and Structure

Overview of Basic Types

• 1. Boolean
• 2. Numeric Type
• 3. String
• 4. Object
• 5. Array
• 6. Specifying Constant Values
• 7. Null

Generic Keywords

• 1. Defining Enumerated Values with enum Keyword
• 2. type Keyword
• 3. $schema keyword
• 4. $id keyword

Strings

• 1. Constraining the Length with minLength and maxLength
• 2. Restricting String Values with enum
• 3. Regular Expressions

Numeric Types

• 1. Integer
• 2. Number
• 3. Using enum with Integers and Numbers
• 4. Restricting a Number to be Multiples of a Given Number - multipleOf keyword
• 5. exclusiveMinimum
• 6. exclusiveMaximum
• 7. minimum
• 8. maximum

Arrays

• 1. Specifying types for array Items
• 2. Tuple Validation
• 3. Unique Items
• 4. Additional Items
• 5. Unevaluated Items
• 6. Using contains keyword
• 7. Specifying Valid Array Items with enum
• 8. minContains and maxContains
• 9. Specifying the Length of an Array

Objects

• 1. Creating Properties in Object
• 2. Defining Pattern Properties
• 3. Defining Required Properties
• 4. minProperties and maxProperties
• 6. Using The propertyNames Keyword
• 7. Handling the Extra Stuff with additionalProperties
• 8. Creating a Nested Data Structure
• 9. Unevaluated Properties
• 10. Extending closed schema

Combining Schemas and Types

• 1. Defining Subschemas with $defs Keyword
• 2. Add External References - $ref Keyword
• 3. Check for Valid Against All Subschemas (AND) - allOf
• 4. Check for Valid Against Any Subschemas (OR) - anyOf
• 5. Check for Valid Against Exactly One Subschemas (XOR) - oneOf
• 6. Check for Not Valid Against The Given Schemas (NOT) - not
• 7. Defining one property with multiple possible types using - source
• 8. Recursive schemas

Conditional Validation

• 1. Conditionally Requiring Certain Properties to be Present - dependentRequired
• 2. Creating Dependent Schemas
• 3. If-Then-Else
• 4. Defining implications (A → B)

Annotating with JSON Schema

• 1. title and description keyword
• 2. Adding Comments with $comment Keyword
• 3. Using the default Keyword
• 4. Using the examples Keyword
• 5. Using the deprecated Keyword
• 6. readOnly and writeOnly Properties in Objects
• 7. Format Keyword in Strings

[JeelRajodiya]

Some Similar Projects for Content and Design inspiration

https://go.dev/tour/welcome/1
https://react.dev/learn
https://vuejs.org/tutorial/#step-1
https://learn.svelte.dev/tutorial/welcome-to-svelte
https://preactjs.com/tutorial/01-vdom
https://www.solidjs.com/tutorial/introduction_basics
https://web.dev/learn/css/box-model
https://nextjs.org/learn/dashboard-app
https://nuxt.com/ <- nice typography