PressForward API outline

Aperta
  • Qualcosa non va?
#748 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
php, wordpress
Ambito
api, backend

Direzione di ricerca

The issue outlines proposed read and write endpoints under pf/v1, including items, feeds, folders, users, nominations, and alerts. Start by reviewing the WordPress REST API and the existing PressForward API code to determine which proposals are already implemented; the issue does not name specific files or tests. Done would require an agreed scope and implementation of the selected endpoints, which this outline does not specify.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement PF-API-Phase-1 PF-API-Phase-2 PF-API-Phase-3

PressForward API Architecture

Note: Where "+" is indicated are additional API endpoints proposed to add to existing WordPress Endpoints

Note: "" indicates authentication required (optional)*

(current Zotero API read requests and sample responses, for reference)

Read

  • pf/v1/item (Item endpoint data should also be added to PF driven Posts in the WPAPI)
    • /[id]/
      • Title
      • Feed ID
      • Item Date
      • Item Author
      • Item Content
      • Item Link
      • Item Feat Img
      • Item ID
      • Item Retrieved
      • Source Repeats
      • Readable Status
      • Content
      • Item Tags
      • Wordcount
      • Tags
      • Folders
      • Feed ID
    • /[id]
    • /[id]/relationships (count)
    • */[id]/relationships (full data)
    • */[id]/relationships/[user_id]
    • */[id]/comment
    • */[id]/comment/[comment_id]
    • */[id]/comment/edit/
    • /folder/[folder]
  • pf/v1/nominated
    • Items+
    • Nomination Count
    • *Submitted By
    • *Nominating Users
    • Item_ID
  • pf/v1/published || +posts
    • Nominated+
    • Nominated_id
    • /
  • pf/v1/feed
    • /[id]/
      • Id
      • Title
      • Description
      • Type
      • feedURL
      • htmlURL
      • Module_added (string)
      • Status
      • Thumbnail
      • Parent Feed
      • *User_added
    • /[id]/alerts
      • List of alerts
    • /alerts
      • (All Feed Alerts)
      • Alert text
      • ID of Feed
      • ID of Alert
    • OPML URL
    • All PF Items Feed
  • pf/v1/folders
    • ID
    • Title
    • Description
    • Slug
    • Parent
    • OPML URL
    • ...
  • pf/v1/users || +Users/pf/
    • Nomination Count
    • /relationships (count)
    • */relationships (detailed objects)
  • pf/v1/alerts
    • Alert text
    • Alert ID
    • Alerted Object ID
      Write
  • pf/v1/item (Item endpoint data should also be added to PF driven Posts in the WPAPI)
    • PUT [id]/
    • PUT [id]/[relationship_type_id]
    • DELETE [id]
    • POST
  • pf/v1/nominated
    • POST [item_id]
    • POST [object]
  • pf/v1/published
  • pf/v1/feed
  • pf/v1/folder
  • pf/v1/user
    • (nothing)
      Priorities ->
  • Read
  • Write (Nominate This)
  • Write (Action Bar)
Lingua principale
PHP
Stelle
127
Fork
23
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di PressForward/pressforward

Tutte le issue di PressForward/pressforward

Issue simili

Altre issue su PHP

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.