Skip to content

Duplicate curl commands in use-case markdown files to cover both Linux and Windows #244

@patricekrakow

Description

@patricekrakow

In order to support both Linux (Mac) and Windows users, I think we should duplicate our curl commands so both types of users can just copy-paste the curl commands in our documentation and run them directly on their respective computers.
The relevant differences are:

  • Single-quote, such as 'http://...', for Linux should be changed into double-quote, such as "http://...", for Windows
  • Escape character for line continuation is a non-quoted backslash - \ - for Linux, while it is a caret - ^ - for Windows.

I would suggest the following "format", as, according to my knowledge, the GitHub rendering of markdown does not have a native support of tabs:

LINUX

curl --request POST \
  --url 'http://localhost:3030/tokens' \
  --user 'public-36297346:private-ce2d3cf4' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'grant_type=client_credentials'

WINDOWS

curl --request POST ^
  --url "http://localhost:3030/tokens" ^
  --user "public-36297346:private-ce2d3cf4" ^
  --header "Content-Type: application/x-www-form-urlencoded" ^
  --data "grant_type=client_credentials"

What do you think?

Metadata

Metadata

Assignees

No one assigned

    Labels

    MUST BE DISCUSSEDMust be discussed during the next CWG meeting

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions