Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow passing additional options to curl command for "Try it out" #6288

Merged
merged 6 commits into from
Sep 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/usage/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ Parameter name | Docker variable | Description
--- | --- | -----
<a name="oauth2RedirectUrl"></a>`oauth2RedirectUrl` | `OAUTH2_REDIRECT_URL` | `String`. OAuth redirect URL.
<a name="requestInterceptor"></a>`requestInterceptor` | _Unavailable_ | `Function=(a => a)`. MUST be a function. Function to intercept remote definition, "Try it out", and OAuth 2.0 requests. Accepts one argument requestInterceptor(request) and must return the modified request, or a Promise that resolves to the modified request.
<a name="request.curlOptions"></a>`request.curlOptions` | _Unavailable_ | `Array`. If set, MUST be an array of command line options available to the `curl` command. This can be set on the mutated request in the `requestInterceptor` function. For example `request.curlOptions = ["-g", "--limit-rate 20k"]`
<a name="responseInterceptor"></a>`responseInterceptor` | _Unavailable_ | `Function=(a => a)`. MUST be a function. Function to intercept remote definition, "Try it out", and OAuth 2.0 responses. Accepts one argument responseInterceptor(response) and must return the modified response, or a Promise that resolves to the modified response.
<a name="showMutatedRequest"></a>`showMutatedRequest` | `SHOW_MUTATED_REQUEST` | `Boolean=true`. If set to `true`, uses the mutated request returned from a requestInterceptor to produce the curl command in the UI, otherwise the request before the requestInterceptor was applied is used.
<a name="supportedSubmitMethods"></a>`supportedSubmitMethods` | `SUPPORTED_SUBMIT_METHODS` | `Array=["get", "put", "post", "delete", "options", "head", "patch", "trace"]`. List of HTTP methods that have the "Try it out" feature enabled. An empty array disables "Try it out" for all operations. This does not filter the operations from the display.
Expand Down
5 changes: 5 additions & 0 deletions src/core/curlify.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ export default function curl( request ){
let isMultipartFormDataRequest = false
let headers = request.get("headers")
curlified.push( "curl" )

if (request.get("curlOptions")) {
curlified.push(...request.get("curlOptions"))
}

curlified.push( "-X", request.get("method") )
curlified.push( `"${request.get("url")}"`)

Expand Down
26 changes: 26 additions & 0 deletions test/unit/core/curlify.js
Original file line number Diff line number Diff line change
Expand Up @@ -364,4 +364,30 @@ describe("curlify", function () {

expect(curlified).toEqual("curl -X POST \"http://example.com\" -d \"RETURN \\$x + \\$y\"")
})

it("should include curlOptions from the request in the curl command", function () {
let req = {
url: "http://example.com",
method: "GET",
headers: { "X-DOLLAR": "token/123$" },
curlOptions: ["-g"]
}

let curlified = curl(Im.fromJS(req))

expect(curlified).toEqual("curl -g -X GET \"http://example.com\" -H \"X-DOLLAR: token/123\\$\"")
})

it("should include multiple curlOptions from the request in the curl command", function () {
let req = {
url: "http://example.com",
method: "GET",
headers: { "X-DOLLAR": "token/123$" },
curlOptions: ["-g", "--limit-rate 20k"]
}

let curlified = curl(Im.fromJS(req))

expect(curlified).toEqual("curl -g --limit-rate 20k -X GET \"http://example.com\" -H \"X-DOLLAR: token/123\\$\"")
})
})