String types

String types used throughout the protocol.

string

A sequence of characters. The base JSON Schema type for all string-derived scalars.

Example

"string"

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: string.yaml
type: string
description: A sequence of characters. The base JSON Schema type for all string-derived scalars.

url

A Uniform Resource Locator (URL).

Example

"http://example.com"

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: url.yaml
type: string
format: uri
description: A Uniform Resource Locator (URL).

uuid

A universally unique identifier.

Example

"30a12e5e-5940-4c08-921c-17a8960fcf4b"

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: uuid.yaml
type: string
examples:
  - 30a12e5e-5940-4c08-921c-17a8960fcf4b
format: uuid
description: A universally unique identifier.

TypeSpec

/** A universally unique identifier. */
@example("30a12e5e-5940-4c08-921c-17a8960fcf4b")
@format("uuid")
@Versioning.added(Versions.v0_1)
scalar uuid extends string;

email

An email address.

Example

"test@example.com"

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: email.yaml
type: string
examples:
  - test@example.com
format: email
description: An email address.

TypeSpec

/** An email address. */
@example("test@example.com")
@format("email")
@Versioning.added(Versions.v0_1)
scalar email extends string;