JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

After creation a resource is not rendered if its id is nil

Offen
#1,025 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Ruby
Sterne
2.3k
Forks
546
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

In 0.8.3, I could 'create' a PORO object, and let the id of the object be nil, and everything would render well, i.e.:

class Poro
  def id
    nil
  end

  def save
    # some logic
  end
end

class PoroResource < JSONAPI::Resource; end
# POST /poros
{ "data": { "attributes": {}, "type": "poros" } }

# Response
{ "data": { "attributes": {}, "type": "poros", "id": null, "..etc..": "..etc.." } }

However, in 0.9.0, the data is just null:

# POST /poros
{ "data": { "attributes": {}, "type": "poros" } }

# Response
{ "data": null }

This is due to https://github.com/cerebris/jsonapi-resources/blob/release-0-9/lib/jsonapi/resource_serializer.rb#L69

Maybe a short line in the docs somewhere would let people know this happens.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem für POST /poros beschriebenen Verhalten und prüfe jsonapi/resource_serializer.rb in der angegebenen Zeile im Branch release-0-9. Bestätige, wie sich eine nil-Ressourcen-ID auf die Serialisierung auswirkt, und dokumentiere anschließend das beobachtete Verhalten, damit Benutzer wissen, was sie erwarten können.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
ruby
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.