apiaryio / language-templates Goto Github PK

I can't see them on the page, because they're strangely floated:

Firefox 30.0 @ Xubuntu.

The cURL examples are not usable on Windows (in command line prompt) due to the use of \ as multiline separator and the use of single quotes.

When there are multiple parameters in a Resource URI, and at least one with a pct-encoded character the rendered code sample show incorrect URL.

Consider following blueprint:

Request URL renders fine with:

# /notes{?foo%2Ebar}
### POST
+ Response 201 (application/json)

Appending one additional query parameter, let's say a results into incorrect URL in the example. Compare (correct):

With incorrect:

Also

The downstream effect here is that the incorrect URI is sent to the API server so the response is malformatted creating an error.

Originally reported at SO

http://support.apiary.io/forums/120125-general/suggestions/6239116-revise-header-handling-in-visual-basic-code-exampl

The current Python example implementation leverages Python 2 libraries, do you have plans to add Python 3 examples? Python 2 is now legacy and the examples can no longer be used as is.

JSON objects translated to Perl hash references use : as the separator instead of , or =>, which causes syntax errors.

There can be unbalanced braces in generated code, which causes syntax errors.

JSON containing embedded newlines is single quoted, which double escapes the newlines, causing literal \n characters to appear in embarrassing places. This can be avoided by using qq'...' or regular double quotes instead of single quotes, however that will trigger Perl's string interpolation on the entire string, so it might be necessary to only double quote the newlines:

my $hr = {
  'abc' => 'def' ."\n". 'ghi',
};

In order to see this in action, head over to the SparkPost API docs, click the < on the black background near the top right hand corner, click Create Transmission with Inline Parts Content, and scroll down to select Perl from the language dropdown.

The link in the header description of this repo gives a 404 http://blog.apiary.io/language-templates

the example python code would be much simpler if it used requests

The request Uri for the C# example code is broken for all samples, instead of the relative url the samples display "undefined"

From the sample (http://docs.pollsapi.apiary.io/):

using (var response = await httpClient.PostAsync("undefined", content))
{
    string responseData = await response.Content.ReadAsStringAsync();
}