Ga naar hoofdinhoud

Bookmarks integration

Bookmarks
bookmarks
Provider stub

Link NC Bookmarks to Open Register objects. URL preview cards, tag chips from Bookmarks' own tag system, favicon-and-title compact rendering. Provider stub today.

Group
Documents
Required app
bookmarks
Storage
Link table
Icon
Bookmark

Pin reference URLs to an Open Register object via NC Bookmarks. The Bookmarks tab will show preview cards with favicon, title, and Bookmarks' own tags; the widget renders a compact list. The provider is registered today — the wrapped service + link table land in a follow-up.

Screenshot​

The integration registers in OpenRegister's in-page registry and renders as one of the tabs on the standalone integrations view. The tab is highlighted active here so you can see exactly which surface this leaf controls.

bookmarks integration tab active in the OpenRegister integrations view

Captured by tests/e2e/leaf-screenshots.spec.ts against the seeded integration-verification register on the dev container. Empty state (Nothing linked yet) is expected on a freshly seeded object — link an upstream entity from the tab's + Add affordance to populate it.

What it will do​

  • Lists NC Bookmarks linked to each Open Register object on the Bookmarks sidebar tab.
  • Shows favicon, title, URL, and Bookmarks' own tags as chips.
  • Lets users link an existing bookmark or paste a URL to add one.
  • Lets users unlink. The bookmark stays in NC Bookmarks; only the link row is removed.
  • Resolves a referenceType: 'bookmarks' schema property to a single-entity chip with favicon + title.

Setup​

1. Install NC Bookmarks​

Install the bookmarks Nextcloud app. The Bookmarks tab appears once it's enabled.

2. Use it on an object​

Open any object whose schema declares linkedTypes: ['bookmarks']. The Bookmarks tab appears. Today it renders the empty state until the wrapping service lands.

Configuration​

FieldOpen Register sideNC Bookmarks side
Storagelink-table (openregister_bookmark_links, pending)NC oc_bookmarks
RefreshPer render (favicon cached by Bookmarks)—
PermissionsInherits from object RBACBookmarks user ACL

Local verification setup​

The leaf-verification harness in tests/e2e/leaf-verification.spec.ts probes every advertised provider against the seeded integration-verification register; you can reproduce a single-leaf check by hand against any OpenRegister dev container.

1. Install the bookmarks Nextcloud app​

docker exec -u www-data nextcloud php occ app:install bookmarks
docker exec -u www-data nextcloud php occ app:enable bookmarks
docker exec nextcloud apache2ctl graceful   # bust OPcache so the registry sees the new app

Without bookmarks enabled, the bookmarks provider reports enabled: false on the OCS capabilities payload and its sub-resource endpoint refuses to dispatch.

2. Probe the registry to confirm the provider is advertised​

curl -s -u admin:admin -H 'OCS-APIRequest: true' \
  http://localhost:8080/ocs/v2.php/cloud/capabilities?format=json \
  | jq '.ocs.data.capabilities.openregister.integrations.providers[] | select(.id == "bookmarks")'

Expected payload — the enabled flag flips to true once the required app is installed.

3. Probe the per-object sub-resource​

curl -s -u admin:admin -H 'OCS-APIRequest: true' \
  "http://localhost:8080/index.php/apps/openregister/api/objects/21/166/25706ca9-c989-4d6b-9f7b-98cf1cc70639/integrations/bookmarks"

Most recent harness run (against the seeded verification-probe object on this dev container):

  • Status: 200 (list-envelope)
  • Latency: 88ms
  • Body: matches the documented list envelope below
{
  "items": []
}

The OCS-APIRequest: true header is mandatory — without it, Nextcloud's session-CSRF guard short-circuits with HTTP 412 before the provider runs. An empty items: [] is the correct response for a freshly-seeded object that hasn't been linked to any upstream bookmarks entity yet.

Current status​

Provider registered. Wrapping service + link table tracked under openspec/changes/integration-bookmarks.