storefront-api icon indicating copy to clipboard operation
storefront-api copied to clipboard

docs: Correct formatting of json/bash elements and others fixes.

Open EdwinBetanc0urt opened this issue 5 years ago • 1 comments

Related issues

Short description and why it's useful

  • Correction of identation:
// wrong format
{
    "array":
    [
        "any value"
    ],
    "object": { "key": "value"}
}

// corrected format
{
    "array": [
        "any value"
    ],
    "object": {
        "key": "value"
    }
}
  • Adding separation space after the colon in the object's key:
// wrong format
{
    "key":"value"
}

// corrected format
{
 "key":  "value"
}

Screenshots of visual changes before/after (if there are any)

Captura de pantalla de 2020-09-17 11-56-28

IMPORTANT NOTICE - Remember to update CHANGELOG.md with a description of your change

Contribution and currently important rules acceptance

EdwinBetanc0urt avatar Sep 17 '20 16:09 EdwinBetanc0urt

Corrected error in login call example.

From:

`curl 'https://your-domain.example.com/api/user/login' -H 'content-type: application/json' -H 'accept: application/json' --data-binary '"username":"[email protected]","password":"TopSecretPassword}'`

To:

curl 'https://your-domain.example.com/api/user/login' \
  -X POST \
  -H 'content-type: application/json' \
  -H 'accept: application/json' \
  --data-binary '{"username":"[email protected]","password":"TopSecretPassword"}'

Note: Did not have the type of request (POST) also in the data of the request does not open the key and missing quotes in the password.

Fixed url of the token refresh example

From: 'https://your-domain.example.com/api/user/login' To: 'https://your-domain.example.com/api/user/refresh'

EdwinBetanc0urt avatar Oct 01 '20 16:10 EdwinBetanc0urt