changedInput schema / properties / authorLimit / description
Previous value: -"Maximum number of authors to return per work (1–500, default 25). Ordinary records fit under the default; large-collaboration papers deposit thousands, and a page of them is large enough to exhaust a client context. Each work reports its full deposited total as authorCount — call crossref_get_work with that work doi to page the authors this cap left out."New value: +"Maximum number of authors to return per work (1–500 per call, default 25; a larger value, up to 100000, applies 500 and says so in notice). Ordinary records fit under the default; large-collaboration papers deposit thousands, and a page of them is large enough to exhaust a client context. Each work reports its full deposited total as authorCount — call crossref_get_work with that work doi to page the authors this cap left out."
changedInput schema / properties / authorLimit / maximum
Previous value: -500New value: +100000
changedInput schema / properties / cursor / description
Previous value: -"Cursor token for deep paging. Pass \"*\" to start cursor-based paging (required past ~10K results), then pass the nextCursor value from each response until a response omits it, which means the list is exhausted. Cannot be combined with offset, or with a publication-date sort (published, published-print, published-online), which Crossref does not walk by cursor."New value: +"Cursor token for deep paging. Pass \"*\" to start cursor-based paging (required past ~10K results), then pass the nextCursor value from each response until a response omits it, which means the list is exhausted. A walk with a query term runs by relevance unless sort is set; a walk with filters only runs in Crossref registration order. Relevance scores shift slightly between identical requests, so a relevance walk can repeat or skip a record at a page boundary — sort:\"created\" walks every match without repeats. Cannot be combined with offset, or with a publication-date sort (published, published-print, published-online), which Crossref does not walk by cursor."
changedInput schema / properties / fields / description
Previous value: -"Fields to return (reduces payload). Names are case-sensitive, and each fills one output field: DOI → doi, title → title, type → type, author → authors and authorCount, published / published-print / published-online → published, container-title → containerTitle, publisher → publisher, is-referenced-by-count → isReferencedByCount, score → score, abstract → abstract, volume → volume, issue → issue, page → page, article-number → articleNumber, ISSN → issn. A selected field absent from a work means the record does not deposit it. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work, which also returns the fields this list does not cover (license, funder, references, and the rest of the record)."New value: +"Fields to return (reduces payload). Names are case-sensitive, and each fills one output field: DOI → doi, title → title, type → type, author → authors and authorCount, published / published-print / published-online → published, container-title → containerTitle, publisher → publisher, is-referenced-by-count → isReferencedByCount, score → score, abstract → abstract, volume → volume, issue → issue, page → page, article-number → articleNumber, ISSN → issn, updated-by → updatedBy, update-to → updateTo. A selected field absent from a work means the record does not deposit it. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work, which also returns the fields this list does not cover (license, funder, references, and the rest of the record)."
changedInput schema / properties / fields / items / enum
Previous value: -[
- "DOI",
- "title",
- "type",
- "author",
- "published",
- "published-print",
- "published-online",
- "container-title",
- "publisher",
- "is-referenced-by-count",
- "score",
- "abstract",
- "volume",
- "issue",
- "page",
- "article-number",
- "ISSN"
-]New value: +[
+ "DOI",
+ "title",
+ "type",
+ "author",
+ "published",
+ "published-print",
+ "published-online",
+ "container-title",
+ "publisher",
+ "is-referenced-by-count",
+ "score",
+ "abstract",
+ "volume",
+ "issue",
+ "page",
+ "article-number",
+ "ISSN",
+ "updated-by",
+ "update-to"
+]
changedInput schema / properties / order / description
Previous value: -"Sort direction (asc or desc)"New value: +"Sort direction (asc or desc). Applies only alongside sort; without one it has no effect."
changedInput schema / properties / rows / description
Previous value: -"Number of results to return per page (1–100, default 20)"New value: +"Number of results to return per page (1–100 per call, default 20). A larger value, up to 1000, returns 100 and says so in notice — on an offset page the notice also names the offset that continues after the records returned."
changedInput schema / properties / rows / maximum
Previous value: -100New value: +1000
changedInput schema / properties / sort / description
Previous value: -"Sort field. The publication-date sorts (published, published-print, published-online) work with offset paging only — Crossref refuses them alongside cursor; every other sort works with either."New value: +"Sort field. Omitted, an offset page with a query term is ranked by relevance, and so is a cursor walk with one (sent as score). The publication-date sorts (published, published-print, published-online) work with offset paging only — Crossref refuses them alongside cursor; every other sort works with either."
changedOutput schema / properties / notice / description
Previous value: -"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. On a page carrying records, present when authorLimit cut at least one work list, naming how many and the route to the rest, or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. A page needing more than one caveat carries them all in this one string."New value: +"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. On a page carrying records, present when authorLimit cut at least one work list, naming how many and the route to the rest, or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. On any page, present when rows or authorLimit was above its per-call cap, naming the value requested and the cap applied — on an offset page with records remaining, also the offset that continues after the records returned, with the smaller rows that still fit when a full page there would pass the ~10K offset ceiling. A page needing more than one caveat carries them all in this one string."
addedOutput schema / properties / works / items / properties / updateTo
Added value: +{
+ "description": "Works this record is an update notice for, in the entry shape updatedBy uses and in deposited order. Omitted when the record is not registered as a notice.",
+ "items": {
+ "additionalProperties": false,
+ "description": "Update link",
+ "properties": {
+ "doi": {
+ "description": "DOI on the other side of the link: the notice, in updatedBy; the updated work, in updateTo. It is this work's own DOI when the update was made to this record in place.",
+ "type": "string"
+ },
+ "recordId": {
+ "description": "Retraction Watch record ID. Present only on retraction-watch entries.",
+ "type": "string"
+ },
+ "source": {
+ "description": "Who recorded the link: publisher, or retraction-watch for an entry Crossref carries from the Retraction Watch database",
+ "type": "string"
+ },
+ "type": {
+ "description": "Crossref update type as deposited: correction, erratum, corrigendum, addendum, retraction, withdrawal, expression_of_concern, new_version, new_edition, or another code",
+ "type": "string"
+ },
+ "updated": {
+ "additionalProperties": false,
+ "description": "Date the update was issued",
+ "properties": {
+ "day": {
+ "description": "Day of month",
+ "type": "number"
+ },
+ "month": {
+ "description": "Month (1–12)",
+ "type": "number"
+ },
+ "year": {
+ "description": "Year",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "doi",
+ "type",
+ "source"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
addedOutput schema / properties / works / items / properties / updatedBy
Added value: +{
+ "description": "Update notices Crossref records against this work — corrections, errata, retractions, expressions of concern, withdrawals, new versions — in deposited order. Entries are never merged: the same notice DOI can appear once per source, typed differently by each. Omitted when none is recorded, which does not mean the work was never updated: coverage depends on publisher and Retraction Watch deposits.",
+ "items": {
+ "additionalProperties": false,
+ "description": "Update link",
+ "properties": {
+ "doi": {
+ "description": "DOI on the other side of the link: the notice, in updatedBy; the updated work, in updateTo. It is this work's own DOI when the update was made to this record in place.",
+ "type": "string"
+ },
+ "recordId": {
+ "description": "Retraction Watch record ID. Present only on retraction-watch entries.",
+ "type": "string"
+ },
+ "source": {
+ "description": "Who recorded the link: publisher, or retraction-watch for an entry Crossref carries from the Retraction Watch database",
+ "type": "string"
+ },
+ "type": {
+ "description": "Crossref update type as deposited: correction, erratum, corrigendum, addendum, retraction, withdrawal, expression_of_concern, new_version, new_edition, or another code",
+ "type": "string"
+ },
+ "updated": {
+ "additionalProperties": false,
+ "description": "Date the update was issued",
+ "properties": {
+ "day": {
+ "description": "Day of month",
+ "type": "number"
+ },
+ "month": {
+ "description": "Month (1–12)",
+ "type": "number"
+ },
+ "year": {
+ "description": "Year",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "doi",
+ "type",
+ "source"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}