Draft
Conversation
Change property description for name to reflect meaning of validFrom
| | Property | Description | | ||
| |-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `name` | A list showing the name proven by GOV.UK One Login. At the moment the list will only contain the user’s current name. In the future this list will reflect name changes by using the `validFrom` and `validUntil` metadata properties. If `validUntil` is `null` or not present, that name is your user’s current name. If `validFrom` is `null` or not present, your user may have used that name from birth. <br><br> Each name is presented as an array in the `nameParts` property. Each part of the name is either a `GivenName` or a `FamilyName`, identified in its `type` property. The `value` property could be any text string. GOV.UK One Login cannot specify a maximum length or restrictions on what characters may appear. <br><br> `GivenName` or `FamilyName` can appear in any order within the list. The order of names may depend on either your user’s preferences or the order they appear on documents used to prove your user’s identity. | | ||
| | `name` | A list showing the name proven by GOV.UK One Login, this will only contain the user’s current name. If `validUntil` is present then this date reflects the earliest date we have evidence for the name. Each name is presented as an array in the `nameParts` property. Each part of the name is either a `GivenName` or a `FamilyName`, identified in its `type` property. The `value` property could be any text string. GOV.UK One Login cannot specify a maximum length or restrictions on what characters may appear. <br><br> `GivenName` or `FamilyName` can appear in any order within the list. The order of names may depend on either your user’s preferences or the order they appear on documents used to prove your user’s identity. | |
Contributor
There was a problem hiding this comment.
@erino I think that the second sentence should start, "If 'valifFrom' is present...." since we are only sending current name, validUntil should never provided?
Contributor
There was a problem hiding this comment.
@erino we should also add an entry to the changelog https://github.com/govuk-one-login/tech-docs/blob/main/source/partials/_changelog.erb
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Why
Explain why these changes are necessary.
What
Describe the changes you're proposing.
Technical writer support
Do you need a tech writer's support, for example to review your PR?
How to review
Tell reviewers how to assess your changes.
Changelog
If this change is significant (for example, launching a new feature or deprecating a feature), you should update the changelog found at
partials/_changelog.erbunder the heading 'Documentation updates'.Confirm