Google Classroom Turn In API bad request error

[mattszeto]

Environment details

• Programming language: Go
• OS: Mac OS
• Language runtime version: 1.19
• Package version: google.golang.org/api/classroom/v1 , google.golang.org/api v0.87.0

Steps to reproduce

running this code snippet (given valid course id, coursework id and submission id...):

_,err = service.Courses.CourseWork.StudentSubmissions.TurnIn(submission.CourseID, submission.courseWorkID, submission.ID, &classroom.TurnInStudentSubmissionRequest{}).Context(ctx).Do()

gives this error:

googleapi: Error 400: Invalid JSON payload received. Unknown name "": Root element must be a message.
Details:
[
  {
    "@type": "type.googleapis.com/google.rpc.BadRequest",
    "fieldViolations": [
      {
        "description": "Invalid JSON payload received. Unknown name \"\": Root element must be a message."
      }
    ]
  }
]

I read the docs and found no information on what TurnInStudentSubmissionRequest is. It seem its only purpose is to provide an empty request body. So, my assumption is to just include an empty struct, but i am left with a 400 bad request error stating above issue.

Am I writing this call incorrectly?

[quartzmo]

The Go client docs for TurnInStudentSubmissionRequest indeed show it as an empty struct. I will continue investigating.

[codyoss]

Instead of &classroom.TurnInStudentSubmissionRequest{} can you try setting that param to nil.

[mattszeto]

Instead of &classroom.TurnInStudentSubmissionRequest{} can you try setting that param to nil.

I had initially tried that too, same result. I can double check, if that's what worked for you, but i do remember the same error happening and then trying the empty struct.

[mattszeto]

@codyoss setting the param to nil produces the same error

[noahdietz]

I'm on rotation now so I've looked into this. I have strong reason to believe that this is either an issue in the backend (not expecting a body when it should be) or a misconfiguration of their HTTP settings (those that ultimately serve the API and are used to generate this client library). I will open a bug internally and follow up here with y'all.

[noahdietz]

@mattszeto I don't have a good way to test this API, can you reproduce the issue with curl and/or the API Explorer on the API's rest documentation?

If so, please share your findings! This will go a long way in helping us nail down the root cause.

[noahdietz]

As a sanity check, I verified that the JSON encoder used to prepare the request body reader produces a {} as expected. It does:

package main

import (
	"fmt"
	"io"

	classroom "google.golang.org/api/classroom/v1"
	"google.golang.org/api/googleapi"
)

func main() {
	req := &classroom.TurnInStudentSubmissionRequest{}
	r, err := googleapi.WithoutDataWrapper.JSONReader(req)
	if err != nil {
		fmt.Println(err)
		return
	}
	d, err := io.ReadAll(r)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Printf("marshaled: %s\n", string(d))
}

[mattszeto]

@mattszeto I don't have a good way to test this API, can you reproduce the issue with curl and/or the API Explorer on the API's rest documentation?

I was not able to reproduce the issue in the API's rest documentation or this curl:

curl --location --request POST 'https://classroom.googleapis.com/v1/courses/611043409401/courseWork/611047629407/studentSubmissions/Cg4IgKXMqOQREN_Em6rkEQ:turnIn' \
--header 'Authorization: Bearer {{token}}'

they were both successful.

As a sanity check, I verified that the JSON encoder used to prepare the request body reader produces a {} as expected.

Yes, that was my first concern, but it checked out. So I am stumped.

[noahdietz]

Thanks so much for doing that. One more favor, @mattszeto:

or this curl:

Could you try that but include an empty message body e.g. "{}"?

[mattszeto]

Could you try that but include an empty message body e.g. "{}"?

adding an empty message body produced the same 200 success response:

{}