Standard types
On this page
Every standard type Jadpo has, 259 in all, by group. Each page says how to make one and how it is written, sent as JSON, stored and shown to people, with its examples. The standard types explains the list.
People and contact
| Type | What it is |
|---|---|
PersonName |
A person's name: their given name and, where they have one, their family name. |
GivenName |
A given name, one line as the person writes it. |
FamilyName |
A family name, one line as the person writes it. |
Username |
A login handle: lower-case letters, digits, _, . and -, 1 to 64 of them. |
Email |
An email address, checked as one. |
EmailWithName |
A mailbox (RFC 5322): an address with the name shown with it, written Ada Lovelace <ada@example.com>. |
PhoneNumber |
A phone number in E.164, +447400123456, valid by libphonenumber's metadata for its region. |
PhoneExtension |
An internal extension dialled after a phone number: up to 20 digits. |
PostalAddress |
A postal address in any country: its street lines, its locality, region and postal code where its country uses them, and the country. |
PostalCode |
A postal code, SW1A 1AA, checked by its country's pattern where the country is known. |
Uprn |
A Unique Property Reference Number (GeoPlace): up to 12 digits, held as text so no zero is lost: 100023336956. |
Nationality |
A person's nationality, named by the country, as ISO 3166-1 codes it: GB. |
Places
| Type | What it is |
|---|---|
Country |
A country (ISO 3166-1), written as its alpha-2 code, GB; form: CodeForm.alpha3 writes GBR and CodeForm.numeric 826. |
CountrySubdivision |
A country's subdivision (ISO 3166-2), written as its code, GB-ENG, its variant CountrySubdivision.gb_eng. |
Continent |
A continent, as UN M49 groups the world: written as its own name, europe, and as M49's number with form: CodeForm.numeric. |
UnLocode |
A place in trade and transport (UN/LOCODE): a country's code and three letters or digits, GBLON. |
CallingCode |
A country calling code (ITU-T E.164) with its +: +44. |
Language |
A language (ISO 639-1), written as its code, en; form: CodeForm.alpha3 writes ISO 639-2's eng. |
WritingScript |
A writing system (ISO 15924), written as its code, Latn; form: CodeForm.numeric writes its number, 215. |
TextDirection |
Which way text runs, written as HTML's dir writes it, ltr and rtl: what locale.direction gives. |
Locale |
A CLDR locale, written as its BCP 47 tag, en-GB. |
Zone |
An IANA time zone, written as its name, Europe/London. |
Geospatial
| Type | What it is |
|---|---|
Point |
A position on Earth in WGS84: its latitude and longitude by name, and its height above the ellipsoid where it has one. |
Latitude |
Degrees north of the equator in WGS84, from -90 to 90, held as written: 51.5072, shown 51.5072° N. |
Longitude |
Degrees east of the prime meridian in WGS84, from -180 to 180, held as written: -0.1276, shown 0.1276° W. |
LineString |
A path of two points or more, in order: a GeoJSON LineString. |
Polygon |
An area with any holes: a GeoJSON Polygon, each ring closed with four points or more, the outer counterclockwise and each hole clockwise when written. |
MultiPoint |
Points, at least one: a GeoJSON MultiPoint. |
MultiLineString |
Paths, at least one: a GeoJSON MultiLineString. |
MultiPolygon |
Areas, at least one: a GeoJSON MultiPolygon. |
Geometry |
Any one of the six geometries, sent as the GeoJSON geometry it holds. |
BoundingBox |
A rectangle on the map by its sides (RFC 7946's bounding box), named: its south at or below its north, and a west east of its east across the antimeridian. |
Circle |
A centre and a radius on the ground, the radius never below 0: shown 1,000 m around 51.5072° N, 0.1276° W. |
Bearing |
A compass direction, degrees clockwise from true north, from 0 to 360: 247.5, shown 247.5°. |
Crs |
A coordinate reference system by its EPSG code: EPSG:27700. |
EastingNorthing |
Projected coordinates: an easting and a northing, by name, in their reference system's units. |
MapTile |
A web map tile on OpenStreetMap's XYZ scheme: a zoom from 0 to 30 and a column and row each below 2 to the zoom, shown 10/511/340. |
H3Cell |
An H3 cell (Uber's H3 index), 15 lower-case hexadecimal digits, its bits valid: 8928308280fffff. |
Geohash |
A geohash cell (geohash.org): 1 to 12 characters, in lower case: gcpvj0duq. |
Feature |
A GeoJSON Feature: a geometry of the type G, one of the six or Geometry, and properties of the application's Object type P, sent as RFC 7946 writes one, with no id: Feature<Polygon, PatchProperties>. |
FeatureCollection |
A GeoJSON FeatureCollection: features of one geometry type and one properties type, in order, as a map library takes a layer. |
Money and banking
| Type | What it is |
|---|---|
Money |
An amount of money: a whole number of its currency's minor units and its Currency, written GBP 10.50. |
Currency |
An active ISO 4217 currency, written as its code, GBP. |
ExchangeRate |
A rate between two currencies at an instant: one from is rate of to, written GBP/EUR 1.17 2026-10-18T09:00:00Z. |
Price |
An amount and whether it includes tax, so a gross price is never taken for a net one: shown as its amount, £10.50. |
UnitPrice |
A price per an amount of a quantity, a choice by the quantity's kind, as the UK's Price Marking Order prices goods by weight, volume, length and area: shown £2.50/1 kg. |
TaxRate |
A rate of tax, a percentage never below 0%: 20%. |
Discount |
An amount off a price or a percentage off it, a choice: money.apply_discount takes one off a Price. |
BasisPoints |
A count of hundredths of a percent, a whole number of any sign, so 25 basis points is never read as 25%: shown 25 bp. |
InterestRate |
A rate of interest a year and the basis it is quoted on, shown as a lender writes it, 5.5% APR. |
PaymentCardNumber |
A payment card's number (ISO/IEC 7812), 12 to 19 digits with a Luhn check digit: 4242424242424242. |
MaskedCardNumber |
What may be kept of a payment card once its number is gone (PCI DSS): its brand, where a listed scheme issued it, and its last four digits, shown as Visa •••• 4242. |
CardBrand |
A card scheme, written as its own name, visa, and shown by the scheme's, "Visa". |
CardBin |
The first 6 or 8 digits of a card number, naming its issuer: 424242. |
CardExpiry |
The month a payment card runs to, to its end, written 2028-12 and shown as the card prints it, 12/28: year from 2000 to 2099, month from 1 to 12. |
PaymentReference |
The reference a payer sees on a UK bank payment: up to 18 of Bacs's characters, INV-2026/0042. |
InvoiceNumber |
An invoice's number (EN 16931): 1 to 200 characters, with no space at either end. |
Iban |
An IBAN (ISO 13616) in its electronic form, upper case with no spaces, its mod-97 check digits passing: GB29NWBK60161331926819. |
Bic |
A bank identifier code (ISO 9362), 8 or 11 characters: DEUTDEFF. |
UkSortCode |
A UK bank sort code, six digits: 089999, shown to people as 08-99-99. |
UkAccountNumber |
A UK bank account number, eight digits with leading zeros kept: 66374958. |
BankAccount |
A bank account to pay into or take from: a UK sort code and account number, an IBAN, or another country's account by its country, its bank's code where it has one, and its number. |
AbaRoutingNumber |
A US bank's ABA routing number, nine digits with a 3-7-1 checksum: 021000021. |
Lei |
A Legal Entity Identifier (ISO 17442), its mod-97 check digits passing: 506700GE1G29325QX363. |
Isin |
A securities identification number (ISO 6166), its Luhn check digit passing: US0378331005. |
InterestRateBasis |
The basis an interest rate is quoted on: the annual equivalent rate of savings (aer), the annual percentage rate of borrowing (apr), or a flat rate on the sum first lent (flat). |
Tax and identity numbers
| Type | What it is |
|---|---|
VatNumber |
A VAT registration number, written as VIES writes it: its country's code (EL for Greece) and the number in that country's form, GB980780684. |
TaxId |
A taxpayer's identification number with the country that issued it, as the OECD's common reporting standard records one: any of that country's forms, a UTR or a National Insurance number for the United Kingdom. |
UkUtr |
A UK Unique Taxpayer Reference, ten digits. |
UkCompanyNumber |
A UK company's number at Companies House, eight digits or two letters and six: 00445790, SC123456. |
UkNationalInsuranceNumber |
A UK National Insurance number, its prefix one HMRC allocates: AB123456C, shown to people as AB 12 34 56 C. |
UsSsn |
A US Social Security number, nine digits that the SSA could have issued: 123456789. |
UsEin |
A US Employer Identification Number, nine digits: 123456789, shown to people as 12-3456789. |
PassportNumber |
A passport's number with the country that issued it (ICAO Doc 9303): the number upper case, in that country's form where it publishes one, 123456789 for the United Kingdom. |
DrivingLicenceNumber |
A driving licence's number with the country that issued it: the number upper case with no spaces, in that country's form where it publishes one, MCADI801206HZ9HM for Great Britain. |
IdentityDocument |
An identity document: its kind, the country that issued it, its number in that country's form for its kind, and the day it expires, if it does. |
IdentityDocumentKind |
What kind of identity document one is, written as its own name: passport, identity_card, driving_licence, residence_permit. |
NhsNumber |
An NHS number, ten digits with a mod-11 check digit: 9434765919, shown to people as 943 476 5919. |
Commerce and logistics
| Type | What it is |
|---|---|
Sku |
A seller's stock-keeping unit, 1 to 64 characters with no spaces: AB-1234-XL. |
Ean13 |
A GTIN-13, the European article number (GS1), its check digit passing: 4006381333931. |
UpcA |
A GTIN-12, the universal product code (GS1), its check digit passing and its leading zero kept: 036000291452. |
Isbn |
An ISBN (ISO 2108) in its 13 digits with no hyphens, its check digit passing: 9780306406157. |
Sscc |
A serial shipping container code (GS1), 18 digits, its check digit passing: 106141412345678908. |
Barcode |
What a barcode encodes, by its symbology: a GS1 retail code, Code 128's printable ASCII or a QR code's ISO 8859-1 text. |
UnitQuantity |
How much of something an order line or a stock count holds: a count of items, or an amount by mass, volume, length or area, never below 0. |
Rating |
A rating on its own scale (schema.org): its value, from its worst to its best, the best above the worst. |
ClothingSize |
A clothing size in its system, written as a label writes it: UK 10, US M. |
ClothingSizeSystem |
The system a clothing size is in, written as its code: UK, EU, US. |
ShoeSize |
A shoe size in its system, written as a box writes it: UK 7.5, EU 42. |
ShoeSizeSystem |
The system a shoe size is in, written as its code: UK, EU, US. |
Dimensions |
A box's length, width and height, none below 0. |
HsCode |
A Harmonized System commodity code (WCO), six to ten digits with no dots: 090111. |
Incoterm |
A rule of ICC's Incoterms 2020, written as its code, FOB. |
TrackingNumber |
A parcel's tracking number with its carrier, written UPSN 1Z999AA10123456784. |
Carrier |
A shipping carrier by its Standard Carrier Alpha Code (NMFTA), two to four capitals: UPSN. |
ContainerNumber |
An intermodal container's number (ISO 6346), its check digit passing: CSQU3054383, printed CSQU 305438 3. |
LotNumber |
A manufacturing batch or lot (GS1 AI 10), up to 20 of GS1's characters: ABC123. |
SerialNumber |
An item's serial number (GS1 AI 21), up to 20 of GS1's characters: SN-0042a. |
Vin |
A vehicle identification number (ISO 3779), 17 characters with no I, O or Q: 1HGCM82633A004352. |
VehicleRegistration |
A vehicle's registration mark with its country, written GB AB12 CDE, the mark kept as its plate shows it. |
Time and calendar
| Type | What it is |
|---|---|
Instant |
One moment for everyone, written 2026-10-25T09:30:00Z. |
CalendarDate |
A calendar day with no time or zone, written 2026-10-25. |
ZonedTime |
An instant seen in a zone, written 2026-10-25T09:30:00+00:00[Europe/London]. |
Duration |
A length of time, exact to the millisecond, written PT1H30M. |
Weekday |
A day of the week. |
LocalTime |
A clock time with no date or zone, to the second, written 09:30:00: hour from 0 to 23, minute and second from 0 to 59. |
LocalDateTime |
A date and a clock time with no zone, written 2026-10-25T09:30:00: not one moment until a zone is chosen. |
Month |
A month of the year. |
YearMonth |
A month of a year, written 2026-10: month from 1 to 12. |
Year |
A calendar year, written 2026, from 0 to 9999. |
Quarter |
A quarter of a calendar year, written 2026-Q4: quarter from 1 to 4. |
IsoWeek |
A week of an ISO 8601 week-numbering year, written 2026-W43: week from 1 to 52, or 53 in a year that has one. |
UtcOffset |
An offset from UTC in minutes, written +05:30, from 18 hours behind to 18 hours ahead. |
DateRange |
The days from start to end, both included, written 2026-10-01/2026-10-31. |
InstantRange |
The instants from start up to but not including end, written 2026-10-25T09:00:00Z/2026-10-25T17:00:00Z. |
CalendarPeriod |
An amount of calendar time in whole years, months and days, written P1Y2M10D: unlike a Duration, a month is a month, however many days it has. |
RecurrenceRule |
When something recurs (RFC 5545): its first occurrence as a local time in its zone, a line feed, then its rule: DTSTART;TZID=Europe/London:20261026T093000\nRRULE:FREQ=WEEKLY;BYDAY=MO. |
OpeningHours |
When a place is open each week and the days that differ, read by the clock in its zone (OpenStreetMap's opening_hours): Mo-Fr 09:00-17:30; Sa 10:00-16:00; 2026 Dec 25 off [Europe/London]. |
CalendarEvent |
A calendar event (RFC 5545's VEVENT): an all-day event's first and last days, both included, or a timed event's local start and end and its zone, never both, with what it is called and, where it has them, where it is, what it is about and how it repeats. |
Physical quantities
| Type | What it is |
|---|---|
Length |
A length or distance, held in metres to 6 places, written 5km, 45cm, 3inch or 2metre; m is minutes. |
Area |
An area, held in square metres to 6 places, written 12sqm or 2ha; a Length times a Length. |
Volume |
A volume, held in cubic metres to 9 places, written 500ml or 2litre; an Area times a Length. |
Angle |
An angle, held in radians to 9 places, written 90deg or 1.5rad. |
Mass |
A mass, held in kilograms to 9 places, a microgram, written 250g, 2.5kg or 500mcg. |
Pressure |
A pressure, held in pascals to 3 places, written 1013hPa. |
Energy |
Energy, held in joules to 3 places, written 2kWh or 250kcal. |
Power |
Power, held in watts to 3 places, written 3kW. |
Temperature |
A temperature, held in kelvin to 3 places, written 21degC, 70degF or 300kelvin. |
TemperatureDifference |
The difference between two temperatures, held in kelvin to 3 places: a Temperature minus a Temperature, or units.of. |
Speed |
A speed, held in metres per second to 6 places, written 30mph or 100kmh; a Length over a Duration. |
Frequency |
A frequency, held in hertz to 3 places, written 50Hz or 2.4GHz. |
Voltage |
A voltage, held in volts to 6 places, written 230V. |
Current |
An electric current, held in amperes to 6 places, written 500mA. |
Illuminance |
Illuminance, held in lux to 3 places, written 500lx. |
SoundLevel |
A sound level, held in decibels to 2 places, written 60dB. |
Concentration |
A mass in a volume, held in kilograms per cubic metre to 9 places, written 5mgL or 1gL; a Mass over a Volume. |
Maths and data
| Type | What it is |
|---|---|
Percentage |
A proportion where 0.20 is 20%, written 20%: held as the exact fraction, shown as the reader's locale writes a percentage. |
Ratio |
One number to another as written, 16:9: 16:9 and 32:18 are two values. |
Fraction |
An exact rational number as written, 3/4: 1/2 and 2/4 are two values. |
Range |
The values of one ordered type from start up to but not including end, either of them none for an open end, written 2026-10-01/... |
DataSize |
An amount of data, held in whole bytes, written 5MB or 4KiB. |
Bitrate |
Data per second, held in whole bits per second, written 100Mbps; a DataSize over a Duration. |
Vector |
A list of 1 to 16,000 numbers, each a single-precision float, as a model's embedding is. |
Embedding |
A vector with the model that made it, since vectors from different models can't be compared. |
Health
| Type | What it is |
|---|---|
BloodType |
A person's blood group, ABO and RhD, written O-: health data. |
Icd10Code |
A diagnosis's ICD-10 code (WHO), with its dot: I21.9. |
SnomedConcept |
A SNOMED CT concept's identifier, its Verhoeff check digit passing: 22298006. |
Dose |
An amount of a medicine, by mass or by volume, above nothing. |
DosageInstruction |
How to take a medicine (FHIR's Dosage): a dose, a route, at least once in a period above nothing, and whether only when needed. |
RouteOfAdministration |
How a medicine is taken (EDQM's Standard Terms), written as its own name, oral, and shown as EDQM words it, "Oral use". |
HeartRate |
A heart rate (LOINC 8867-4), a Frequency from 0 to 300 beats a minute, written 72bpm and shown 72 bpm. |
BloodPressure |
A blood pressure (LOINC 85354-9): its systolic and diastolic Pressures, the diastolic below the systolic. |
BloodGlucose |
A blood glucose level, a Concentration never below 0: units.of(5.5, ConcentrationUnit.millimole_of_glucose_per_litre), shown 5.5 mmol/L. |
Allergen |
One of the 14 allergens a food label must name (UK FIR 2014 and EU Regulation 1169/2011, Annex II), written as its own name, milk, and shown as the Food Standards Agency words it. |
Media and visual
| Type | What it is |
|---|---|
Colour |
A colour in sRGB with its alpha, each channel from 0 to 255, written #1e6fd9, or #1e6fd980 when it isn't opaque. |
ImageDimensions |
An image's width and height in whole pixels, written 1920x1080, each from 1 to 2,147,483,647. |
AspectRatio |
Width to height in whole numbers, written 16:9: 16:9 and 32:18 are two values. |
Rect |
A rectangle by its top-left corner and its size, never negative, written as SVG writes a viewBox: 0 0 300 200. |
Insets |
Space inside each edge (the CSS box model), never negative, written in CSS's order: 8 16 8 16. |
PaperSize |
A paper size: ISO 216's A and B series and the US letter, legal and tabloid, written A4, Letter. |
ExifOrientation |
How a stored image is turned to be seen upright (EXIF 2.32's orientation), named for where its first row and column are seen and written as EXIF's value: top_left is 1, right_top is 6. |
AltText |
What an image shows, for someone who can't see it (WCAG 2.2's text alternative): one line of 1 to 1,000 characters. |
FrameRate |
Frames a second as an exact fraction, written 30000/1001 for 29.97 and 25/1 for 25: both parts at least 1, held as written. |
VideoResolution |
A video's frame size in pixels, written 1920x1080: by its pixels, not a name like "4K". |
VideoCodec |
A video codec as the W3C WebCodecs Codec Registry names it (RFC 6381's form): avc1.42001E, vp09.00.10.08. |
AudioCodec |
An audio codec as the W3C WebCodecs Codec Registry names it (RFC 6381's form): mp4a.40.2, opus. |
Timecode |
A frame's SMPTE ST 12-1 address: hours, minutes, seconds and frames at rate, counted drop-frame or not. |
SubtitleCue |
A timed caption (WebVTT): when it starts and ends from the start of the media, its end after its start, and its text, written as the cue's timings line and text: 00:00:01.000 --> 00:00:04.000 and a line feed. |
ContentRating |
An age rating by the body that gave it, written BBFC 12A: rating is one of scheme's categories. |
ContentRatingScheme |
A body that rates films or games for age, written as it writes its name: BBFC, MPA, PEGI, ESRB. |
Web and network
| Type | What it is |
|---|---|
Url |
An http:// or https:// URL with a host. |
UrlPath |
A URL's path (RFC 3986): / and its segments, with no query or fragment, /products/42. |
RelativeUrl |
A relative reference (RFC 3986): a path, a query or a fragment, or a host after //, with no scheme: ../images/logo.png, ?page=2. |
Slug |
A URL-safe identifier: lower-case letters and digits in words joined by single hyphens, autumn-sale, as text.slug writes one. |
DomainName |
A domain name (IDNA 2008 by UTS 46), lower case, each label beyond ASCII as its A-label, with no dot at the end: xn--mnchen-3ya.de. |
Hostname |
A host (RFC 3986): a domain name, or an IP address as IpAddress writes it, an IPv6 address without brackets. |
WebOrigin |
A web origin (RFC 6454): http or https, the host, and a port only where it isn't the scheme's default: https://example.com, http://localhost:8080. |
HttpMethod |
An HTTP method (RFC 9110), one a route is written with, written as its token, GET. |
HttpStatus |
An HTTP response's status code (RFC 9110), from 100 to 599. |
HttpHeaderName |
An HTTP field name (RFC 9110), a token in lower case: content-type. |
FileType |
A file's IANA media type, written image/png. |
UserAgent |
What an HTTP client says it is (RFC 9110's User-Agent): products and comments, curl/8.7.1. |
ProblemDetails |
An HTTP API's error body (RFC 9457): what kind of problem it is (about:blank when none), the status, a short title, a detail for people and the URL of this occurrence, each of which may be none. |
JsonPointer |
A pointer into a JSON document (RFC 6901): /foo/0, with ~0 for ~ and ~1 for /, and empty for the whole document. |
Cookie |
A cookie as a server sets it (RFC 6265 and RFC 6265bis's SameSite): its name and value, then its attributes after ; in the RFC's order and spelling, SID=31d4d96e; Path=/; Secure; HttpOnly. |
UtmParameters |
Where a visit came from (Google Analytics' UTM parameters): written as the query that carries them, utm_source=mailing&utm_medium=email&utm_campaign=autumn_sale; the term and the content only where a campaign uses them. |
IpAddress |
An IPv4 or IPv6 address. |
Cidr |
An address range (RFC 4632 and RFC 4291): its first address as IpAddress writes it, / and the prefix's length, every bit after the prefix zero: 192.0.2.0/24, 2001:db8::/32. |
NetworkPort |
A TCP or UDP port (IANA), from 1 to 65535. |
MacAddress |
A hardware address (IEEE 802's EUI-48) in IEEE's form, six pairs of upper-case hexadecimal digits joined by -: AC-DE-48-00-00-80. |
Imei |
A mobile device's IMEI (3GPP TS 23.003): 15 digits, its Luhn check digit passing. |
Emoji |
One emoji (UTS #51), fully qualified, as Unicode's list writes it: a red heart is U+2764 U+FE0F. |
PushToken |
A device's push notification token, from Apple's or Google's service, opaque. |
Software
| Type | What it is |
|---|---|
SemanticVersion |
A version (SemVer 2.0.0), written 1.2.3-alpha.1+build.5: ordered by its precedence, which ignores the build metadata. |
VersionRange |
A range of versions (node-semver's grammar in one spelling): ^1.2.3, >=1.0.0 <2.0.0, 1.2.x || >=2.5.0-beta.1. |
GitRef |
A git ref name (git check-ref-format --allow-onelevel): a branch, a tag, a full ref or a commit's hash, main, refs/tags/v1.2.0. |
PackageUrl |
A package URL (ECMA-427) in its canonical form: pkg:npm/%40angular/animation@12.3.1. |
Cve |
A CVE record's id (the CVE programme's ID syntax): CVE-2021-44228. |
SpdxLicence |
An SPDX licence expression, each identifier as the SPDX licence list spells it: MIT OR Apache-2.0. |
TraceId |
A trace's id (W3C Trace Context): 32 lower-case hexadecimal digits, not all zero. |
SpanId |
A span's id (W3C Trace Context): 16 lower-case hexadecimal digits, not all zero. |
TraceParent |
A traceparent header's value (W3C Trace Context, version 00): 00-<trace id>-<span id>-<flags>. |
LogLevel |
How severe a log record is (OpenTelemetry's severities), written as its short name, INFO. |
FilePath |
A portable path, names joined by /, absolute after a leading /, in its shortest form: /var/lib/acme/uploads, ../shared/logo.png. |
FileName |
A file's name every common file system takes: no / or \, none of Windows' reserved characters or device names, at most 255 bytes: report.pdf. |
RegularExpression |
A regular expression: matched whole, in linear time, with no backreferences or lookaround: [A-Z]{2}[0-9]{2}. |
ContainerImage |
A container image reference (the OCI distribution reference), fully qualified: its registry, its repository in lower case, and a tag, a digest or both: docker.io/library/nginx:1.27. |
Digest |
A content digest (the OCI image specification): its algorithm, : and the encoded hash, sha256: and 64 lower-case hexadecimal digits. |
Uuid |
A UUID, written in lowercase hexadecimal with hyphens. |
Ulid |
A ULID (the ULID specification): 26 characters of Crockford's base 32 in upper case, 01ARZ3NDEKTSV4RRFFQ69G5FAV. |
IdempotencyKey |
A request's idempotency key (the IETF's Idempotency-Key): 1 to 255 printable ASCII characters, no " or \. |
Doi |
A digital object identifier (the DOI Handbook), with no resolver before it and ASCII letters in lower case: 10.1038/nphys1170. |
Text formats
| Type | What it is |
|---|---|
Markdown |
CommonMark text, with no control character but a tab, a line feed or a carriage return; markup.to_html renders it as Html. |
Html |
HTML that is always safe to write into a page or an email: building one from text keeps only the allowed elements and attributes, with no scripts, no event handlers and links only to https: and mailto:, so it never fails; a literal must already be what it keeps. |
RichText |
A structured document: its blocks in order, as Portable Text holds one, each a paragraph, a heading, a quote or a list item, with nothing nested; markup.rich_to_html writes it as Html. |
LocalisedText |
Text in several locales, sent as JSON-LD sends a language map, {"en-GB": "Rye loaf", "fr-FR": "Pain de seigle"}; text.pick reads the entry for a locale. |
RichTextBlock |
One block of a RichText: a heading's level is 1 to 6, a list item's 1 to 9, how deep it sits. |
RichTextSpan |
A run of text in a block, never empty, with no control character but a tab or a line feed (a line break); its marks; and the address it links to, if any: https: with a host, or mailto:. |
RichTextMark |
A mark on a span of text, Portable Text's decorators. |
Security
| Type | What it is |
|---|---|
Password |
A password as a person types it (NIST SP 800-63B): 8 to 256 characters, none a control character. |
PasswordHash |
A password's hash (crypto.hash_password): the PHC string of Argon2id, $argon2id$v=19$m=19456,t=2,p=1$<salt>$<hash>, which a sign-in checks a password against. |
PasswordPolicy |
The rules a password must meet (NIST SP 800-63B): the fewest characters, from 8 (15 where a password is the only factor), the most, at least 64, and whether a new password is checked against a list of breached ones. |
Hash |
A SHA-256 digest (FIPS 180-4): the 32 bytes hash.sha256 gives, so Hash(hash.sha256(body)) builds one. |
Hmac |
An HMAC-SHA-256 tag (RFC 2104): the 32 bytes crypto.hmac gives, a webhook's signature among them. |
Jwt |
A signed token (RFC 7519) in JWS compact form, three parts of unpadded Base64url joined by ., at most 8,192 characters; an unsecured token, with no signature, is never one. |
JwtClaims |
A token's registered claims (RFC 7519 §4.1), once crypto.verify_jwt has checked its signature, times, issuer and audience: aud is a list, and exp always there. |
Jwk |
A public key a token is checked against (RFC 7517, RFC 7518 and RFC 8037), one of three kinds by its kty: OKP, an Ed25519 key, crv Ed25519 and x; RSA, n and e, its modulus 2,048 to 4,096 bits; or EC, a P-256 key, crv P-256, x and y, a point on the curve; each in unpadded Base64url, used with one algorithm, EdDSA, RS256 or ES256, with an optional key id and certificates (x5c, each standard Base64 DER); use_ is sent as use, and key_ops holds the operations it may be used for, a key without verify checking no token. |
PublicKey |
An Ed25519 public key (RFC 8032), its 32 bytes as unpadded Base64url, 11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo: not secret, so it may be read, stored and sent. |
Certificate |
An X.509 certificate (RFC 5280), read from its PEM with text.parse or json.read: its subject and issuer as RFC 4514 writes them, its serial number in hexadecimal, the first and last instants it is valid at, the SHA-256 of its DER, and the DER. |
TotpSecret |
An authenticator's shared secret (RFC 6238): 16 to 64 bytes as RFC 4648 Base32 in upper case, unpadded. |
OneTimeCode |
The code a person types from an authenticator app, a text message or an email (RFC 4226 and RFC 6238): six to eight digits, a leading zero kept. |
ApiKey |
A key for an API: 1 to 512 printable ASCII characters with no spaces. |
SecretText |
Any other secret text: 1 to 8,192 characters. |
BearerToken |
An access token sent as Authorization: Bearer (RFC 6750's b64token), at most 8,192 characters. |
OAuthScope |
An OAuth scope (RFC 6749 §3.3): one scope-token of printable ASCII but the space, " and \, todos:read. |
OidcClaims |
Who an identity provider says signed in (OpenID Connect Core 1.0 §5.1): the subject and the standard claims a sign-in reads, each by its own name. |
WebAuthnCredential |
A passkey a person registered (W3C WebAuthn), as webauthn-rs keeps one: its credential ID, its public key as a COSE_Key in CBOR, its signature counter, the transports it says it can be reached by, whether it may be and is backed up, the name the person gave it, and when it was made and last used. |
EncryptedValue |
A value sealed by crypto.encrypt: its version, algorithm, key identity, nonce, ciphertext and tag. |
PasswordCheck |
What checking a password against its hash says (crypto.verify_password): correct_outdated is correct against a hash made with older parameters, so store a fresh one. |
Travel
| Type | What it is |
|---|---|
IataAirport |
An airport's IATA code, three capitals: LHR. |
IcaoAirport |
An airport's ICAO location indicator, four capitals: EGLL. |
IataAirline |
An airline's IATA designator, two characters: BA. |
FlightNumber |
A flight's designator (IATA's SSIM), written BA123: its airline, its number from 1 to 9999 and any suffix. |
CabinClass |
The cabin a seat is sold in, written as its own name, premium_economy. |
BookingReference |
A booking's record locator (IATA's passenger name record), six capitals and digits: X7K9QZ. |
Other with a published standard
| Type | What it is |
|---|---|
UnNumber |
A dangerous good's UN number (the UN Model Regulations): UN1203, printed UN 1203. |
Orcid |
A researcher's ORCID iD, its ISO 7064 check character passing: 0000-0002-1825-0097. |
CefrLevel |
A level of the Common European Framework of Reference for Languages, written B2. |
Mpan |
A UK electricity supply's MPAN core (Elexon), 13 digits, its check digit passing: 1200012345679. |
Mprn |
A UK gas supply's meter point reference number (Xoserve), 6 to 10 digits: 1234567. |
EpcRating |
An energy performance certificate's band (the UK's EPC), written C. |
Tenure |
How land in England and Wales is held (HM Land Registry), written as its own name, freehold. |
LawfulBasis |
A lawful basis for processing personal data (GDPR Article 6(1)), written as its own name, legitimate_interests. |
Jurisdiction |
Where a law applies (ISO 3166): a country or one of its subdivisions. |
ModelId |
An AI model by its provider and name, written meta-llama/Llama-3.1-8B-Instruct. |
AI
| Type | What it is |
|---|---|
TokenCount |
How many tokens a prompt or an answer holds, by its model's tokenizer: a whole number from 0. |
TokenUsage |
The tokens one call to a model used: what it read, what it wrote, and how many of those it read its provider's cache served, where it says. |
ChatMessage |
One message in a conversation with a model: who wrote it and what it says, sent {"role": "user", "content": "..."}. |
ChatRole |
Who wrote a message in a conversation with a model. |
Markdown for agents: /docs/types.md.Built from Jadpo main at e00e61f.