Curl Request format should be updated

[danman01]

These requests in the readme should be written the same way as rails-api-template's curl requests so that we are consistent: https://github.com/ga-wdi-boston/rails-api-template

new:

curl http://localhost:4741/sign-up \
  --include \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{
    "credentials": {
      "email": "'"${EMAIL}"'",
      "password": "'"${PASSWORD}"'",
      "password_confirmation": "'"${PASSWORD}"'"
    }
  }'

[email protected] PASSWORD=hannah scripts/sign-up.sh

old:

curl --include --request POST http://localhost:4741/sign-up \
  --header "Content-Type: application/json" \
  --data '{
    "credentials": {
      "email": "[email protected]",
      "password": "an example password",
      "password_confirmation": "an example password"
    }
  }'

[gaand]

Should they reflect the API and URL_PATH from the scripts?

[danman01]

Or in the readme could we just link to the scripts?

So for POST /sign-up, we currently have:

Request:

curl http://localhost:4741/sign-up \
  --include \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{
    "credentials": {
      "email": "'"${EMAIL}"'",
      "password": "'"${PASSWORD}"'",
      "password_confirmation": "'"${PASSWORD}"'"
    }
  }'
[email protected] PASSWORD=hannah scripts/sign-up.sh

To get code out of readme and keep consistent with scripts, we could have:

Request:
view sign up curl request

Run with [email protected] PASSWORD=myPass scripts/sign-up.sh

[gaand]

I think I suggested that at one point to @jrhorn424 and I believe he objected.

[jrhorn424]

@gaand @danman01 Since we're moving toward inlining code with magic comments, I'll formally remove my objection. I no longer have a strong preference.

My objection was principled in that documentation examples are not the same thing as scripts. For example:

• The Instagram API does not even provide example scripts.
• The twilio API offers example requests, but does not offer an opinion on how a script should be structured.

I also realize that a talk intended to teach is different than documentation, but would also point out that one of the skills we want them to develop is reading documentation. Perhaps re-coding toward a well-factored script should be done starting with a copypasta script from the README on a tutorial branch.

[gaand]

https://github.com/ga-wdi-boston/ruby-template/blob/add-code-blocks/bin/add-code-block.rb