Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Maintenance Iteration 22 - typos and formatting #472

Open
nils-work opened this issue Dec 20, 2024 · 13 comments
Open

Maintenance Iteration 22 - typos and formatting #472

nils-work opened this issue Dec 20, 2024 · 13 comments
Labels
enhancement New feature or request
Milestone

Comments

@nils-work
Copy link
Member

This change request has been created to simplify the raising of typos and formatting changes in Maintenance Iteration 22.

If the change has a real impact on readability and clarity it should be posted on the Maintenance Iteration Holistic Feedback issue for the community's visibility.

Maintenance Iteration 22

  • Holistic Feedback issue:
    • TBC
  • Decision Proposal:
    • TBC
@nils-work nils-work added the enhancement New feature or request label Dec 20, 2024
@nils-work
Copy link
Member Author

Remove bold on the '(optional)' statement, add bullets for the two JwksUri points:
image

@nils-work
Copy link
Member Author

Replace two instances of (ie. with (i.e.

@nils-work
Copy link
Member Author

nils-work commented Dec 20, 2024

Update value style in the sentence:

True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true,

true if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true,

@nils-work
Copy link
Member Author

Correct typo in description referring to hasCentralProtectionAndControl to hasCentralProtectionControl.

@nils-work nils-work added this to the v1.34.0 milestone Dec 20, 2024
@nils-work
Copy link
Member Author

Resolve local build script message (from running /slate/run.sh):

Please add the following to your Gemfile to avoid polling for changes:
gem 'wdm', '>= 0.1.0' if Gem.win_platform?

@nils-work
Copy link
Member Author

Adjust positioning and size of tooltips for referenced specifications.

@nils-work
Copy link
Member Author

nils-work commented Jan 15, 2025

Replace four instances of e-mail with email for consistency.

@nils-work
Copy link
Member Author

Apply bold style to keywords: MAY, SHOULD, MUST, MUST NOT, etc.

@nils-work
Copy link
Member Author

Continuation of changes from previous MI issue, changing remaining -

  • "must play back" to "MUST play back" in x-fapi-interaction-id header description
  • "data holder must respond with a 406 Not Acceptable" to "data holder MUST respond with a 406 Not Acceptable" in x-v and x-min-v header descriptions

@nils-work
Copy link
Member Author

Display default parameter and property values in schema tables to improve awareness/visibility.

nils-work added a commit that referenced this issue Jan 15, 2025
nils-work added a commit that referenced this issue Jan 15, 2025
nils-work added a commit that referenced this issue Jan 15, 2025
nils-work added a commit that referenced this issue Jan 15, 2025
nils-work added a commit that referenced this issue Jan 15, 2025
nils-work added a commit that referenced this issue Jan 15, 2025
@nils-work
Copy link
Member Author

nils-work commented Jan 16, 2025

Replace 'data holder' and 'register' in the respective x-v and x-min-v header statements with 'endpoint' to make common statements. e.g.,:

  • "The data holder SHOULD" --> "The endpoint SHOULD"
  • "The Register SHOULD" --> "The endpoint SHOULD"
  • "If all versions requested are not supported then the data holder" --> "If all versions requested are not supported then the endpoint"
  • "If all versions requested are not supported then the Register" --> "If all versions requested are not supported then the endpoint"

@nils-work
Copy link
Member Author

Update the descriptions of the Get Data Holder Brands parameters to align to other endpoints:
From:

page: The page number to return.
page-size: The number of records to return per page.

to:

page: Page of results to request (standard pagination).
page-size: Page size to request. Default is 25 (standard pagination).

@nils-work
Copy link
Member Author

Replace variations of the x-v response header description:

The version of the API endpoint that the holder has responded with.

The version of the API endpoint that the data holder has responded with.

The version of the API endpoint that the CDR Register has responded with.

with:

The payload version that the endpoint has responded with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant