String types

string

A sequence of characters.

Example
JSON Schema

A JSON example of this model.

"Hello, world!"

The JSON Schema for this model.

$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
JSON Schema

A JSON example of this model.

"https://example.com/path"

The JSON Schema for this model.

$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.

A JSON example of this model.

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

The JSON Schema for this model.

$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

The TypeSpec code for this model.

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

email

An email address.

A JSON example of this model.

"test@example.com"

The JSON Schema for this model.

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

The TypeSpec code for this model.

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

employerTaxId

An Employer Identification Number (EIN).

A JSON example of this model.

"12-3456789"

The JSON Schema for this model.

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

The TypeSpec code for this model.

/** An Employer Identification Number (EIN) issued by the IRS */
@example("12-3456789")
@pattern("^[0-9]{2}-[0-9]{7}$")
@Versioning.added(CommonGrants.Versions.v0_2)
scalar employerTaxId extends string;

samUEI

A Unique Entity Identifier (UEI).

A JSON example of this model.

"12ABC34DEF56"

The JSON Schema for this model.

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

The TypeSpec code for this model.

/** A Unique Entity Identifier (UEI) issued by SAM.gov */
@example("12ABC34DEF56")
@pattern("^[A-z0-9]{12}$")
@Versioning.added(CommonGrants.Versions.v0_2)
scalar samUEI extends string;

duns

A Data Universal Numbering System (DUNS) number.

A JSON example of this model.

"12-345-6789"

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: duns.yaml
type: string
examples:
  - 123456789-1234
  - 12-345-6789
  - "123456789"
description: A Data Universal Numbering System (DUNS) number

The TypeSpec code for this model.

/** A Data Universal Numbering System (DUNS) number */
@example("123456789")
@example("12-345-6789")
@example("123456789-1234")
@Versioning.added(CommonGrants.Versions.v0_2)
scalar duns extends string;