API updates for public collections

webrecorder / browsertrix

Browsertrix is the hosted, high-fidelity, browser-based crawling service from Webrecorder designed to make web archiving easier and more accessible for all!

https://webrecorder.net/browsertrix

GNU Affero General Public License v3.0

201 stars 35 forks source link

API updates for public collections #2158

Open SuaYoo opened 3 days ago

SuaYoo commented 3 days ago

Enable public-facing org page (something like publicCollectionListing: true)
Differentiate between unlisted and discoverable public collections when creating, editing, and retrieving collections.

tw4l commented 3 days ago

We'll likely want to change Collection.isPublic bool to an enum with an accompanying migration for existing data now that collections can have three visbility states: private, shareable but unlisted, and publicly discoverable.

We should also be able to filter the list endpoint on this field.

SuaYoo commented 2 days ago

@tw4l let me know what the new field names and collection enum will be, and I'll start frontend work based on mocked data.

tw4l commented 2 days ago

@SuaYoo Details (as well as frontend changes just to keep current behavior with backend changes) are here: https://github.com/webrecorder/browsertrix/pull/2164