Pagination in compound object

Aperta
#126 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
45/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
api

Direzione di ricerca

Inizia individuando le definizioni dei tipi Links e PaginationLinks e il tipo di oggetto relazione che attualmente utilizza Links. Controlla come è rappresentato l’esempio JSON:API, quindi verifica che i link di relazione accettino gli attributi di paginazione descritti nell’issue e che i tipi di link esistenti rimangano validi.

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

Descrizione

Describe the bug
The types do not allow for pagination in relationship objects. For example, in the below bit of JSON I would like to add a next relationship to the comments, but the type can only be of type Links which includes self and related and none of the PaginationLinks types.

{
  "data": [{
    "type": "articles",
    "id": "1",
    "attributes": {
      "title": "JSON:API paints my bikeshed!"
    },
    "links": {
      "self": "http://example.com/articles/1"
    },
    "relationships": {
      "comments": {
        "links": {
          "self": "http://example.com/articles/1/relationships/comments",
          "related": "http://example.com/articles/1/comments",
          "next": "http://example.com/articles/1/comments?next=5"
        },
        "data": [
          { "type": "comments", "id": "5" }
        ]
      }
    }
  }],
  "included": [{
    "type": "comments",
    "id": "5",
    "attributes": {
      "body": "First!"
    },
    "relationships": {
      "author": {
        "data": { "type": "people", "id": "2" }
      }
    },
    "links": {
      "self": "http://example.com/comments/5"
    }
  }]
}

Expected behavior
I expect it to allow for all the attributes of the PaginationLinks type.

Lingua principale
TypeScript
Stelle
54
Fork
6
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 mike-north/jsonapi-typescript

Tutte le issue di mike-north/jsonapi-typescript

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.