opds-community / drafts

Contains all the current drafts for the OPDS specifications
36 stars 10 forks source link

Server description #6

Open leonardr opened 5 years ago

leonardr commented 5 years ago

This is one of a series of proposals for taking NYPL's extensions to Authentication For OPDS and adding them to the core document.

https://github.com/NYPL-Simplified/Simplified/wiki/Authentication-For-OPDS-Extensions#server-description


An OPDS server may use the service_description extension to describe itself. This is distinct from the standard description field, which is to be used to describe the text prompt displayed to the authenticating user.

 "service_description": "Here you can get all sorts of free books!",

This is useful for discovery; it explains to users why they would want to connect to one OPDS server versus another.