Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API updates for public collections #2158

Open
Tracked by #1051
SuaYoo opened this issue Nov 18, 2024 · 4 comments · Fixed by #2164
Open
Tracked by #1051

API updates for public collections #2158

SuaYoo opened this issue Nov 18, 2024 · 4 comments · Fixed by #2164
Assignees
@tw4l
Labels
back end Requires back end dev work
Milestone
Public Collections

Comments

@SuaYoo
Copy link
Member

SuaYoo commented Nov 18, 2024 •
edited
Loading

  • Enable public-facing org page (something like publicCollectionListing: true)
  • Differentiate between unlisted and discoverable public collections when creating, editing, and retrieving collections.
@SuaYoo SuaYoo mentioned this issue Nov 18, 2024
Open
11 tasks
@SuaYoo SuaYoo added the back end Requires back end dev work label Nov 18, 2024
@tw4l tw4l self-assigned this Nov 18, 2024
@ikreymer ikreymer moved this from Triage to Todo in Webrecorder Projects Nov 18, 2024
@tw4l
Copy link
Member

tw4l commented Nov 18, 2024 •
edited
Loading

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.

@tw4l tw4l moved this from Todo to Ready in Webrecorder Projects Nov 18, 2024
@Shrinks99 Shrinks99 added this to the Public Collections milestone Nov 18, 2024
@tw4l tw4l moved this from Ready to Implementing in Webrecorder Projects Nov 19, 2024
@SuaYoo
Copy link
Member Author

SuaYoo commented Nov 19, 2024 •
edited
Loading

@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 tw4l mentioned this issue Nov 19, 2024
Merged
@tw4l
Copy link
Member

tw4l commented Nov 19, 2024

@SuaYoo Details (as well as frontend changes just to keep current behavior with backend changes) are here: #2164

@tw4l tw4l moved this from Implementing to In Review in Webrecorder Projects Nov 19, 2024
tw4l added a commit that referenced this issue Nov 22, 2024
@tw4l @SuaYoo
Make changes to collections to support publicly listed collections (#…
824b84f 
…2164)

Fixes #2158 

- Adds `Organization.listPublicCollections` field and API endpoint to
update it
- Replaces `Collection.isPublic` boolean with `Collection.access`
(values: `private`, `unlisted`, `public`) and add database migration
- Update frontend to use `Collection.access` instead of `isPublic`,
otherwise not changing current behavior

---------

Co-authored-by: sua yoo <[email protected]>
@tw4l
Copy link
Member

tw4l commented Nov 22, 2024

Merged into feature branch public-collections-feature, backend could still use review before merge into main

SuaYoo added a commit that referenced this issue Nov 27, 2024
@tw4l @SuaYoo
Make changes to collections to support publicly listed collections (#…
dfcda04 
…2164)

Fixes #2158 

- Adds `Organization.listPublicCollections` field and API endpoint to
update it
- Replaces `Collection.isPublic` boolean with `Collection.access`
(values: `private`, `unlisted`, `public`) and add database migration
- Update frontend to use `Collection.access` instead of `isPublic`,
otherwise not changing current behavior

---------

Co-authored-by: sua yoo <[email protected]>
tw4l added a commit that referenced this issue Nov 27, 2024
@tw4l @SuaYoo
Make changes to collections to support publicly listed collections (#…
2b5a2eb 
…2164)

Fixes #2158 

- Adds `Organization.listPublicCollections` field and API endpoint to
update it
- Replaces `Collection.isPublic` boolean with `Collection.access`
(values: `private`, `unlisted`, `public`) and add database migration
- Update frontend to use `Collection.access` instead of `isPublic`,
otherwise not changing current behavior

---------

Co-authored-by: sua yoo <[email protected]>
SuaYoo added a commit that referenced this issue Nov 28, 2024
@tw4l @SuaYoo
Make changes to collections to support publicly listed collections (#…
cc2baf1 
…2164)

Fixes #2158 

- Adds `Organization.listPublicCollections` field and API endpoint to
update it
- Replaces `Collection.isPublic` boolean with `Collection.access`
(values: `private`, `unlisted`, `public`) and add database migration
- Update frontend to use `Collection.access` instead of `isPublic`,
otherwise not changing current behavior

---------

