Jump to content

Topic on Talk:Requests for comment/SessionStorageAPI

Pchelolo (talkcontribs)

Several points regarding API consistency with other services we have:

  1. In the error response JSON you have instance property to indicate the requested URI. In other services we call the property uri
  2. We do have a tendency of returning the original request method together with the error information
EEvans (WMF) (talkcontribs)

So, instance comes from RFC7807, do you happen to know why we used uri instead (or why we added method, for that matter)?

Needing a rationale for doing it one way or another, I'm not sure I'd favor consistency with RESTBase over RFC7807 (at least not without rationale for why RESTBase is the way it is).

Also: The RESTBase online docs are wrong. They indicate that clients should expect an RFC7807 error response, and we return...well, something else.

Pchelolo (talkcontribs)

The history of this decision has vanished, it was like that even before I've joined. I don't think any application relies on this, so we can deprecate the use of uri property name and replace it with instance in all the other services.

Mobrovac-WMF (talkcontribs)

The uri part comes from the fact that we want(ed) to have a unique identifier for each resource, but yes, you are correct that it is not mentioned in RFC7807. In fact, we use uri as instance. I would be for correcting that mistake here and gradually introducing instance in other error responses we send out.

Pchelolo (talkcontribs)