Merge branch 'master' into aren55555/feature/simplifiy-marshal-api

# Conflicts:
#	response_test.go

Author: aren55555

README.md

@@ -291,7 +291,7 @@ func ListBlogs(w http.ResponseWriter, r *http.Request) {
 	w.Header().Set("Content-Type", jsonapi.MediaType)
 	w.WriteHeader(http.StatusOK)
 
-	if err := jsonapi.MarshalManyPayload(w, blogs); err != nil {
+	if err := jsonapi.MarshalPayload(w, blogs); err != nil {
 		http.Error(w, err.Error(), http.StatusInternalServerError)
 	}
 }
@@ -329,7 +329,7 @@ func CreateBlogs(w http.ResponseWriter, r *http.Request) {
 	w.Header().Set("Content-Type", jsonapi.MediaType)
 	w.WriteHeader(http.StatusCreated)
 
-	if err := jsonapi.MarshalManyPayload(w, blogs); err != nil {
+	if err := jsonapi.MarshalPayload(w, blogs); err != nil {
 		http.Error(w, err.Error(), http.StatusInternalServerError)
 	}
 }

examples/app.go

@@ -103,7 +103,7 @@ func exerciseHandler() {
 		fixtureBlogCreate(3),
 	}
 	in = bytes.NewBuffer(nil)
-	jsonapi.MarshalManyPayload(in, blogs)
+	jsonapi.MarshalPayload(in, blogs)
 
 	req, _ = http.NewRequest(http.MethodPut, "/blogs", in)
 

examples/handler.go

@@ -70,7 +70,7 @@ func (h *ExampleHandler) echoBlogs(w http.ResponseWriter, r *http.Request) {
 
 	w.WriteHeader(http.StatusOK)
 	w.Header().Set(headerContentType, jsonapi.MediaType)
-	if err := jsonapiRuntime.MarshalManyPayload(w, blogs); err != nil {
+	if err := jsonapiRuntime.MarshalPayload(w, blogs); err != nil {
 		http.Error(w, err.Error(), http.StatusInternalServerError)
 	}
 }

examples/handler_test.go

@@ -36,7 +36,7 @@ func TestExampleHandler_put(t *testing.T) {
 		fixtureBlogCreate(3),
 	}
 	requestBody := bytes.NewBuffer(nil)
-	jsonapi.MarshalManyPayload(requestBody, blogs)
+	jsonapi.MarshalPayload(requestBody, blogs)
 
 	r, err := http.NewRequest(http.MethodPut, "/blogs", requestBody)
 	if err != nil {

node.go

@@ -36,7 +36,7 @@ func (p *ManyPayload) clearIncluded() {
 // Node is used to represent a generic JSON API Resource
 type Node struct {
 	Type          string                 `json:"type"`
-	ID            string                 `json:"id"`
+	ID            string                 `json:"id,omitempty"`
 	ClientID      string                 `json:"client-id,omitempty"`
 	Attributes    map[string]interface{} `json:"attributes,omitempty"`
 	Relationships map[string]interface{} `json:"relationships,omitempty"`

response_test.go

@@ -224,7 +224,33 @@ func TestMarshalIDPtr(t *testing.T) {
 	}
 }
 
-func TestMarshal_invalidIDType(t *testing.T) {
+func TestMarshalOnePayload_omitIDString(t *testing.T) {
+	type Foo struct {
+		ID    string `jsonapi:"primary,foo"`
+		Title string `jsonapi:"attr,title"`
+	}
+
+	foo := &Foo{Title: "Foo"}
+	out := bytes.NewBuffer(nil)
+	if err := MarshalPayload(out, foo); err != nil {
+		t.Fatal(err)
+	}
+
+	var jsonData map[string]interface{}
+	if err := json.Unmarshal(out.Bytes(), &jsonData); err != nil {
+		t.Fatal(err)
+	}
+	payload := jsonData["data"].(map[string]interface{})
+
+	// Verify that empty ID of type string gets omitted. See:
+	// https://github.com/google/jsonapi/issues/83#issuecomment-285611425
+	_, ok := payload["id"]
+	if ok {
+		t.Fatal("Was expecting the data.id member to be omitted")
+	}
+}
+
+func TestMarshall_invalidIDType(t *testing.T) {
 	type badIDStruct struct {
 		ID *bool `jsonapi:"primary,cars"`
 	}