api icon indicating copy to clipboard operation
api copied to clipboard

Required use of labels and other UI strings in Auth Services

Open tomcrane opened this issue 2 years ago • 2 comments

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 avatar Mar 15 '22 13:03 tomcrane

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

Further, in https://github.com/IIIF/api/commit/b0e1101b64a7c5cb0de0e14316b9857191cdf0da, text has been added to the table to qualify use of these properties.

tomcrane avatar Aug 16 '22 13:08 tomcrane

Included in https://github.com/IIIF/api/pull/2127

tomcrane avatar Aug 16 '22 14:08 tomcrane

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 avatar Jun 06 '23 16:06 zimeon