xAPI-Spec icon indicating copy to clipboard operation
xAPI-Spec copied to clipboard

Procedure for the Exchange of Attachments: Needs Work

Open oconnetf opened this issue 9 years ago • 1 comments

Currently, the second item under "Procedure for the Exchange of Attachments" says this:

The Statement is sent using a Content-Type of multipart/mixed. Any Attachments are placed at the end of such transmissions.

For starters, the Statement is not sent; the request (or "transmission") is. So that should be improved.

It's possible that the second sentence--which lacks some technical specificity--could be removed entirely as a result of other nearby requirements. Namely:

The first part of the multipart document MUST contain the Statements themselves, with type application/json.

and

Each additional part contains the raw data for an Attachment and forms a logical part of the Statement. This capability will be available when issuing PUT or POST requests against the Statement Resource.

oconnetf avatar Nov 16 '16 21:11 oconnetf

I think it's intended as a summary so I'd keep the second sentence.

Agree that the language could stand to be tightened up.

garemoko avatar Nov 18 '16 21:11 garemoko