PlainApp
Référence de l'API

Flux (RSS)

Abonnez-vous à des flux RSS/Atom, récupérez les entrées et enregistrez les articles en notes. Prend en charge l'import/export OPML.

Définitions de types

bash
type Feed {
  id: ID!
  url: String!                # RSS/Atom URL
  name: String!               # display name (defaults to feed title)
  fetchContent: Boolean!      # when true, the server fetches the full article body
  updatedAt: String!
}

type FeedCount {
  feedId: ID!
  count: Int!                 # total entries
  unreadCount: Int!
}

type FeedEntry {
  id: ID!
  feedId: ID!
  title: String!
  description: String!        # short summary
  content: String!            # full article body (may be empty until fetched)
  url: String!                # canonical article URL
  publishedAt: String!        # ISO 8601
  read: Boolean!
  favorite: Boolean!
  tags: [Tag!]!
}

Opérations

query

feeds

Liste tous les flux auxquels vous êtes abonné.

bash
query GetFeeds {
  feeds { id url name fetchContent updatedAt }
}
query

feedsCount

Compteurs d'entrées totaux et non lus par flux.

bash
query GetFeedsCount {
  feedsCount { feedId count unreadCount }
}
query

feedEntries

Recherche des entrées de flux (titre + description). Laissez la requête vide pour tout lister.

bash
query GetFeedEntries($offset: Int!, $limit: Int!, $query: String!) {
  feedEntries(offset: $offset, limit: $limit, query: $query) {
    id feedId title description content url publishedAt read favorite
    tags { id name }
  }
}
query

feedEntryCount

Compte les entrées de flux correspondant à une requête.

bash
query GetFeedEntryCount($query: String!) {
  feedEntryCount(query: $query)
}
query

feedEntry

Récupère une entrée de flux unique par ID.

bash
query GetFeedEntry($id: ID!) {
  feedEntry(id: $id) { id feedId title description content url publishedAt read favorite }
}
mutation

createFeed

Abonne à un nouveau flux. Le serveur récupère le canal RSS pour remplir le nom, puis lance une synchronisation unique.

bash
mutation CreateFeed($url: String!, $fetchContent: Boolean!) {
  createFeed(url: $url, fetchContent: $fetchContent) { id url name fetchContent updatedAt }
}
mutation

updateFeed

Met à jour le nom d'affichage ou l'indicateur fetchContent d'un flux.

bash
mutation UpdateFeed($id: ID!, $name: String!, $fetchContent: Boolean!) {
  updateFeed(id: $id, name: $name, fetchContent: $fetchContent) { id url name fetchContent updatedAt }
}
mutation

deleteFeed

Se désabonne d'un flux et supprime toutes ses entrées (et leurs relations d'étiquettes).

bash
mutation DeleteFeed($id: ID!) {
  deleteFeed(id: $id)
}
mutation

syncFeeds

Déclenche un worker de synchronisation unique. Passez un id pour synchroniser un flux unique ; passez null ou vide pour tout synchroniser.

bash
mutation SyncFeeds($id: ID) {
  syncFeeds(id: $id)
}
mutation

fetchFeedContent

Récupère le corps complet d'un article pour une entrée de flux unique. Renvoie l'entrée mise à jour.

bash
mutation FetchFeedContent($id: ID!) {
  fetchFeedContent(id: $id) { id content }
}
mutation

syncFeedContent

Alias de fetchFeedContent. Conservé pour rétrocompatibilité.

bash
mutation SyncFeedContent($id: ID!) {
  syncFeedContent(id: $id) { id content }
}
mutation

deleteFeedEntries

Supprime les entrées de flux correspondant à une requête (et leurs relations d'étiquettes).

bash
mutation DeleteFeedEntries($query: String!) {
  deleteFeedEntries(query: $query)
}
mutation

importFeeds

Importe un document OPML (sous forme de chaîne) dans la base de données des flux.

bash
mutation ImportFeeds($content: String!) {
  importFeeds(content: $content)
}
mutation

exportFeeds

Exporte tous les flux auxquels vous êtes abonné sous forme de chaîne OPML.

bash
mutation ExportFeeds {
  exportFeeds
}