mattpolzin / mattpolzin/JSONAPI

JSON::API v1.1 and `lid`

オープン
#107 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Swift
スター
81
フォーク
21
PR マージ指標
30日以内にマージされた PR はありません

説明

Hello,

First, thank you a lot for your amazing library @mattpolzin !

I don't know all the JSON::API v1.1 additions, but the lid member seems very interesting:

The id member is not required when the resource object originates at the client and represents a new resource to be created on the server. In that case, a client MAY include a lid member to uniquely identify the resource by type locally within the document.

Reference: https://jsonapi.org/format/1.1/#document-resource-objects

I often need sync data created on the device in my applications. So I use the type UUID for the id and sometimes it's created on the app side. Until now, the back-ends accept to the id member as the the id to save in the database... but it's not perfect... and I think that the new lid would be a lot better.

Do you have plan to allow to use JSON::API v1.1 with your library? Maybe I could try to implement this lid part, but I need to know your plan about the spec 1.1 before to start on this.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず JSON:API v1.1 のリソースオブジェクト仕様を確認し、特に lid メンバーに注目してから、Swift ライブラリの現在の JSON:API サポートを調査してください。issue ではファイルやテストが指定されておらず、計画を求めているため、実装前にスコープと完了基準を maintainer に確認する必要があります。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
swift
領域
api, backend-api-design
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
20/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。