/hosekit/{hoseKitId}/revise v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Hose Kits
postHoseKitIdRevise
Code samples
const inputBody = '{
"type": "object",
"properties": {
"params": {
"type": "object",
"required": [
"revision"
],
"properties": {
"revision": {
"type": "string",
"description": "The new revision string"
}
}
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':{
"type": "string"
}
};
fetch('https://goldleaf.app/api/v1/hosekit/{hoseKitId}/revise',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /hosekit/{hoseKitId}/revise
Create new revision of a hose kit
Creates a new revision of a hose kit that is already released.
Body parameter
{
"type": "object",
"properties": {
"params": {
"type": "object",
"required": ["revision"],
"properties": {
"revision": {
"type": "string",
"description": "The new revision string"
}
}
}
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Bearer token for authentication |
| hoseKitId | path | string(objectId) | true | ID of the hose kit to revise |
| body | body | object | true | none |
| » params | body | object | false | none |
| »» revision | body | string | true | The new revision string |
Example responses
403 Response
{
"type": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | New hose kit revision created successfully | None |
| 403 | Forbidden | Internal server error | string |
| 500 | Internal Server Error | Internal server error | string |
