fix rosie REST API docs

[oliver-sanders]

Fix a couple of broken examples in the docs.

[matthewrmshin]

Why doesn't the old syntax work any more?

[oliver-sanders]

I don't think this syntax was ever correct, was it?

It's an invalid URL parameter, must be ?key=value[&key2=value2...].

[matthewrmshin]

That's true.

[oliver-sanders]

It's probably either an error copied forward from the old docs or a translation error by yours truely 😦

[sadielbartholomew]

Isn't this meant to instead be:

Suggested change

	GET http://host/my_prefix/search/var+bob+nowcast&format=json HTTP/1.1
	GET http://host/my_prefix/search?s=var+bob+nowcast&format=json HTTP/1.1

The original, as with your change suggestion, both don't make sense as URL queries, but this does? To check I am not completely mistaken, I tried these URLs out on both the current ("old") & my new (PR #2288) versions of the rosie discovery utility, & the original & change here both give a 404 error.

[sadielbartholomew]

I think one of these amendments needs changing.

[sadielbartholomew]

Isn't this meant to instead be:

Suggested change

	GET http://host/my_prefix/search/var+bob+nowcast&format=json HTTP/1.1
	GET http://host/my_prefix/search?s=var+bob+nowcast&format=json HTTP/1.1

The original, as with your change suggestion, both don't make sense as URL queries, but this does? To check I am not completely mistaken, I tried these URLs out on both the current ("old") & my new (PR #2288) versions of the rosie discovery utility, & the original & change here both give a 404 error.

[oliver-sanders]

The original & change here both give a 404 error

The change doesn't give a 404, for example:

http://fcm1/rosie/mot/search/frsn

However this isn't the user facing page not the REST API! Whoops! s is what we were supposed to document here:

http://fcm1/rosie/mot/search?s=frsn

[sadielbartholomew]

Whoops! s is what we were supposed to document here

There appears to be the same issue with the query endpoint (see line 94: :param list query: List of queries) which following that logic should be :param list q:

[oliver-sanders]

Yep, that should be the last of them.

[sadielbartholomew]

Ideally we could have search?s= rather than search/?s=, at the very least for consistency with the query endpoint URL documented above it but also as it is the strict endpoint, but since it gives the same result & I am pedantic, it is not a blocker.