Skip to content

Commit

Permalink
Initial registry for reasons
Browse files Browse the repository at this point in the history
  • Loading branch information
HadrienGardeur authored Jan 20, 2024
1 parent 82369e3 commit 958a9be
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions reason.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Reasons

This document serves as the official registry of reasons for the OPDS and ODL specifications.

Reasons are meant to convey why a particular resource is available/unavailable, either at a publication, link or license level.

| URL | Description | Associated states |
| ---- | ---------- | ----------------- |
| https://registry.opds.io/reason#exhausted | Indicates that a publications and/or all of the usage allowed by its licenses have been exhausted. | `unavailable` |
| https://registry.opds.io/reason#expired | Indicates that a publications and/or all of its licenses have expired. | `unavailable` |
| https://registry.opds.io/reason#onHold | Indicates that a publication is temporarily unavailable because it's on hold. | `unavailable` or `reserved` |
| https://registry.opds.io/reason#preordered | Indicates that a publication is temporarily unavailable because it hasn't been released yet. | `unavailable` |
| https://registry.opds.io/reason#refunded | Indicates that a publication or one of its licenses has been refunded. | `unavailable` |
| https://registry.opds.io/reason#removed | Indicates that a publication or one of its licenses has been removed from a subscription or from distribution in general. | `unavailable` |

0 comments on commit 958a9be

Please sign in to comment.