Skip to content

Commit

Permalink
doc: update enriched fields
Browse files Browse the repository at this point in the history
  • Loading branch information
felixleo22 committed Mar 6, 2024
1 parent af9c9ba commit c49bf82
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
2 changes: 2 additions & 0 deletions ezunpaywall/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@ Experimental middleware that fetches metadata from the Unpaywall mirror hosted b
+ **ezunpaywall-api-key** : apikey to use ezunpaywall.

## Enriched fields

| Name | Type | Description |
| --- | --- | --- |
| is_oa | Boolean | Is there an OA copy of this resource. |
| journal_is_in_doaj | Boolean | Is this resource published in a DOAJ-indexed journal. |
| journal_is_oa | Boolean | Is this resource published in a completely OA journal. |
| oa_status | String | The OA status, or color, of this resource. |
| updated | String | Time when the data for this resource was last updated. |

### Example :

```bash
Expand Down
10 changes: 10 additions & 0 deletions unpaywall/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ The Unpaywall middleware uses the ``DOI`` found in access events to request Open
+ **unpaywall-on-fail** : Strategy to adopt if an enrichment reaches the maximum number of attempts. Can be either of ``abort``, ``ignore`` or ``retry``. Defaults to ``abort``.
+ **unpaywall-email** : The email to use for API calls. Defaults to ``YOUR_EMAIL``.

## Enriched fields

| Name | Type | Description |
| --- | --- | --- |
| is_oa | Boolean | Is there an OA copy of this resource. |
| journal_is_in_doaj | Boolean | Is this resource published in a DOAJ-indexed journal. |
| journal_is_oa | Boolean | Is this resource published in a completely OA journal. |
| oa_status | String | The OA status, or color, of this resource. |
| updated | String | Time when the data for this resource was last updated. |

### Example

```bash
Expand Down

0 comments on commit c49bf82

Please sign in to comment.