addedInput schema / properties / archive
Added value: +{
+ "description": "Archive mode: return a page of one curated list's ARCHIVED entries instead of the disaster record. The response carries the record identity, the selected list, and total / shown / offset, plus a next offset while more entries remain. Mutually exclusive with sections — sections slices the record, archive replaces it — and a call supplying both is rejected. A record over the response budget still answers an archive call with the page: a page is bounded by limit and carries none of the record prose, so it never outlines.",
+ "properties": {
+ "limit": {
+ "default": 25,
+ "description": "Maximum archived entries in one page (1-100).",
+ "maximum": 100,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "list": {
+ "description": "Which curated list to page. The archived entries of that list are the ones the profile itself leaves out.",
+ "enum": [
+ "keyContent",
+ "appealsResponsePlans",
+ "usefulLinks"
+ ],
+ "type": "string"
+ },
+ "offset": {
+ "default": 0,
+ "description": "Zero-based index of the first archived entry to return. Send back the nextOffset from the previous page to continue.",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "list"
+ ],
+ "type": "object"
+}
addedInput schema / properties / sections
Added value: +{
+ "description": "Sections of the disaster record to return, named by the sections[].name values an outline response lists. Omit for the whole record, or for a section outline when the record is over the response budget. Identity metadata — the record's ID, its name, and its canonical URL — comes back alongside whatever is requested. The call is self-contained — the record is re-fetched and sliced, so no prior call has to be repeated. This names parts of the record itself and never reaches archived entries — use archive for those.",
+ "items": {
+ "description": "A section name exactly as the outline response spelled it.",
+ "type": "string"
+ },
+ "type": "array"
+}
changedOutput schema / properties / appealsResponsePlans / description
Previous value: -"Currently-active appeals and response plans linked to this disaster — the present set, not the full historical archive."New value: +"Currently-active appeals and response plans linked to this disaster — the present set. The archived entries are reachable with archive: { list: \"appealsResponsePlans\" }."
addedOutput schema / properties / archive
Added value: +{
+ "additionalProperties": false,
+ "description": "One page of a curated list's archived entries, returned in place of the record.",
+ "properties": {
+ "entries": {
+ "description": "The archived entries in this page, in ReliefWeb's own archive order.",
+ "items": {
+ "additionalProperties": false,
+ "description": "One archived entry.",
+ "properties": {
+ "date": {
+ "description": "Publication date, carried by appeals and response plans.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Entry title.",
+ "type": "string"
+ },
+ "url": {
+ "description": "Entry URL.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "title",
+ "url"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "list": {
+ "description": "The curated list this page was read from.",
+ "enum": [
+ "keyContent",
+ "appealsResponsePlans",
+ "usefulLinks"
+ ],
+ "type": "string"
+ },
+ "nextOffset": {
+ "description": "Offset to send back to read the next page. Absent when this page reaches the end of the archive.",
+ "type": "number"
+ },
+ "offset": {
+ "description": "Zero-based index of the first entry in this page.",
+ "type": "number"
+ },
+ "shown": {
+ "description": "Number of entries in this page.",
+ "type": "number"
+ },
+ "total": {
+ "description": "Total archived entries in that list for this record.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "list",
+ "total",
+ "shown",
+ "offset",
+ "entries"
+ ],
+ "type": "object"
+}
changedOutput schema / properties / keyContent / description
Previous value: -"Currently-active curated key content links from the ReliefWeb editorial team — the present curated set, not the full historical archive."New value: +"Currently-active curated key content links from the ReliefWeb editorial team — the present curated set. The archived entries are reachable with archive: { list: \"keyContent\" }."
addedOutput schema / properties / kind
Added value: +{
+ "description": "full when the record — or the sections asked for — is returned in whole; outline when the record exceeded the response budget and only its section index is returned; archive when the call asked for a page of one curated list's archived entries, which is returned in place of the record.",
+ "enum": [
+ "full",
+ "outline",
+ "archive"
+ ],
+ "type": "string"
+}
addedOutput schema / properties / outlineNotice
Added value: +{
+ "description": "How to re-call this tool for specific sections of the record.",
+ "type": "string"
+}
addedOutput schema / properties / sections
Added value: +{
+ "description": "Every section of the record, largest first. Pass the names back in `sections` to retrieve them.",
+ "items": {
+ "additionalProperties": false,
+ "description": "One retrievable section of the record: its name and its serialized size.",
+ "properties": {
+ "bytes": {
+ "description": "Serialized byte size of the section",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "name": {
+ "description": "Section identifier — pass in `sections` to retrieve it",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "bytes"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
changedOutput schema / properties / usefulLinks / description
Previous value: -"Currently-active useful external links curated by ReliefWeb editors — the present set, not the full historical archive."New value: +"Currently-active useful external links curated by ReliefWeb editors — the present set. The archived entries are reachable with archive: { list: \"usefulLinks\" }."
changedOutput schema / required
Previous value: -[
- "id",
- "name"
-]New value: +[
+ "kind"
+]