Co-authored-by: sua yoo <[email protected]>
SuaYoo added a commit that referenced this issue Dec 4, 2024
@tw4l @SuaYoo
Make changes to collections to support publicly listed collections (#…
e9dd544 
…2164)

Fixes #2158 

- Adds `Organization.listPublicCollections` field and API endpoint to
update it
- Replaces `Collection.isPublic` boolean with `Collection.access`
(values: `private`, `unlisted`, `public`) and add database migration
- Update frontend to use `Collection.access` instead of `isPublic`,
otherwise not changing current behavior

---------

Co-authored-by: sua yoo <[email protected]>
SuaYoo added a commit that referenced this issue Dec 9, 2024
@tw4l @SuaYoo
Make changes to collections to support publicly listed collections (#…
b3c7242 
…2164)

Fixes #2158 

- Adds `Organization.listPublicCollections` field and API endpoint to
update it
- Replaces `Collection.isPublic` boolean with `Collection.access`
(values: `private`, `unlisted`, `public`) and add database migration
- Update frontend to use `Collection.access` instead of `isPublic`,
otherwise not changing current behavior

---------

Co-authored-by: sua yoo <[email protected]>
SuaYoo added a commit that referenced this issue Dec 10, 2024
@tw4l @SuaYoo
Make changes to collections to support publicly listed collections (#…
0eeecf5 
…2164)

Fixes #2158 

- Adds `Organization.listPublicCollections` field and API endpoint to
update it
- Replaces `Collection.isPublic` boolean with `Collection.access`
(values: `private`, `unlisted`, `public`) and add database migration
- Update frontend to use `Collection.access` instead of `isPublic`,
otherwise not changing current behavior

---------

Co-authored-by: sua yoo <[email protected]>
SuaYoo added a commit that referenced this issue Dec 11, 2024
@tw4l @SuaYoo
Make changes to collections to support publicly listed collections (#…
d0d8c57 
…2164)

Fixes #2158 

- Adds `Organization.listPublicCollections` field and API endpoint to
update it
- Replaces `Collection.isPublic` boolean with `Collection.access`
(values: `private`, `unlisted`, `public`) and add database migration
- Update frontend to use `Collection.access` instead of `isPublic`,
otherwise not changing current behavior

---------

Co-authored-by: sua yoo <[email protected]>
@ikreymer ikreymer moved this from In Review to Done! in Webrecorder Projects Dec 11, 2024
SuaYoo added a commit that referenced this issue Dec 16, 2024
@tw4l @SuaYoo
Make changes to collections to support publicly listed collections (#…
f368d0d 
…2164)

Fixes #2158 

- Adds `Organization.listPublicCollections` field and API endpoint to
update it
- Replaces `Collection.isPublic` boolean with `Collection.access`
(values: `private`, `unlisted`, `public`) and add database migration
- Update frontend to use `Collection.access` instead of `isPublic`,
otherwise not changing current behavior

---------

Co-authored-by: sua yoo <[email protected]>
SuaYoo added a commit that referenced this issue Dec 17, 2024
@tw4l @SuaYoo
Make changes to collections to support publicly listed collections (#…
f7ab162 
…2164)

Fixes #2158 

- Adds `Organization.listPublicCollections` field and API endpoint to
update it
- Replaces `Collection.isPublic` boolean with `Collection.access`
(values: `private`, `unlisted`, `public`) and add database migration
- Update frontend to use `Collection.access` instead of `isPublic`,
otherwise not changing current behavior

---------

Co-authored-by: sua yoo <[email protected]>
SuaYoo added a commit that referenced this issue Dec 23, 2024
@tw4l @SuaYoo
Make changes to collections to support publicly listed collections (#…
55e719a 
…2164)

Fixes #2158 

- Adds `Organization.listPublicCollections` field and API endpoint to
update it
- Replaces `Collection.isPublic` boolean with `Collection.access`
(values: `private`, `unlisted`, `public`) and add database migration
- Update frontend to use `Collection.access` instead of `isPublic`,
otherwise not changing current behavior

---------

Co-authored-by: sua yoo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tw4l tw4l

Labels
back end Requires back end dev work
Projects
Webrecorder Projects
Status: Done!
Milestone
Public Collections
Development

Successfully merging a pull request may close this issue.

Make changes to collections to support publicly listed collections webrecorder/browsertrix
3 participants
@SuaYoo @Shrinks99 @tw4l