Référence de l'API

Signets

Gérez les signets de style navigateur avec des groupes repliables. Le serveur récupère automatiquement les métadonnées de page (titre) lorsqu'un signet est ajouté.

Définitions de types

bash
type Bookmark {
  id: ID!
  url: String!
  title: String!              # auto-fetched from <title> when available
  groupId: ID!
  pinned: Boolean!
  sortOrder: Int!
  updatedAt: String!
}

type BookmarkGroup {
  id: ID!
  name: String!
  collapsed: Boolean!
  sortOrder: Int!
}

input BookmarkInput {
  url: String
  title: String
  groupId: String
  pinned: Boolean
  sortOrder: Int
}

Opérations

query

bookmarks

Liste tous les signets.

bash
query GetBookmarks {
  bookmarks { id url title groupId pinned sortOrder updatedAt }
}
query

bookmarkGroups

Liste tous les groupes de signets.

bash
query GetBookmarkGroups {
  bookmarkGroups { id name collapsed sortOrder }
}
mutation

addBookmarks

Ajoute un ou plusieurs signets à un groupe. Le serveur déclenche un événement de récupération de métadonnées par signet pour remplir le titre.

bash
mutation AddBookmarks($urls: [String!]!, $groupId: String!) {
  addBookmarks(urls: $urls, groupId: $groupId) { id url title groupId pinned sortOrder updatedAt }
}
mutation

updateBookmark

Met à jour un ou plusieurs champs d'un signet existant.

bash
mutation UpdateBookmark($id: ID!, $input: BookmarkInput!) {
  updateBookmark(id: $id, input: $input) { id url title groupId pinned sortOrder updatedAt }
}
mutation

deleteBookmarks

Supprime un ou plusieurs signets par ID.

bash
mutation DeleteBookmarks($ids: [ID!]!) {
  deleteBookmarks(ids: $ids)
}
mutation

recordBookmarkClick

Enregistre un clic sur un signet (utilisé pour le tri analytique / « plus visités »).

bash
mutation RecordBookmarkClick($id: ID!) {
  recordBookmarkClick(id: $id)
}
mutation

createBookmarkGroup

Crée un nouveau groupe de signets.

bash
mutation CreateBookmarkGroup($name: String!) {
  createBookmarkGroup(name: $name) { id name collapsed sortOrder }
}
mutation

updateBookmarkGroup

Met à jour le nom, l'état replié ou l'ordre de tri d'un groupe de signets.

bash
mutation UpdateBookmarkGroup($id: ID!, $name: String!, $collapsed: Boolean!, $sortOrder: Int!) {
  updateBookmarkGroup(id: $id, name: $name, collapsed: $collapsed, sortOrder: $sortOrder) {
    id name collapsed sortOrder
  }
}
mutation

deleteBookmarkGroup

Supprime un groupe de signets. Les signets à l'intérieur ne sont pas supprimés, seulement retirés du groupe.

bash
mutation DeleteBookmarkGroup($id: ID!) {
  deleteBookmarkGroup(id: $id)
}