📐 Address schemas

Address schemas provide strict reusable address fragments and the query contract for the address lookup endpoint.

Inventory

Export	Request location	Contract
address	N/A	Optional array of string address lines.
postalCode	N/A	Optional string postal code.
prefecture	N/A	Optional string or null prefecture.
city	N/A	Optional string city.
country	N/A	Optional string country.
addressJPSchema	N/A	Optional Japanese address components.
partialPostalCodeQueryParameter	Query	Required partial or full Japanese postal code.
findAddressSchema	Query	Lookup request schema.

Details

address

Definition

address is a strict object with no required fields.

Location	Field	Type	Required	Constraints
N/A	address	string[]	No	Every array item is a string.

additionalProperties is false.

Used by route: None directly. Used by feature: None directly.

View complete source

export const address: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {address: {items: {type: 'string'}, type: 'array'}},
  type: 'object',
};

---

postalCode

Definition

Location	Field	Type	Required	Constraints
N/A	postalCode	string	No	No pattern is imposed.

additionalProperties is false.

Used by route: None directly. Used by feature: None directly.

View complete source

export const postalCode: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {postalCode: {type: 'string'}},
  type: 'object',
};

---

prefecture

Definition

Location	Field	Type	Required	Constraints
prefecture	N/A	string | null	No	Null is accepted.

additionalProperties is false.

Used by route: None directly. Used by feature: None directly.

View complete source

export const prefecture: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {prefecture: {type: ['string', 'null']}},
  type: 'object',
};

---

city

Definition

Location	Field	Type	Required	Constraints
N/A	city	string	No	City name.

additionalProperties is false.

Used by route: None directly. Used by feature: None directly.

View complete source

export const city: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {city: {type: 'string'}},
  type: 'object',
};

---

country

Definition

Location	Field	Type	Required	Constraints
N/A	country	string	No	Country name.

additionalProperties is false.

Used by route: None directly. Used by feature: None directly.

View complete source

export const country: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {country: {type: 'string'}},
  type: 'object',
};

---

addressJPSchema

Definition

Location	Field	Type	Required	Constraints
N/A	city	string	No	City name.
N/A	country	string	No	Country name.
N/A	postalCode	string	No	Postal code.
N/A	prefecture	string	No	Prefecture name.
N/A	street	string	No	Street address.

additionalProperties is false; the schema has no required fields.

Used by route: None directly. Used by feature: None directly.

View complete source

export const addressJPSchema: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {
    city: {type: 'string'},
    country: {type: 'string'},
    postalCode: {type: 'string'},
    prefecture: {type: 'string'},
    street: {type: 'string'},
  },
  type: 'object',
};

---

partialPostalCodeQueryParameter

Definition

Location	Field	Type	Required	Constraints
Query	postalCode	string	Yes	Matches ^\d{3}-?\d{0,4}$.

Spread by findAddressSchema. Used by route: findAddressRoute. Used by feature: findAddressFeature.

View complete source

export const partialPostalCodeQueryParameter: OpenAPIParameter = {
  in: 'query',
  name: 'postalCode',
  required: true,
  schema: {pattern: '^\\d{3}-?\\d{0,4}$', type: 'string'},
};

---

findAddressSchema

Definition

Uses the required postalCode query parameter.

Location	Field	Type	Required	Constraints
Query	postalCode	string	Yes	Matches ^\d{3}-?\d{0,4}$; accepts three digits, an optional hyphen, and zero to four additional digits.

Used by route: findAddressRoute. Used by feature: findAddressFeature.

View complete source

export const findAddressSchema = withSchema({
  parameters: [partialPostalCodeQueryParameter],
});

---