diff --git a/.gitignore b/.gitignore index 4125d7d..da78429 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,9 @@ openapi.json openapi.yaml +# This will be automatically generated +docs/api + # Dependencies /node_modules diff --git a/docs/api/docs.tag.mdx b/docs/api/docs.tag.mdx deleted file mode 100644 index 87ea5b2..0000000 --- a/docs/api/docs.tag.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: docs -title: "docs" -description: "docs" -custom_edit_url: null ---- - - - -API documentation endpoints - - - -```mdx-code-block -import DocCardList from '@theme/DocCardList'; -import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; - - -``` - \ No newline at end of file diff --git a/docs/api/get-api-terms-of-use.api.mdx b/docs/api/get-api-terms-of-use.api.mdx deleted file mode 100644 index b0b8cfb..0000000 --- a/docs/api/get-api-terms-of-use.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-api-terms-of-use -title: "Get API terms of use" -description: "API terms of use" -sidebar_label: "Get API terms of use" -hide_title: true -hide_table_of_contents: true -api: {"description":"API terms of use","tags":["docs"],"responses":{"200":{"description":"Terms","content":{"text/plain":{"schema":{"type":"string"}}}},"5XX":{"description":"An unexpected server error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response code"},"message":{"type":"string","description":"Human readable error message"}},"title":"GeneralError"},"example":{"code":500,"message":"Unexpected error"}}}}},"method":"get","path":"/terms","servers":[{"url":"http://localhost:{port}","description":"Local development","variables":{"port":{"default":"3000"}}},{"url":"https://api.sidingsmedia.com/","description":"Production"}],"info":{"title":"Sidings Media API","description":"General utility APIs for all Sidings Media web based services\n","version":"0.2.0","x-logo":{"url":"https://cdn.sidingsmedia.com/logo/logo-white-horizontal-short.svg","backgroundColor":"#1976D2","alt":"Sidings Media logo"}},"postman":{"name":"Get API terms of use","description":{"content":"API terms of use","type":"text/plain"},"url":{"path":["terms"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"text/plain"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs/api/sidings-media-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get API terms of use - - - -API terms of use - -
- -Terms - -
Schema
    - -string - -
- -An unexpected server error - -
Schema
- \ No newline at end of file diff --git a/docs/api/log-view-for-page.api.mdx b/docs/api/log-view-for-page.api.mdx deleted file mode 100644 index e61f7ee..0000000 --- a/docs/api/log-view-for-page.api.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: log-view-for-page -title: "Log view for page" -description: "Log a view for a given page" -sidebar_label: "Log view for page" -hide_title: true -hide_table_of_contents: true -api: {"description":"Log a view for a given page","tags":["stats"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"string","description":"Full URI of page","format":"uri"}},"required":["page"],"title":"View"}}}},"responses":{"204":{"description":"Created"},"403":{"description":"The page provided is not recognized","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response code"},"message":{"type":"string","description":"Human readable error message"}},"title":"GeneralError"},"example":{"code":403,"message":"Unrecognized domain for page"}}}},"429":{"description":"The rate limit has been exceeded","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Number of seconds until the client should retry the request\n"}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response code"},"message":{"type":"string","description":"Human readable error message"}},"title":"GeneralError"},"example":{"code":429,"message":"Too many requests"}}}},"5XX":{"description":"An unexpected server error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response code"},"message":{"type":"string","description":"Human readable error message"}},"title":"GeneralError"},"example":{"code":500,"message":"Unexpected error"}}}}},"method":"post","path":"/stats/views","servers":[{"url":"http://localhost:{port}","description":"Local development","variables":{"port":{"default":"3000"}}},{"url":"https://api.sidingsmedia.com/","description":"Production"}],"jsonRequestBodyExample":{"page":"string"},"info":{"title":"Sidings Media API","description":"General utility APIs for all Sidings Media web based services\n","version":"0.2.0","x-logo":{"url":"https://cdn.sidingsmedia.com/logo/logo-white-horizontal-short.svg","backgroundColor":"#1976D2","alt":"Sidings Media logo"}},"postman":{"name":"Log view for page","description":{"content":"Log a view for a given page","type":"text/plain"},"url":{"path":["stats","views"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs/api/sidings-media-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Log view for page - - - -Log a view for a given page - -
Request Body required
- -Created - -
- -The page provided is not recognized - -
Schema
- -The rate limit has been exceeded - -
Response Headers
  • Retry-After integer
    - -Number of seconds until the client should retry the request - - -
