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

Required use of labels and other UI strings in Auth Services #2112

Closed
tomcrane opened this issue Mar 15, 2022 · 3 comments
Closed

Required use of labels and other UI strings in Auth Services #2112

tomcrane opened this issue Mar 15, 2022 · 3 comments
Labels
auth Ready-for-Eds Editorial changes ready for Editorial review
Milestone

Comments

@tomcrane
Copy link
Contributor

From @ksclarke in Slack:

From the properties table at https://iiif.io/api/auth/1.0/#service-description it looks like label is required. But once one gets down to the Kiosk and External patterns we see:

There is no user interaction before opening the access cookie service URI, and therefore any of the label, header, description and confirmLabel properties are ignored if present.

The JSON examples have label and the other recommended but ignored properties. What's the point of making label required (and the others recommended) if the clients are instructed to ignore it/them?

@id for instance has a description that prescribes use for particular types of services: It is required with the Login, Clickthrough, or Kiosk patterns, in which the client opens the URI in order to obtain an access cookie.

@tomcrane tomcrane added the auth label Mar 15, 2022
@tomcrane tomcrane added this to the Auth 2.0 milestone Mar 15, 2022
@tomcrane
Copy link
Contributor Author

For Auth 2, the presence of these fields in the examples is now confined to the interactive profile example.

Further, in b0e1101, text has been added to the table to qualify use of these properties.

@tomcrane
Copy link
Contributor Author

Included in #2127

@tomcrane tomcrane added the Ready-for-Eds Editorial changes ready for Editorial review label Oct 25, 2022
@zimeon
Copy link
Member

zimeon commented Jun 6, 2023

Resolved. In Auth 2.0 the additional labels are defined only for the active interaction pattern: https://iiif.io/api/auth/2.0/#active-interaction-pattern

@zimeon zimeon closed this as completed Jun 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auth Ready-for-Eds Editorial changes ready for Editorial review
Projects
Status: Done
Development

No branches or pull requests

2 participants