Adds addressRegion to the address claim table for international addresses #305
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CoralSmith
reviewed
Dec 11, 2024
| @@ -296,6 +296,7 @@ Each JSON object in the list may contain any of the following properties: | |||
| | `addressLocality` | Maps to `POST_TOWN` in the [Postcode Address File][external.postcode-file] and [Ordnance Survey Places API][external.os-places-api]. | | |||
| | `postalCode` | Maps to `POST_CODE` in the [Postcode Address File][external.postcode-file] and [Ordnance Survey Places API][external.os-places-api]. | | |||
| | `addressCountry` | Two-letter [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). | | |||
| | `addressRegion` | The region in which the locality is, and which is in the country, provided as text. For example, California, or another appropriate first-level Administrative division. | | |||
There was a problem hiding this comment.
Could we include something to say that it aligns to https://schema.org/addressRegion? eg.
Suggested change
| | `addressRegion` | The region in which the locality is, and which is in the country, provided as text. For example, California, or another appropriate first-level Administrative division. | | |
| | `addressRegion` | The region in which the locality is, and which is in the country, provided as text. For example, California, or another appropriate first-level Administrative division. This maps to [schema:addressRegion](https://schema.org/addressRegion) | |
Caitlin-cooling
force-pushed
the
international-addresses
branch
from
ab2ae80 to
55645e7
Compare
philf999
previously approved these changes
Dec 12, 2024
SteveEvans-GDS
requested changes
Dec 12, 2024
source/integrate-with-integration-environment/prove-users-identity.html.md.erb
Outdated
Show resolved
Hide resolved
Co-authored-by: SteveEvans-GDS <[email protected]>
source/integrate-with-integration-environment/prove-users-identity.html.md.erb
Show resolved
Hide resolved
SteveEvans-GDS
approved these changes
Dec 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Do not merge this PR until we've got approval from the policy board that we can go ahead
Why
To ensure the docs about VCs reflect changes for international addresses
What
Adding
addressRegionto address claim tableTechnical writer support
Yes
How to review
Changes can be viewed locally at http://localhost:4567/integrate-with-integration-environment/prove-users-identity/#understand-your-user-s-address-claim
Confirm