Name on sample in Open API documentation

Options

Funny I never noticed that before. You guys are dorks.

Next thing you know, Convio will announce it knows, exactly, why the petunias thought what they did....

Tagged:

Comments

  • Oh my God!!

    There it is - I spent too much time on the getuser-client document because the first line in the document says "This method returns a constituent record. Use this method when calling from another application or SERVER." - Copy and Paste gone awry huh - Please change the aforementioned SERVER to CLIENT

  • Also big and bold titles like below might help:

    getUser (Client Version)

    or

    getUser (Server Version)

  • Kofi Hamilton:

    Oh my God!!

    There it is - I spent too much time on the getuser-client document because the first line in the document says "This method returns a constituent record. Use this method when calling from another application or SERVER." - Copy and Paste gone awry huh - Please change the aforementioned SERVER to CLIENT

    Rats, yes copy/paste gone awry. My apologies, this was my fault. I've fixed it now and apologize for the inconvience and frustration this may have caused. As for big bold letters. One thing to note is that we've organized all client methods together and all server methods together. So the right-hand grey box navigation will limit you to only the "client" methods. Also the breadcrumb trail indicates "client".

    Mea culpa for the typo.

  • tommy Spann:

    Rats, yes copy/paste gone awry. My apologies, this was my fault. I've fixed it now and apologize for the inconvience and frustration this may have caused. As for big bold letters. One thing to note is that we've organized all client methods together and all server methods together. So the right-hand grey box navigation will limit you to only the "client" methods. Also the breadcrumb trail indicates "client".

    Mea culpa for the typo.

    Hi tompkins,

    Thanks for the fix. On the title its not so much the font but the version type that I requested. As it is now both client and server documents are both titled "getUser". My experience with useability is that anyone looking for either document will dive right in without looking at the breadcrumbs or the navigation on the right. In order to save people a few minutes you can title each page differently - for the client document you can title it "getUser (client version)" and for the server document you can title it "getUser (server version)". Just my 2 cents.

  • Kofi Hamilton:

    Hi tompkins,

    Thanks for the fix. On the title its not so much the font but the version type that I requested. As it is now both client and server documents are both titled "getUser". My experience with useability is that anyone looking for either document will dive right in without looking at the breadcrumbs or the navigation on the right. In order to save people a few minutes you can title each page differently - for the client document you can title it "getUser (client version)" and for the server document you can title it "getUser (server version)". Just my 2 cents.

    Good suggestion, Kofi. I've made a change along those lines. How does this grab you?

  • Bruce Keilin:

    Good suggestion, Kofi. I've made a change along those lines. How does this grab you?

    Beautiful

Categories