slate/components/api-docs/v1/update-slate.js

79 lines
2.1 KiB
JavaScript

import * as React from "react";
import * as System from "~/components/system";
import CodeBlock from "~/components/system/CodeBlock";
const EXAMPLE_CODE_JS = (key, slateId) => {
return `const COLLECTION_ID = "${slateId}"
const collectionResponseData = getCollectionById(COLLECTION_ID);
const collection = collectionResponseData.slate;
collection.data.name = "New title"
const response = await fetch('https://slate.host/api/v1/update-slate', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: 'Basic ${key}', // API key
},
body: JSON.stringify({ data: collection })
});`;
};
const EXAMPLE_CODE_PY = (key, slateId) =>
`import requests
headers = {
"content-type": "application/json",
"Authorization": "Basic ${key}", # API key
}
json = { "id": "${slateId}" } # slate ID
get_collection = requests.post(
"https://slate.host/api/v1/get-slate", headers=headers, json=json
)
get_collection_response = get_collection.json()
collection = get_collection_response["slate"]
collection["data"]["name"] = "New title"
postJson = { "data": collection }
url = "https://slate.host/api/v1/update-slate"
r = requests.post(url, headers=headers, json=postJson)`;
export default class APIDocsUpdateSlate extends React.Component {
render() {
let language = this.props.language;
let key = this.props.APIKey;
let slateId = this.props.slateId;
let code = {
javascript: EXAMPLE_CODE_JS(key, slateId),
python: EXAMPLE_CODE_PY(key, slateId),
};
return (
<React.Fragment>
<System.DescriptionGroup
style={{ maxWidth: 640, marginTop: 64 }}
label="Update collection"
description="This API endpoint allows you to modify a collection by saving the response from get-slate, modifying it, and sending it back"
/>
<CodeBlock
children={code}
style={{ maxWidth: "820px" }}
language={language}
title="Update collection"
multiLang="true"
onLanguageChange={this.props.onLanguageChange}
/>
</React.Fragment>
);
}
}