Update OpenAPI settings
curl --request PUT \
--url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"openapi": {
"portalEnabled": true,
"portalSecurity": {
"type": "OIDC"
},
"validationMode": "soft",
"generateOpenApiFromStubs": true,
"generateStubsFromOpenApi": true,
"generateDefaultStubs": false
}
}
'import requests
url = "https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi"
payload = { "openapi": {
"portalEnabled": True,
"portalSecurity": { "type": "OIDC" },
"validationMode": "soft",
"generateOpenApiFromStubs": True,
"generateStubsFromOpenApi": True,
"generateDefaultStubs": False
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
openapi: {
portalEnabled: true,
portalSecurity: {type: 'OIDC'},
validationMode: 'soft',
generateOpenApiFromStubs: true,
generateStubsFromOpenApi: true,
generateDefaultStubs: false
}
})
};
fetch('https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'openapi' => [
'portalEnabled' => true,
'portalSecurity' => [
'type' => 'OIDC'
],
'validationMode' => 'soft',
'generateOpenApiFromStubs' => true,
'generateStubsFromOpenApi' => true,
'generateDefaultStubs' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi"
payload := strings.NewReader("{\n \"openapi\": {\n \"portalEnabled\": true,\n \"portalSecurity\": {\n \"type\": \"OIDC\"\n },\n \"validationMode\": \"soft\",\n \"generateOpenApiFromStubs\": true,\n \"generateStubsFromOpenApi\": true,\n \"generateDefaultStubs\": false\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"openapi\": {\n \"portalEnabled\": true,\n \"portalSecurity\": {\n \"type\": \"OIDC\"\n },\n \"validationMode\": \"soft\",\n \"generateOpenApiFromStubs\": true,\n \"generateStubsFromOpenApi\": true,\n \"generateDefaultStubs\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"openapi\": {\n \"portalEnabled\": true,\n \"portalSecurity\": {\n \"type\": \"OIDC\"\n },\n \"validationMode\": \"soft\",\n \"generateOpenApiFromStubs\": true,\n \"generateStubsFromOpenApi\": true,\n \"generateDefaultStubs\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"openapi": {
"portalEnabled": true,
"portalSecurity": {},
"validationMode": "none",
"generateOpenApiFromStubs": true,
"generateStubsFromOpenApi": true,
"generateDefaultStubs": true
}
}"Credentials are required to access this resource."{
"errors": [
{
"title": "Forbidden",
"source": {}
}
]
}Settings
Update OpenAPI settings
PUT
/
v1
/
mock-apis
/
{mockApiId}
/
settings
/
openapi
Update OpenAPI settings
curl --request PUT \
--url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"openapi": {
"portalEnabled": true,
"portalSecurity": {
"type": "OIDC"
},
"validationMode": "soft",
"generateOpenApiFromStubs": true,
"generateStubsFromOpenApi": true,
"generateDefaultStubs": false
}
}
'import requests
url = "https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi"
payload = { "openapi": {
"portalEnabled": True,
"portalSecurity": { "type": "OIDC" },
"validationMode": "soft",
"generateOpenApiFromStubs": True,
"generateStubsFromOpenApi": True,
"generateDefaultStubs": False
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
openapi: {
portalEnabled: true,
portalSecurity: {type: 'OIDC'},
validationMode: 'soft',
generateOpenApiFromStubs: true,
generateStubsFromOpenApi: true,
generateDefaultStubs: false
}
})
};
fetch('https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'openapi' => [
'portalEnabled' => true,
'portalSecurity' => [
'type' => 'OIDC'
],
'validationMode' => 'soft',
'generateOpenApiFromStubs' => true,
'generateStubsFromOpenApi' => true,
'generateDefaultStubs' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi"
payload := strings.NewReader("{\n \"openapi\": {\n \"portalEnabled\": true,\n \"portalSecurity\": {\n \"type\": \"OIDC\"\n },\n \"validationMode\": \"soft\",\n \"generateOpenApiFromStubs\": true,\n \"generateStubsFromOpenApi\": true,\n \"generateDefaultStubs\": false\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"openapi\": {\n \"portalEnabled\": true,\n \"portalSecurity\": {\n \"type\": \"OIDC\"\n },\n \"validationMode\": \"soft\",\n \"generateOpenApiFromStubs\": true,\n \"generateStubsFromOpenApi\": true,\n \"generateDefaultStubs\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"openapi\": {\n \"portalEnabled\": true,\n \"portalSecurity\": {\n \"type\": \"OIDC\"\n },\n \"validationMode\": \"soft\",\n \"generateOpenApiFromStubs\": true,\n \"generateStubsFromOpenApi\": true,\n \"generateDefaultStubs\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"openapi": {
"portalEnabled": true,
"portalSecurity": {},
"validationMode": "none",
"generateOpenApiFromStubs": true,
"generateStubsFromOpenApi": true,
"generateDefaultStubs": true
}
}"Credentials are required to access this resource."{
"errors": [
{
"title": "Forbidden",
"source": {}
}
]
}Path Parameters
The ID of the Mock API
Required string length:
5 - 10Example:
"jjl8y"
Body
application/json
OpenAPI integration settings for the mock API.
Show child attributes
Show child attributes
Response
Settings successfully updated
OpenAPI integration settings for the mock API.
Show child attributes
Show child attributes
⌘I