Schema
- -An unexpected server error - -
Schema
- \ No newline at end of file diff --git a/docs/api/messaging.tag.mdx b/docs/api/messaging.tag.mdx deleted file mode 100644 index 836e0d4..0000000 --- a/docs/api/messaging.tag.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: messaging -title: "messaging" -description: "messaging" -custom_edit_url: null ---- - - - -Communication channels between Sidings Media and the User - - - - -```mdx-code-block -import DocCardList from '@theme/DocCardList'; -import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; - - -``` - \ No newline at end of file diff --git a/docs/api/send-contact-form-message.api.mdx b/docs/api/send-contact-form-message.api.mdx deleted file mode 100644 index f5f38b1..0000000 --- a/docs/api/send-contact-form-message.api.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: send-contact-form-message -title: "Send contact form message" -description: "Send a message to Sidings Media" -sidebar_label: "Send contact form message" -hide_title: true -hide_table_of_contents: true -api: {"description":"Send a message to Sidings Media","tags":["messaging"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Users name from contact form"},"email":{"type":"string","format":"email","description":"Users email from contact form"},"subject":{"type":"string","description":"Message subject"},"message":{"type":"string","description":"Actual message from user"}},"required":["name","email","subject","message"],"title":"Message"}}}},"responses":{"204":{"description":"Created"},"400":{"description":"Request was invalid or malformed","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"GeneralError"},{"type":"object","title":"BadRequest"}]},"example":{"code":400,"message":"Request was malformed","fields":[{"field":"email","condition":"email"},{"field":"name","condition":"required"}]}}}},"429":{"description":"The rate limit has been exceeded","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Number of seconds until the client should retry the request\n"}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response code"},"message":{"type":"string","description":"Human readable error message"}},"title":"GeneralError"},"example":{"code":429,"message":"Too many requests"}}}},"5XX":{"description":"An unexpected server error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response code"},"message":{"type":"string","description":"Human readable error message"}},"title":"GeneralError"},"example":{"code":500,"message":"Unexpected error"}}}}},"method":"post","path":"/messaging/contact","servers":[{"url":"http://localhost:{port}","description":"Local development","variables":{"port":{"default":"3000"}}},{"url":"https://api.sidingsmedia.com/","description":"Production"}],"jsonRequestBodyExample":{"name":"string","email":"user@example.com","subject":"string","message":"string"},"info":{"title":"Sidings Media API","description":"General utility APIs for all Sidings Media web based services\n","version":"0.2.0","x-logo":{"url":"https://cdn.sidingsmedia.com/logo/logo-white-horizontal-short.svg","backgroundColor":"#1976D2","alt":"Sidings Media logo"}},"postman":{"name":"Send contact form message","description":{"content":"Send a message to Sidings Media","type":"text/plain"},"url":{"path":["messaging","contact"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs/api/sidings-media-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Send contact form message - - - -Send a message to Sidings Media - -
Request Body required
- -Created - -
- -Request was invalid or malformed - -
Schema
    oneOf
    fields object[]
  • Array [
  • ]
- -The rate limit has been exceeded - -
Response Headers
  • Retry-After integer
    - -Number of seconds until the client should retry the request - - -
Schema
- -An unexpected server error - -
Schema
- \ No newline at end of file diff --git a/docs/api/sidebar.js b/docs/api/sidebar.js deleted file mode 100644 index 811e87c..0000000 --- a/docs/api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"api/sidings-media-api"},{"type":"category","label":"messaging","link":{"type":"doc","id":"api/messaging"},"items":[{"type":"doc","id":"api/send-contact-form-message","label":"Send contact form message","className":"api-method post"}]},{"type":"category","label":"docs","link":{"type":"doc","id":"api/docs"},"items":[{"type":"doc","id":"api/get-api-terms-of-use","label":"Get API terms of use","className":"api-method get"}]},{"type":"category","label":"stats","items":[{"type":"doc","id":"api/log-view-for-page","label":"Log view for page","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs/api/sidings-media-api.info.mdx b/docs/api/sidings-media-api.info.mdx deleted file mode 100644 index 9e81142..0000000 --- a/docs/api/sidings-media-api.info.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: sidings-media-api -title: "Sidings Media API" -description: "General utility APIs for all Sidings Media web based services" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 0.2.0 - - - -# Sidings Media API - - - -General utility APIs for all Sidings Media web based services - - - - \ No newline at end of file