adlnet / xAPI-Spec

The xAPI Specification describes communication about learner activity and experiences between technologies.
https://adlnet.gov/projects/xapi/
907 stars 404 forks source link

Removed extra qs parameter alt syntax example #1059

Closed bscSCORM closed 7 years ago

bscSCORM commented 7 years ago

Removed the extra "statementId" parameter from the alternate syntax request example.

The intended xAPI method MUST be included as the value of the "method" query string parameter. The Learning Record Provider MUST NOT include any other query string parameters on the request.

andyjohnson commented 7 years ago

Hey @bscSCORM , can you make this PR at the dev branch as well? I'll merge this too since it is an edit to an example

garemoko commented 7 years ago

@andyjohnson I don't think this should go into master. It's one thing to tidy up the markdown when github broke everything but I think we need to be strict with keeping actual changes to patch releases.

garemoko commented 7 years ago

+1 to merging this into dev though. The current example is non-conformant:

Any query string parameters other than "method" MUST instead be included as a form parameter with the same name.

cr8onski commented 7 years ago

@garemoko are you talking about waiting for patch 1.0.4? If so, I think that is too long to show off a incorrect example.

If it is just a week or two to gather up all the most recent typos, etc that have been caught, I'd be for that.

garemoko commented 7 years ago

Picking up the conversation about branches here: https://github.com/adlnet/xAPI-Spec/issues/1060#issuecomment-321480704

bscSCORM commented 7 years ago

@andyjohnson I made a copy of this PR against dev as well, https://github.com/adlnet/xAPI-Spec/pull/1061

creighton commented 7 years ago

merged into dev.. closing the request to merge into master