Add example support to json schema

[timotheeguerin]

Discussed in #3944

^{Originally posted by risabhds July 23, 2024}
I have the following typespec in my playground:

import "@typespec/json-schema";

using TypeSpec.JsonSchema;

@jsonSchema
namespace Schemas;

/** Description goes here */
@summary("Title goes here")
model Person {
  /** The person's name. */
  @example("John")
  name: string;

  /** Age in years which must be equal to or greater than zero. */
  @example(18)
  @minValue(0)
  age: integer;
}

But I don't get examples in the emitted json-schema.

What I desire is a json-schema with examples on the property:

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "Person.json",
    "description": "Description goes here",
    "title": "Title goes here",
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "The person's name.",
            "examples": ["John"]
        },
        "age": {
            "type": "integer",
            "minimum": 0,
            "description": "Age in years which must be equal to or greater than zero.",
            "examples": [18]
        }
    },
    "required": [
        "name",
        "age"
    ]
}

How do I get examples in the emitted json-schema?

[markcowl]

est: 5

[timotheeguerin]

Cannot seem to find actual spec that json schema support that. This might not be the best idea to add without knowing more how it can be used.

[timotheeguerin]

Found it as part of the json schmea validaiton spec https://json-schema.org/draft/2020-12/json-schema-validation#name-examples