String types

string

A sequence of characters.

Example

"Hello, world!"

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: string.yaml
type: string
description: A sequence of characters

url

A Uniform Resource Locator (URL).

Example

"https://example.com/path"

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
format: uuid
description: A universally unique identifier

TypeSpec

/** A universally unique identifier */
@example("30a12e5e-5940-4c08-921c-17a8960fcf4b")
@format("uuid")
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
format: email
description: An email address

TypeSpec

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

employerTaxId

An Employer Identification Number (EIN).

Example

"12-3456789"

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: employerTaxId.yaml
type: string
pattern: "^[0-9]{2}-[0-9]{7}$"
description: An Employer Identification Number (EIN)

TypeSpec

/** An Employer Identification Number (EIN) */
@example("123456789")
@pattern("^[0-9]{2}-[0-9]{7}$")
scalar employerTaxId extends string;

samUEI

A Unique Entity Identifier (UEI).

Example

"ABC1234567890"

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: samUEI.yaml
type: string
pattern: "^[A-z0-9]{12}$"
description: A Unique Entity Identifier (UEI)

TypeSpec

/** A Unique Entity Identifier (UEI) */
@example("ABC1234567890")
@pattern("^[A-z0-9]{12}$")
scalar samUEI extends string;

duns

A Data Universal Numbering System (DUNS) number.

Example

"123456789012"

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: duns.yaml
type: string
pattern: "^[0-9]{9}$"
description: A Data Universal Numbering System (DUNS) number

TypeSpec

/** A Data Universal Numbering System (DUNS) number */
@example("123456789012")
@pattern("^[0-9]{9}$")
scalar duns extends string;