outline
outline copied to clipboard
Update api documentation for collections.info to reflect the updated output returned by the api
Is there an existing issue for this?
- [x] I have searched the existing issues
This is not related to configuring Outline
- [x] The issue is not related to self-hosting config
Current Behavior
The https://www.getoutline.com/developers#tag/collections/POST/collections.info link is outdated, as it does not show some of the new fields that exist now such as
"deletedAt": null,
"archivedAt": null,
"archivedBy": null
Example of what i acutally get from app.getoutline.com/api/collections.info
{
"data": {
"id": "a9a26baa-78d8-4226-8022-06635596a7a9",
"url": "/collection/welcome-JabtYHpHLP",
"urlId": "JabtYHpHLP",
"name": "Welcome",
"description": "This collection is a quick guide to what Outline is all about. Feel free to delete this collection once your team is up to speed with the basics!",
"sort": {
"field": "index",
"direction": "asc"
},
"icon": null,
"index": ")",
"color": null,
"permission": "read_write",
"sharing": true,
"createdAt": "2025-02-11T18:53:49.560Z",
"updatedAt": "2025-02-12T15:02:43.593Z",
"deletedAt": null,
"archivedAt": null,
"archivedBy": null
},
"policies": [
{
"id": "a9a26baa-78d8-4226-8022-06635596a7a9",
"abilities": {
"move": true,
"read": true,
"readDocument": true,
"star": true,
"unstar": true,
"export": true,
"share": true,
"updateDocument": true,
"createDocument": true,
"deleteDocument": true,
"update": true,
"archive": true,
"delete": true,
"restore": false
}
}
],
"status": 200,
"ok": true
}
Expected Behavior
No response
Steps To Reproduce
No response
Environment
- Outline: 0.82.0
- Browser:
Anything else?
Not sure if this should be as a bug or a feature request, added it as a bug as there is a mismatch between the stated documentation and the actual behavior.
https://www.getoutline.com/developers#model/collection