solid-spec icon indicating copy to clipboard operation
solid-spec copied to clipboard

Corrections and clarifications of REST API Spec

Open TallTed opened this issue 7 years ago • 7 comments

Some markup and language tweaks for better reader clarity; some punctuation fixes for typos.

Significant changes to the OPTIONS method section which did not conform to RFC 7231 -- https://tools.ietf.org/html/rfc7231#section-4.3.7 -- as the example was for the specific /data/ container, but the description was server-wide.

TallTed avatar Jan 22 '18 18:01 TallTed

Thanks, @TallTed! Good work.

My only question is - let's make sure that OPTIONS * actually works on node-solid-server; that might not be implemented or supported :)

dmitrizagidulin avatar Jan 24 '18 13:01 dmitrizagidulin

@dmitrizagidulin - I quite believe that OPTIONS * as in HTTP RFC 7231 section 4.3.7 "Request Methods -- Method Definitions -- OPTIONS" and 7230 section 5.3.4 "Message Routing -- Request Target -- asterisk-form" may not (yet) be implemented or supported in node-solid-server, given that the SoLiD API spec was not in such conformance on this point.

I think such lack should be considered a defect in node-solid-server, and not block correction of the SoLiD API spec, as the HTTP RFCs are prerequisites and thus take precedence over the dependent works.

TallTed avatar Jan 24 '18 15:01 TallTed

Sounds good. If you can, open an issue on node-solid-server to implement OPTIONS *. I agree that the spec should include it.

dmitrizagidulin avatar Jan 24 '18 15:01 dmitrizagidulin

@RubenVerborgh @kjetilk @dmitrizagidulin @elf-pavlik (in other words, all previous committers)

Conflicts from intervening changes resolved. Whoever can, please merge...

TallTed avatar Apr 04 '19 12:04 TallTed

Again...

@RubenVerborgh @kjetilk @dmitrizagidulin @elf-pavlik (in other words, all previous committers)

Conflicts from more intervening changes resolved. Whomever can, please merge...

TallTed avatar Jul 31 '19 21:07 TallTed

Apparently needs new reviews, since conflict re-resolution...

@pfriedman @dmitrizagidulin @gobengo were positive last round.

TallTed avatar Aug 01 '19 16:08 TallTed

@kjetilk - Understood, about the full rework. I think applying this relatively small adjustment before that full rework will result in a better end than leaving it out until after, at which point the rework may itself be broken because this error persists...

TallTed avatar Aug 02 '19 17:08 TallTed