diff --git a/README.md b/README.md
index ca7e1be6..fa531814 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,6 @@
A RESTful API for managing your Postgres. Fetch tables, add roles, and run queries (and more).
-## Usage
-
-Full documentation: https://supabase.github.io/postgres-meta/
-
## Quickstart
Set the following ENV VARS:
diff --git a/docs/.dockerignore b/docs/.dockerignore
deleted file mode 100644
index 93f13619..00000000
--- a/docs/.dockerignore
+++ /dev/null
@@ -1,2 +0,0 @@
-node_modules
-npm-debug.log
diff --git a/docs/.editorconfig b/docs/.editorconfig
deleted file mode 100644
index 88df879c..00000000
--- a/docs/.editorconfig
+++ /dev/null
@@ -1,12 +0,0 @@
-root = true
-
-[*]
-end_of_line = lf
-indent_style = space
-indent_size = 4
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false
diff --git a/docs/.eslintrc.json b/docs/.eslintrc.json
deleted file mode 100644
index f6fb5351..00000000
--- a/docs/.eslintrc.json
+++ /dev/null
@@ -1,265 +0,0 @@
-{
- "env": {
- "es6": true,
- "node": true
- },
- "extends": "eslint:recommended",
- "rules": {
- "accessor-pairs": "error",
- "array-bracket-spacing": [
- "off",
- "never"
- ],
- "array-callback-return": "error",
- "arrow-body-style": "off",
- "arrow-parens": [
- "off",
- "as-needed"
- ],
- "arrow-spacing": [
- "error",
- {
- "after": true,
- "before": true
- }
- ],
- "block-scoped-var": "off",
- "block-spacing": "off",
- "brace-style": [
- "off",
- "stroustrup"
- ],
- "callback-return": "off",
- "camelcase": "off",
- "class-methods-use-this": "error",
- "comma-dangle": "error",
- "comma-spacing": "off",
- "comma-style": [
- "error",
- "last"
- ],
- "complexity": "off",
- "computed-property-spacing": [
- "error",
- "never"
- ],
- "consistent-return": "off",
- "consistent-this": "error",
- "curly": "off",
- "default-case": "error",
- "dot-location": [
- "off",
- "property"
- ],
- "dot-notation": [
- "error",
- {
- "allowKeywords": true
- }
- ],
- "eol-last": "error",
- "eqeqeq": "off",
- "func-call-spacing": "error",
- "func-name-matching": "off",
- "func-names": "off",
- "func-style": [
- "error",
- "declaration"
- ],
- "generator-star-spacing": "off",
- "global-require": "off",
- "guard-for-in": "off",
- "handle-callback-err": "off",
- "id-blacklist": "error",
- "id-length": "off",
- "id-match": "error",
- "indent": "off",
- "init-declarations": "off",
- "jsx-quotes": "error",
- "key-spacing": "off",
- "keyword-spacing": "off",
- "line-comment-position": "off",
- "linebreak-style": [
- "error",
- "unix"
- ],
- "lines-around-comment": "off",
- "lines-around-directive": "off",
- "max-depth": "off",
- "max-len": "off",
- "max-lines": "off",
- "max-nested-callbacks": "error",
- "max-params": "off",
- "max-statements": "off",
- "max-statements-per-line": "off",
- "multiline-ternary": [
- "off",
- "never"
- ],
- "new-parens": "error",
- "newline-after-var": "off",
- "newline-before-return": "off",
- "newline-per-chained-call": "off",
- "no-alert": "error",
- "no-array-constructor": "error",
- "no-bitwise": "off",
- "no-caller": "error",
- "no-catch-shadow": "off",
- "no-confusing-arrow": "error",
- "no-console": "off",
- "no-continue": "off",
- "no-div-regex": "error",
- "no-duplicate-imports": "error",
- "no-else-return": "off",
- "no-empty": [
- "warn",
- {
- "allowEmptyCatch": true
- }
- ],
- "no-empty-function": "off",
- "no-eq-null": "error",
- "no-eval": "error",
- "no-extend-native": "off",
- "no-extra-bind": "error",
- "no-extra-label": "error",
- "no-extra-parens": "off",
- "no-floating-decimal": "error",
- "no-global-assign": "error",
- "no-implicit-globals": "error",
- "no-implied-eval": "error",
- "no-inline-comments": "off",
- "no-inner-declarations": [
- "error",
- "functions"
- ],
- "no-invalid-this": "off",
- "no-iterator": "error",
- "no-label-var": "error",
- "no-labels": "error",
- "no-lone-blocks": "error",
- "no-lonely-if": "off",
- "no-loop-func": "off",
- "no-magic-numbers": "off",
- "no-mixed-operators": "error",
- "no-mixed-requires": "error",
- "no-multi-spaces": "off",
- "no-multi-str": "error",
- "no-multiple-empty-lines": "error",
- "no-negated-condition": "error",
- "no-nested-ternary": "off",
- "no-new": "error",
- "no-new-func": "error",
- "no-new-object": "error",
- "no-new-require": "error",
- "no-new-wrappers": "error",
- "no-octal-escape": "error",
- "no-param-reassign": "off",
- "no-path-concat": "error",
- "no-plusplus": "off",
- "no-process-env": "off",
- "no-process-exit": "off",
- "no-proto": "error",
- "no-prototype-builtins": "error",
- "no-restricted-globals": "error",
- "no-restricted-imports": "error",
- "no-restricted-modules": "error",
- "no-restricted-properties": "error",
- "no-restricted-syntax": "error",
- "no-return-assign": "off",
- "no-script-url": "error",
- "no-self-compare": "error",
- "no-sequences": "error",
- "no-shadow": "off",
- "no-shadow-restricted-names": "error",
- "no-spaced-func": "error",
- "no-sync": "off",
- "no-tabs": "off",
- "no-template-curly-in-string": "error",
- "no-ternary": "off",
- "no-throw-literal": "error",
- "no-trailing-spaces": "error",
- "no-undef-init": "error",
- "no-undefined": "warn",
- "no-underscore-dangle": "off",
- "no-unmodified-loop-condition": "error",
- "no-unneeded-ternary": [
- "error",
- {
- "defaultAssignment": true
- }
- ],
- "no-unsafe-negation": "error",
- "no-unused-expressions": "error",
- "no-unused-vars": "off",
- "no-use-before-define": "off",
- "no-useless-call": "error",
- "no-useless-computed-key": "error",
- "no-useless-concat": "off",
- "no-useless-constructor": "error",
- "no-useless-escape": "off",
- "no-useless-rename": "error",
- "no-var": "off",
- "no-void": "error",
- "no-warning-comments": "off",
- "no-whitespace-before-property": "error",
- "no-with": "error",
- "object-curly-newline": "off",
- "object-curly-spacing": "off",
- "object-property-newline": [
- "off",
- {
- "allowMultiplePropertiesPerLine": true
- }
- ],
- "object-shorthand": "off",
- "one-var": "off",
- "one-var-declaration-per-line": "error",
- "operator-assignment": "off",
- "operator-linebreak": "off",
- "padded-blocks": "off",
- "prefer-arrow-callback": "off",
- "prefer-const": "off",
- "prefer-numeric-literals": "error",
- "prefer-reflect": "off",
- "prefer-rest-params": "error",
- "prefer-spread": "error",
- "prefer-template": "off",
- "quote-props": "off",
- "quotes": "off",
- "radix": "error",
- "require-jsdoc": "off",
- "require-yield": "off",
- "rest-spread-spacing": "error",
- "semi": "off",
- "semi-spacing": "off",
- "sort-imports": "error",
- "sort-keys": "off",
- "sort-vars": "off",
- "space-before-blocks": "off",
- "space-before-function-paren": "off",
- "space-in-parens": [
- "error",
- "never"
- ],
- "space-infix-ops": "off",
- "space-unary-ops": "error",
- "spaced-comment": "off",
- "strict": "error",
- "symbol-description": "error",
- "template-curly-spacing": "error",
- "unicode-bom": [
- "error",
- "never"
- ],
- "valid-jsdoc": "off",
- "vars-on-top": "off",
- "wrap-iife": "error",
- "wrap-regex": "off",
- "yield-star-spacing": "error",
- "yoda": [
- "error",
- "never"
- ]
- }
-}
diff --git a/docs/.gitignore b/docs/.gitignore
deleted file mode 100644
index 7d8d18a7..00000000
--- a/docs/.gitignore
+++ /dev/null
@@ -1,48 +0,0 @@
-*.txt
-compare.js
-doit.sh
-source/layouts/layout*.erb
-source/images/custom_logo.*
-spectacle
-dev/
-test/
-testroot/
-
-# Logs
-logs
-*.log
-npm-debug.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules
-jspm_packages
-
-# Optional npm cache directory
-.npm
-
-# Optional REPL history
-.node_repl_history
-.idea
diff --git a/docs/.nojekyll b/docs/.nojekyll
deleted file mode 100644
index 792d6005..00000000
--- a/docs/.nojekyll
+++ /dev/null
@@ -1 +0,0 @@
-#
diff --git a/docs/.travis.yml b/docs/.travis.yml
deleted file mode 100644
index 64d92ea4..00000000
--- a/docs/.travis.yml
+++ /dev/null
@@ -1,9 +0,0 @@
-language: node_js
-node_js:
- - "node"
- - "lts/*"
- - "10"
-script:
- - npm run build
- - npm run lint
- - npm run lintejs
diff --git a/docs/Dockerfile b/docs/Dockerfile
deleted file mode 100644
index f7d9ab5b..00000000
--- a/docs/Dockerfile
+++ /dev/null
@@ -1,15 +0,0 @@
-FROM node:dubnium-alpine
-
-WORKDIR /srv/shins
-
-# install dependencies
-COPY package.json .
-RUN npm install
-
-# install the app
-COPY . .
-
-VOLUME /srv/shins/source
-
-EXPOSE 4567
-CMD [ "npm", "run", "serve" ]
diff --git a/docs/LICENSE b/docs/LICENSE
deleted file mode 100644
index 34baba5c..00000000
--- a/docs/LICENSE
+++ /dev/null
@@ -1,204 +0,0 @@
-Copyright 2008-2013 Concur Technologies, Inc.
-Copyright 2016 Mike Ralphson
-
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
diff --git a/docs/Procfile b/docs/Procfile
deleted file mode 100644
index f8762c74..00000000
--- a/docs/Procfile
+++ /dev/null
@@ -1 +0,0 @@
-web: node --optimize_for_size --max_old_space_size=460 --gc_interval=100 arapaho.js
diff --git a/docs/README.md b/docs/README.md
deleted file mode 100644
index 12017c53..00000000
--- a/docs/README.md
+++ /dev/null
@@ -1,145 +0,0 @@
-# shins
-
-### Shins Is Not Slate
-
-Beautiful static documentation for your API.
-
-
-
-Shins is a port of [Slate](https://github.com/slatedocs/slate) to Javascript / Nodejs, and would
-not be possible without all of that hard work.
-
-Version numbers of Shins aim to track the version of Slate they are compatible with.
-
-
-
-### Usage
-
-* Fork the repository
-* Clone the fork
-* Edit source/index.html.md
-* `npm install`
-* `node shins.js` (alias `npm run build`) or
- * `node shins.js --minify` or
- * `node shins.js --customcss` or
- * `node shins.js --inline` or
- * `node shins.js --unsafe` or
- * `node shins.js --no-links`
-* To add custom logo add `--logo` option with path to your logo image.
-* To use a different layout template (default `source/layouts/layout.ejs` use the `--layout` option.
-* To make the logo image link to a webpage, add `--logo-url` option with URL to link to.
-* To specify a different output filename from the default `./index.html`, use the `--output` or `-o` option.
-* To allow css-style attributes in markdown, specify the `--attr` option.
-* You can specify another location for the `source` and `pub` directories using the `--root` option.
-* To check locally: `node arapaho` or `npm run serve` and browse to [localhost:4567](http://localhost:4567) - changes to your source `.html.md` files and the `source/includes` directory will automatically be picked up and re-rendered. If you use `--launch` or `-l` or `npm run start` your default browser will be opened automatically. You can also pass `shins` options on the `arapaho` command-line.
-* Add, commit and push
-* Then (in your fork) press this button
-
-[](https://heroku.com/deploy)
-
-Or, to deploy to GitHub Pages:
-
-* Change the setting on your fork so Github Pages are served from the root directory
-* Browse to `https://{yourname}.github.io/{repository-name}`
-
-To deploy to your own web-server:
-
-If you use the option `--minify` to shins, the only things you need to take to your web host is the generated `index.html` and the contents of the `pub` directory, which should be kept relative to it, so the structure is always:
-
-```
-{whatever}/index.html
-{whatever}/pub/css/
-{whatever}/pub/js/
-```
-
-If you use the `--inline` option to shins, then everything is bundled into the `index.html` file and no `pub` directory is required. Fonts are by default loaded from this github repository, but this can be overridden with the `--fonturl` option.
-
-### Docker
-
-A `Dockerfile` is included. To build:
-
-* `docker build . -t shins:latest`
-
-to run:
-
-* `docker run -p 4567:4567 -v $(pwd)/source:/srv/shins/source shins:latest`
-
-### Multiple Shins pages / portal
-
-There is a simple example of using an [index markdown file](./source/portal.html.md) as an entry point to a collection of Shins pages [here](https://mermade.github.io/shins/portal.html).
-
-### API
-
-```javascript
-const shins = require('shins');
-let options = {};
-options.cli = false; // if true, missing files will trigger an exit(1)
-options.minify = false;
-options.customCss = false;
-options.inline = false;
-options.unsafe = false; // setting to true turns off markdown sanitisation
-options['no-links'] = false; // if true, do not automatically convert links in text to anchor tags
-//options.source = filename; // used to resolve relative paths for included files
-shins.render(markdownString, options, function(err, html) {
- // ...
-});
-```
-
-or, with Promises:
-
-```javascript
-const shins = require('shins');
-let options = {};
-options.cli = false; // if true, missing files will trigger an exit(1)
-options.minify = false;
-options.customCss = false;
-options.inline = false;
-options.unsafe = false; // setting to true turns off markdown sanitisation
-options['no-links'] = false; // if true, do not automatically convert links in text to anchor tags
-//options.source = filename; // used to resolve relative paths for included files
-options.logo = './my-custom-logo.png';
-options['logo-url'] = 'https://www.example.com';
-shins.render(markdownString, options)
-.then(html => {
- // ...
-});
-```
-
-The `err` parameter is the result of the `ejs` rendering step.
-
-Setting `customCss` to `true` will include the `pub/css/screen_overrides.css`,`pub/css/print_overrides.css` and `pub/css/theme_override.css` files, in which you can override any of the default Slate theme, to save you from having to alter the main css files directly. This should make syncing up with future Shins / Slate releases easier.
-
-Setting `inline` to `true` will inline all page resources (except resources referenced via CSS, such as fonts) to output html. This way HTML can be used stand-alone, without needing any other resources. It will also set `minify` to `true`.
-
-Set `logo` path to add your custom logo as absolute path or path relative to process working directory. If `inline` option is on image will be inlined, else it will be copied to `source/images` directory and included via `src` image attribute.
-
-Set `logo-url` if you want the logo image to link to a webpage.
-
-### Updating from Slate
-
-* Note: changes to Slate CSS, Javascript etc may break assumptions made in Shins. Use at your own risk.
-* The script `updateFromSlate` assumes you have Ruby Slate checked-out by the side of shins (i.e. in a sibling directory) and will copy .scss files, fonts, Javascript files etc.
-* The `buildstyle.js` program can be used to process the .scss files to their .css equivalents. It takes one optional **parameter**, the `outputStyle` used by `node-sass`. This can be either `nested`, `expanded`, `compact` or `compressed`. Default is `nested`. It also respects the `--root` option.
-
-### Notes
-
-* Windows is definitely supported
-* Syntax highlighting in 189 [languages](https://highlightjs.org/static/demo/) and 91 [themes](https://highlightjs.org/static/demo/) (you can specify the highlighter theme to use by setting `highlight_theme` in your slate markdown header)
-* Multiple language tabs per language are supported
-* Static TOC as per Slate v2.0
-* [GitHub emoji shortcuts](https://gist.github.com/rxaviers/7360908) are supported
-* For converting [OpenAPI / Swagger](https://github.com/OAI/OpenAPI-Specification) or [AsyncAPI](https://github.com/asyncapi/asyncapi) definitions to Shins or Slate, see [widdershins](http://github.com/mermade/widdershins)
-* `arapaho` has a `--preserve` or `-p` option which will not overwrite your `.html` output file, but still re-render when necessary
-* Shins ships with an alternate theme by [TradeGecko](https://github.com/tradegecko) which is also under the Apache 2.0 license, `pub/css/tradegecko.min.css` can be included with the `--css` option
-* Shins additionally supports [AsciiDoc](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files) `include::filename[]` syntax as well as `!INCLUDE filename` from [markdown-pp](https://github.com/MikeRalphson/markdown-pp-js) - this is not supported by Slate. See some [more information about including files](/docs/include.md).
-
-### Shins in the wild
-
-Please feel free to add a link to your API documentation here
-
-* [APIs.guru OpenAPI specification extensions (Semoasa) documentation](https://mermade.github.io/shins/apisguru.html)
-* [Signal Biometrics Ox documentation](https://signalbiometrics.github.io/ox-docs/)
-* [LeApp daemon API](https://leapp-to.github.io/shins/index.html)
-* [Shutterstock API](https://api-reference.shutterstock.com/)
-* [Shotstack Video Editing API](https://shotstack.io/docs/api/index.html)
-
diff --git a/docs/api.yml b/docs/api.yml
deleted file mode 100644
index 5886d460..00000000
--- a/docs/api.yml
+++ /dev/null
@@ -1,1114 +0,0 @@
-openapi: 3
-
-info:
- title: Postgres API
- description: |
- Manage your PostgreSQL database using a RESTful API.
-
- This is still in early development, so most of the functionality is read-only.
-
- The goal of this API is to enable the full management of a Postgres database using a RESTful interface. This includes adding tables, columns, roles, and users at runtime, as well as running ad-hoc queries.
-
- Made by Supabase: https://supabase.io
-
- # Getting started
-
- ## Usage
-
- > Basic usage
-
- ```sh
- curl -X GET http://localhost:1337/ \
- -H 'Content-Type: application/json' \
- -H 'X-Connection-Encrypted: ENCRYPTED_STRING'
- ```
- ```js
- const data = await fetch('http://localhost:1337', {
- method: 'GET',
- headers: {
- 'Content-Type': 'application/json',
- 'X-Connection-Encrypted': 'ENCRYPTED_STRING'
- }
- })
- ```
-
- For security reasons, this API is best self-hosted and set up with ENV_VARS with the default connection string.
-
- If you want to use this with multiple Postgres instances, you can pass the connection string as a header but it must be encrypted.
-
-
- ## Self Hosting
-
- ```
- https://github.com/supabase/pg-api
- ```
-
- We support several different methods for self-hosting, detailed in the [repository](https://github.com/supabase/pg-api).
-
-
- ## Authentication
-
- Authentication is not provided. Make sure you use this inside a secure network or behind a secure API proxy.
- contact:
- name: Support
- url: https://github.com/supabase/pg-api/issues/new/choose
- email: support@supabase.io
- license:
- name: Apache 2.0
- url: https://www.apache.org/licenses/LICENSE-2.0.html
- version: 0.11.5
-
-paths:
- /config:
- get:
- tags: [/config]
- summary: Get all configs
- operationId: getConfigs
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Config'
-
- /config/version:
- get:
- tags: [/config/version]
- summary: Get version
- operationId: getVersion
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Version'
-
- /query:
- post:
- tags: [/query]
- summary: Make a query
- operationId: query
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- type: object
-
- /columns:
- get:
- tags: [/columns]
- summary: Get all columns
- operationId: getColumns
- parameters:
- - name: include_system_schemas
- in: query
- schema:
- type: boolean
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Column'
-
- post:
- tags: [/columns]
- summary: Add a column
- operationId: createColumn
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- name:
- type: string
- table_id:
- type: integer
- type:
- type: string
- default_value:
- type: string
- is_identity:
- type: boolean
- is_nullable:
- type: boolean
- is_primary_key:
- type: boolean
- is_unique:
- type: boolean
- required: [name, table_id, type]
- required: true
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Column'
-
- /columns/{id}:
- parameters:
- - name: id
- in: path
- required: true
- schema:
- type: string
- pattern: '\d+\.\d+'
-
- patch:
- tags: [/columns]
- summary: Update a column by ID
- operationId: updateColumn
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- name:
- type: string
- type:
- type: string
- drop_default:
- type: boolean
- default_value:
- type: string
- is_nullable:
- type: boolean
- required: true
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Column'
-
- delete:
- tags: [/columns]
- summary: Delete a column by ID
- operationId: deleteColumn
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Column'
-
- /extensions:
- get:
- tags: [/extensions]
- summary: Get all extensions
- operationId: getExtensions
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Extension'
-
- post:
- tags: [/extensions]
- summary: Install an extension
- operationId: createExtension
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- name:
- type: string
- schema:
- type: string
- version:
- type: string
- cascade:
- type: boolean
- required: [name]
- required: true
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Extension'
-
- /extensions/{id}:
- parameters:
- - name: id
- in: path
- required: true
- schema:
- type: integer
-
- patch:
- tags: [/extensions]
- summary: Update/modify an extension by ID
- operationId: updateExtension
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- update:
- type: boolean
- version:
- type: string
- schema:
- type: string
- required: true
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Extension'
-
- delete:
- tags: [/extensions]
- summary: Uninstall an extension by ID
- operationId: deleteExtension
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Extension'
-
- /functions:
- get:
- tags: [/functions]
- summary: Get all functions
- operationId: getFunctions
- parameters:
- - name: include_system_schemas
- in: query
- schema:
- type: boolean
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Function'
-
- /policies:
- get:
- tags: [/policies]
- summary: Get all policies
- operationId: getPolicies
- parameters:
- - name: include_system_schemas
- in: query
- schema:
- type: boolean
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Policy'
-
- post:
- tags: [/policies]
- summary: Create a policy
- operationId: createPolicy
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- name:
- type: string
- schema:
- type: string
- table:
- type: string
- required: [name, table]
- required: true
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Policy'
-
- /policies/{id}:
- parameters:
- - name: id
- in: path
- required: true
- schema:
- type: integer
-
- patch:
- tags: [/policies]
- summary: Update a policy by ID
- operationId: updatePolicy
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- name:
- type: string
- schema:
- type: string
- table:
- type: string
- required: true
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Policy'
-
- delete:
- tags: [/policies]
- summary: Delete a policy by ID
- operationId: deletePolicy
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Policy'
-
- /roles:
- get:
- tags: [/roles]
- summary: Get all roles
- operationId: getRoles
- parameters:
- - name: include_system_schemas
- in: query
- schema:
- type: boolean
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Role'
-
- post:
- tags: [/roles]
- summary: Create a role
- operationId: createRole
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- name:
- type: string
- is_superuser:
- type: boolean
- can_create_db:
- type: boolean
- can_create_role:
- type: boolean
- inherit_role:
- type: boolean
- can_login:
- type: boolean
- is_replication_role:
- type: boolean
- can_bypass_rls:
- type: boolean
- connection_limit:
- type: integer
- password:
- type: string
- valid_until:
- type: string
- member_of:
- type: array
- items:
- type: string
- members:
- type: array
- items:
- type: string
- admins:
- type: array
- items:
- type: string
- required: [name]
- required: true
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Role'
-
- /roles/{id}:
- parameters:
- - name: id
- in: path
- required: true
- schema:
- type: integer
-
- patch:
- tags: [/roles]
- summary: Update a role by ID
- operationId: updateRole
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- name:
- type: string
- is_superuser:
- type: boolean
- can_create_db:
- type: boolean
- can_create_role:
- type: boolean
- inherit_role:
- type: boolean
- can_login:
- type: boolean
- is_replication_role:
- type: boolean
- can_bypass_rls:
- type: boolean
- connection_limit:
- type: integer
- password:
- type: string
- valid_until:
- type: string
- required: true
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Role'
-
- delete:
- tags: [/roles]
- summary: Delete a role by ID
- operationId: deleteRole
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Role'
-
- /schemas:
- get:
- tags: [/schemas]
- summary: Get all schemas
- operationId: getSchemas
- parameters:
- - name: include_system_schemas
- in: query
- schema:
- type: boolean
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Schema'
-
- post:
- tags: [/schemas]
- summary: Create a schema
- operationId: createSchema
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- name:
- type: string
- owner:
- type: string
- required: [name, owner]
- required: true
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Schema'
-
- /schemas/{id}:
- parameters:
- - name: id
- in: path
- required: true
- schema:
- type: integer
-
- patch:
- tags: [/schemas]
- summary: Update a schema by ID
- operationId: updateSchema
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- name:
- type: string
- owner:
- type: string
- required: true
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Schema'
-
- delete:
- tags: [/schemas]
- summary: Delete a schema by ID
- operationId: deleteSchema
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Schema'
-
- /tables:
- get:
- tags: [/tables]
- summary: Get all tables
- operationId: getTables
- parameters:
- - name: include_system_schemas
- in: query
- schema:
- type: boolean
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Table'
-
- post:
- tags: [/tables]
- summary: Create a table
- operationId: createTable
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- name:
- type: string
- schema:
- type: string
- required: [name]
- required: true
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Table'
-
- /tables/{id}:
- parameters:
- - name: id
- in: path
- required: true
- schema:
- type: integer
-
- patch:
- tags: [/tables]
- summary: Update a table by ID
- operationId: updateTable
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- schema:
- type: string
- name:
- type: string
- rls_enabled:
- type: boolean
- rls_forced:
- type: boolean
- required: true
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Table'
-
- delete:
- tags: [/tables]
- summary: Delete a table by ID
- operationId: deleteTable
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Table'
-
- /types:
- get:
- tags: [/types]
- summary: Get all types
- operationId: getTypes
- parameters:
- - name: include_system_schemas
- in: query
- schema:
- type: boolean
- responses:
- '200':
- description: Successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Type'
-
-components:
- schemas:
- Column:
- type: object
- properties:
- table_id:
- type: integer
- schema:
- type: string
- table:
- type: string
- id:
- type: string
- pattern: '\d+\.\d+'
- ordinal_position:
- type: integer
- name:
- type: string
- default_value:
- type: string
- data_type:
- type: string
- format:
- type: string
- description:
- type: string
- is_identity:
- type: boolean
- identity_generation:
- type: string
- is_nullable:
- type: boolean
- is_updatable:
- type: boolean
- enums:
- type: array
- items:
- type: string
-
- Config:
- type: object
- properties:
- name:
- type: string
- setting:
- type: string
- category:
- type: string
- group:
- type: string
- subgroup:
- type: string
- unit:
- type: string
- nullable: true
- short_desc:
- type: string
- extra_desc:
- type: string
- nullable: true
- context:
- type: string
- vartype:
- type: string
- source:
- type: string
- min_val:
- type: string
- nullable: true
- max_val:
- type: string
- nullable: true
- enumvals:
- type: array
- items:
- type: string
- nullable: true
- boot_val:
- type: string
- reset_val:
- type: string
- sourcefile:
- type: string
- nullable: true
- sourceline:
- type: integer
- nullable: true
- pending_restart:
- type: boolean
-
- Extension:
- type: object
- properties:
- name:
- type: string
- comment:
- type: string
- default_version:
- type: string
- installed_version:
- type: string
-
- Function:
- type: object
- properties:
- id:
- type: integer
- schema:
- type: string
- name:
- type: string
- language:
- type: string
- definition:
- type: string
- argument_types:
- type: string
- return_type:
- type: string
-
- Grant:
- type: object
- properties:
- table_id:
- type: integer
- grantor:
- type: string
- grantee:
- type: string
- catalog:
- type: string
- schema:
- type: string
- table_name:
- type: string
- privilege_type:
- type: string
- is_grantable:
- type: boolean
- with_hierarchy:
- type: boolean
-
- Policy:
- type: object
- properties:
- id:
- type: integer
- name:
- type: string
- schema:
- type: string
- table:
- type: string
- table_id:
- type: integer
- action:
- type: string
- enum: [PERMISSIVE, RESTRICTIVE]
- roles:
- type: array
- items:
- type: string
- command:
- type: string
- definition:
- type: string
- check:
- type: string
- nullable: true
-
- Role:
- type: object
- properties:
- id:
- type: integer
- name:
- type: string
- is_superuser:
- type: boolean
- can_create_db:
- type: boolean
- can_create_role:
- type: boolean
- inherit_role:
- type: boolean
- can_login:
- type: boolean
- is_replication_role:
- type: boolean
- can_bypass_rls:
- type: boolean
- active_connections:
- type: integer
- connection_limit:
- type: integer
- password:
- type: string
- valid_until:
- type: string
- nullable: true
- config:
- type: string
- nullable: true
- grants:
- type: array
- items:
- $ref: '#/components/schemas/Grant'
-
- Schema:
- type: object
- properties:
- id:
- type: integer
- catalog_name:
- type: string
- name:
- type: string
- owner:
- type: string
- default_character_set_catalog:
- type: string
- nullable: true
- default_character_set_schema:
- type: string
- nullable: true
- default_character_set_name:
- type: string
- nullable: true
- sql_path:
- type: string
- nullable: true
-
- Table:
- type: object
- properties:
- id:
- type: integer
- catalog:
- type: string
- schema:
- type: string
- name:
- type: string
- is_insertable_into:
- type: boolean
- rls_enabled:
- type: boolean
- rls_forced:
- type: boolean
- is_typed:
- type: boolean
- bytes:
- type: integer
- size:
- type: string
- seq_scan_count:
- type: integer
- seq_row_read_count:
- type: integer
- idx_scan_count:
- type: integer
- idx_row_read_count:
- type: integer
- row_ins_count:
- type: integer
- row_upd_count:
- type: integer
- row_del_count:
- type: integer
- row_hot_upd_count:
- type: integer
- live_row_count:
- type: integer
- dead_row_count:
- type: integer
- rows_mod_since_analyze:
- type: integer
- last_vacuum:
- type: string
- nullable: true
- last_autovacuum:
- type: string
- nullable: true
- last_analyze:
- type: string
- nullable: true
- last_autoanalyze:
- type: string
- nullable: true
- vacuum_count:
- type: integer
- autovacuum_count:
- type: integer
- analyze_count:
- type: integer
- autoanalyze_count:
- type: integer
- columns:
- type: array
- items:
- $ref: '#/components/schemas/Column'
- grants:
- type: array
- items:
- $ref: '#/components/schemas/Grant'
- policies:
- type: array
- items:
- $ref: '#/components/schemas/Policy'
- primary_keys:
- type: array
- items:
- type: object
- properties:
- schema:
- type: string
- table_name:
- type: string
- name:
- type: string
- table_id:
- type: integer
- relationships:
- type: array
- items:
- type: object
- properties:
- source_schema:
- type: string
- source_table_name:
- type: string
- source_column_name:
- type: string
- target_table_schema:
- type: string
- target_table_name:
- type: string
- target_column_name:
- type: string
- constraint_name:
- type: string
-
- Type:
- type: object
- properties:
- id:
- type: integer
- name:
- type: string
- schema:
- type: string
- format:
- type: string
- description:
- type: string
- nullable: true
- enums:
- type: array
- items:
- type: string
-
- Version:
- type: object
- properties:
- version:
- type: string
- version_number:
- type: integer
- active_connections:
- type: integer
- max_connections:
- type: integer
diff --git a/docs/apisguru.html b/docs/apisguru.html
deleted file mode 100644
index 43ef3789..00000000
--- a/docs/apisguru.html
+++ /dev/null
@@ -1,981 +0,0 @@
-
-
-
-
-
A property of the info object, x-apiClientRegistration includes a URL-formatted property url containing the URL to the resource where developers can register to authenticate with the API.
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
In the OpenAPI specification v3.x, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
x-apisguru-categories
-
-
x-apisguru-categories example
-
-
[
- "string"
-]
-
-
-string
-
-
-
A property of the info object, x-apisguru-categories is an array of valid values from the list of APIs.guru categories.
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
In the OpenAPI specification v3.x, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
x-description-language
-
-
x-description-language example
-
-
"string"
-
-
string
-
-
-
An ISO-639 two-character language code to identify the natural language used in descriptions, summaries and titles. This can be used as an input to translating these items.
-
-
-
-
Property
-
Type
-
Required
-
Description
-
-
-
-
-
simple
-
string
-
false
-
No description
-
-
-
-
In the OpenAPI specification v2.0, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
In the OpenAPI specification v3.x, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
x-hasEquivalentPaths
-
-
x-hasEquivalentPaths example
-
-
true
-
-
true
-
-
-
A property of the root object, x-hasEquivalentPaths indicates the source specification has multiple paths which map to the same OpenAPI path (possibly disambiguated with HTML fragment identifiers or differently named path parameters).
-
-
-
-
Property
-
Type
-
Required
-
Description
-
-
-
-
-
simple
-
boolean
-
false
-
No description
-
-
-
-
In the OpenAPI specification v2.0, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
In the OpenAPI specification v3.x, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
A property of the info object, the x-origin structure is used to document the source and format of an API in the collection. It is used to round-trip the process of keeping the APIs updated.
-
Please note, if you include an x-origin extension within your API definition APIs.guru will then append to this array if it exists, allowing an audit trail of the source(s) of an API definition.
-Valid values for format
-
-
swagger
-
api_blueprint
-
raml
-
google
-
-
In your own x-origin entries you may alternatively use a contentType property instead of a format property. The version property is then optional.
-
You may also specify the converter and version used.
-
-
-
-
Property
-
Type
-
Required
-
Description
-
-
-
-
-
anonymous
-
[object]
-
false
-
No description
-
-
-
» url
-
string(uri-ref)
-
true
-
No description
-
-
-
» format
-
string
-
false
-
No description
-
-
-
» version
-
string
-
false
-
No description
-
-
-
» contentType
-
string
-
false
-
No description
-
-
-
» converter
-
object
-
false
-
No description
-
-
-
»» url
-
string(uri-ref)
-
false
-
No description
-
-
-
»» version
-
string
-
false
-
No description
-
-
-
-
In the OpenAPI specification v2.0, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
In the OpenAPI specification v3.x, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
x-preferred
-
-
x-preferred example
-
-
"string"
-
-
string
-
-
-
A property of the info object, x-preferred is a Boolean property which distinguishes between multiple versions of the same API. Where the x-providerName and x-serviceName are the same, only one definition should be marked x-preferred: true. This helps users of the APIs.guru collection organise and display the APIs.
-
-
-
-
Property
-
Type
-
Required
-
Description
-
-
-
-
-
simple
-
string
-
false
-
No description
-
-
-
-
In the OpenAPI specification v2.0, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
In the OpenAPI specification v3.x, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
x-providerName
-
-
x-providerName example
-
-
"string"
-
-
string
-
-
-
A property of the info object, x-providerName is used to identify the domain of the API host. It is added automatically by APIs.guru
-
-
-
-
Property
-
Type
-
Required
-
Description
-
-
-
-
-
simple
-
string
-
false
-
No description
-
-
-
-
In the OpenAPI specification v2.0, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
In the OpenAPI specification v3.x, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
x-serviceName
-
-
x-serviceName example
-
-
"string"
-
-
string
-
-
-
A property of the info object, x-serviceName is used to distinguish APIs which are served from the same domain. It may be the subdomain if the API uses one. It is added automatically by APIs.guru
-
-
-
-
Property
-
Type
-
Required
-
Description
-
-
-
-
-
simple
-
string
-
false
-
No description
-
-
-
-
In the OpenAPI specification v2.0, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
In the OpenAPI specification v3.x, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
x-tags
-
-
x-tags example
-
-
[
- "string"
-]
-
-
-string
-
-
-
Also a property of the info object, x-tags is an array of free-form keywords/tags applicable to the API.
-
-
-
-
Property
-
Type
-
Required
-
Description
-
-
-
-
-
anonymous
-
[string]
-
false
-
No description
-
-
-
-
In the OpenAPI specification v2.0, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
In the OpenAPI specification v3.x, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
x-unofficialSpec
-
-
x-unofficialSpec example
-
-
true
-
-
true
-
-
-
A property of the info object, x-unofficialSpec indicates the definition is produced by a third-party, either manually, by scraping existing documentation or converting a proprietary/undocumented format.
-
-
-
-
Property
-
Type
-
Required
-
Description
-
-
-
-
-
simple
-
boolean
-
false
-
No description
-
-
-
-
In the OpenAPI specification v2.0, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
-
-
-
-
In the OpenAPI specification v3.x, this extension can be used as follows:
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
Multiline description of what this action does. It allows Markdown.
-
Headers
-
Properties
-
-
-
-
Name
-
Type
-
Required
-
Description
-
-
-
-
-
qos
-
integer
-
false
-
Quality of Service
-
-
-
retainFlag
-
boolean
-
false
-
This flag determines if the message will be saved by the broker for the specified topic as last known good value. New clients that subscribe to that topic will receive the last retained message on that topic instantly after subscribing. More on retained messages and best practices in one of the next posts.
This flag determines if the message will be saved by the broker for the specified topic as last known good value. New clients that subscribe to that topic will receive the last retained message on that topic instantly after subscribing. More on retained messages and best practices in one of the next posts.
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
-
-
Manage your PostgreSQL database using a RESTful API.
-
This is still in early development, so most of the functionality is read-only.
-
The goal of this API is to enable the full management of a Postgres database using a RESTful interface. This includes adding tables, columns, roles, and users at runtime, as well as running ad-hoc queries.
Simply construct your TOC using markdown headings and links
-
-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse at mi vulputate, venenatis mauris in, ullamcorper tortor. Aliquam erat volutpat. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Curabitur eleifend enim a leo luctus fermentum. Vivamus vel ultrices nisl, et fermentum nisi. Etiam pharetra est eget justo venenatis, egestas posuere est malesuada. Aenean viverra bibendum magna, quis ultrices libero eleifend ac. Donec placerat venenatis nisl sed fermentum. In sollicitudin libero non dignissim porta. Phasellus nulla augue, malesuada vel cursus id, pellentesque venenatis est. Nullam tincidunt imperdiet tellus, non feugiat mauris cursus auctor. Mauris a nulla nec mauris accumsan faucibus vel id lectus. Mauris feugiat et justo eget efficitur. Donec congue dui et porta interdum. Ut a ante a lectus aliquet porttitor. Nam ullamcorper vel ex et feugiat.
Specifies the integration of the method with the backend.
-
Specifies details of the backend integration used for this method.
-This extension is an extended property of the Swagger Operation object.
-The result is an API Gateway integration object.
An API-specific tag group of related cached parameters.
-
-
-
credentials
-
string
-
false
-
For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role. If unspecified, credentials will default to resource-based permissions that must be added manually to allow the API to access the resource. For more information, see Granting Permissions Using a Resource Policy.
-
-
-
contentHandling
-
string
-
false
-
Request payload encoding conversion types. Valid values are 1) CONVERT_TO_TEXT, for converting a binary payload into a Base64-encoded string or converting a text payload into a utf-8-encoded string or passing through the text payload natively without modification, and 2) CONVERT_TO_BINARY, for converting a text payload into Base64-decoded blob or passing through a binary payload natively without modification.
-
-
-
httpMethod
-
string
-
false
-
The HTTP method used in the integration request. For Lambda function invocations, the value must be POST.
-
-
-
cacheKeyParameters
-
[string]
-
false
-
A list of request parameters whose values are to be cached.
-
-
-
-
In the OpenAPI specification v2.0, this extension can be used as follows:
-
-
diff --git a/docs/shins.js b/docs/shins.js
deleted file mode 100755
index 2cf083dd..00000000
--- a/docs/shins.js
+++ /dev/null
@@ -1,57 +0,0 @@
-#!/usr/bin/env node
-// @ts-check
-
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const options = require('tiny-opts-parser')(process.argv);
-const shins = require('./index.js');
-
-if (options.customcss) options.customCss = options.customcss; // backwards compatibility
-
-var inputName = './source/index.html.md';
-
-if (options._.length > 2) {
- inputName = options._[2];
-}
-
-if (options.h) options.help = options.h;
-if (options.a) options.attr = options.a;
-if (options.l) options.layout = options.l;
-if (options.o) options.output = options.o;
-if (options.r) options.root = options.r;
-
-if (options.help) {
- console.log('Usage: node shins [options] [input-markdown-filename]');
- console.log();
- console.log('-h,--help show help and exit');
- console.log('-a,--attr allow css attributes in markdown');
- console.log('--customcss include custom override css files');
- console.log('--fonturl url to fonts when --inline is set, defaults to github repo');
- console.log('--inline inline css and javascript resources');
- console.log('-l,--layout specify path to template file in .ejs format')
- console.log('--logo specify path to custom logo file');
- console.log('--logo-url url to link to from logo image');
- console.log('--css specify path to additional css file')
- console.log('--minify minify output html');
- console.log('-o,--output specify output html file');
- console.log('-r,--root specify root directory containing source and pub directories');
- console.log('--unsafe do not sanitise input markdown');
- console.log('--no-links do not automatically convert links in text to anchor tags');
- process.exit(0);
-}
-
-var inputStr = fs.readFileSync(inputName,'utf8');
-options.source = inputName;
-options.cli = true;
-
-shins.render(inputStr,options,function(err,str){
- if (err) {
- console.log(err);
- }
- else {
- str = str.split('\r').join('');
- fs.writeFileSync(options.output||path.join(options.root,'index.html'),str,'utf8');
- }
-});
diff --git a/docs/source/apisguru.html.md b/docs/source/apisguru.html.md
deleted file mode 100644
index 95b823ed..00000000
--- a/docs/source/apisguru.html.md
+++ /dev/null
@@ -1,923 +0,0 @@
----
-title: Semoasa documentation
-language_tabs:
- - json
- - yaml
-toc_footers: []
-includes: []
-search: true
-highlight_theme: darkula
-
----
-
-# OpenAPI Extensions Documentation
-
-> Scroll down for schema examples. Select a format for examples from the tabs above or the mobile navigation menu.
-
-This documentation was automatically generated from a v0.1.0 [Semoasa](https://github.com/RepreZen/SEMOASA) document.
-
-Semoasa is a machine-readable format for extensions to Swagger/OpenAPI 2.0 and 3.0 specifications.
-
-
-
-
-# guru.apis
-
-
-
-
-Provider: APIs.guru
-
-
-
-
-
-## x-apiClientRegistration
-> x-apiClientRegistration example
-```json
-{
- "url": "https://developer.bbc.co.uk/user/register"
-}
-```
-```yaml
-url: 'https://developer.bbc.co.uk/user/register'
-
-```
-
-
-
-
-
-*A link to a sign-up page for the API.*
-
-A property of the info object, x-apiClientRegistration includes a URL-formatted property url containing the URL to the resource where developers can register to authenticate with the API.
-
-
-
-
-APIs.guru OpenAPI Directory Wiki
-
-
-
-
-|Property|Type|Required|Description
-|---|---|---|---|
-|url|string(uri-ref)|true|No description|
-
-
-
-**In the OpenAPI specification v2.0, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-**In the OpenAPI specification v3.x, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-
-## x-apisguru-categories
-> x-apisguru-categories example
-```json
-[
- "string"
-]
-```
-```yaml
-- string
-
-```
-
-
-
-
-
-
-
-A property of the info object, `x-apisguru-categories` is an array of valid values from the list of APIs.guru categories.
-
-
-
-
-APIs.guru OpenAPI Directory Wiki
-
-
-
-
-|Property|Type|Required|Description
-|---|---|---|---|
-|anonymous|[string]|false|No description|
-
-
-
-**In the OpenAPI specification v2.0, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-**In the OpenAPI specification v3.x, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-
-## x-description-language
-> x-description-language example
-```json
-"string"
-```
-```yaml
-string
-
-```
-
-
-
-
-
-
-
-An ISO-639 two-character language code to identify the natural language used in descriptions, summaries and titles. This can be used as an input to translating these items.
-
-
-
-
-
-
-
-|Property|Type|Required|Description
-|---|---|---|---|
-|simple|string|false|No description|
-
-
-
-**In the OpenAPI specification v2.0, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-**In the OpenAPI specification v3.x, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-
-## x-hasEquivalentPaths
-> x-hasEquivalentPaths example
-```json
-true
-```
-```yaml
-true
-
-```
-
-
-
-
-
-
-
-A property of the `root` object, `x-hasEquivalentPaths` indicates the source specification has multiple paths which map to the same OpenAPI path (possibly disambiguated with HTML fragment identifiers or differently named path parameters).
-
-
-
-
-
-
-
-|Property|Type|Required|Description
-|---|---|---|---|
-|simple|boolean|false|No description|
-
-
-
-**In the OpenAPI specification v2.0, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|SwaggerObject|Description not found|
-
-
-
-
-
-
-
-
-
-
-
-**In the OpenAPI specification v3.x, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|OpenAPIObject|Description not found|
-
-
-
-
-
-
-
-
-
-
-
-
-## x-logo
-> x-logo example
-```json
-{
- "url": "string",
- "backgroundColor": "string"
-}
-```
-```yaml
-url: string
-backgroundColor: string
-
-```
-
-
-
-
-
-*A logo for the API.*
-
-A property of the `info` object, the `x-logo` structure holds an absolute URL to the API logo and an optional background colour in HTML hex notation.
-
-
-
-
-
-APIs.guru OpenAPI Directory Wiki
-
-
-
-
-|Property|Type|Required|Description
-|---|---|---|---|
-|url|string(uri-ref)|true|No description|
-|backgroundColor|string|false|No description|
-
-
-
-**In the OpenAPI specification v2.0, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-**In the OpenAPI specification v3.x, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-
-## x-origin
-> x-origin example
-```json
-[
- {
- "url": "http://programmes.api.bbc.com/nitro/api",
- "contentType": "application/json",
- "converter": {
- "url": "https://github.com/mermade/bbcparse",
- "version": "1.2.0"
- }
- },
- {
- "format": "swagger",
- "url": "https://raw.githubusercontent.com/Mermade/bbcparse/master/iblApi/swagger.json",
- "version": "2.0"
- }
-]
-```
-```yaml
-- url: 'http://programmes.api.bbc.com/nitro/api'
- contentType: application/json
- converter:
- url: 'https://github.com/mermade/bbcparse'
- version: 1.2.0
-- format: swagger
- url: >-
- https://raw.githubusercontent.com/Mermade/bbcparse/master/iblApi/swagger.json
- version: '2.0'
-
-```
-
-
-
-
-
-
-
-A property of the `info` object, the `x-origin` structure is used to document the source and format of an API in the collection. It is used to round-trip the process of keeping the APIs updated.
-
-Please note, if you include an x-origin extension within your API definition APIs.guru will then append to this array if it exists, allowing an audit trail of the source(s) of an API definition.
-Valid values for format
-
- * swagger
- * api_blueprint
- * raml
- * google
-
-In your own `x-origin` entries you may alternatively use a contentType property instead of a format property. The version property is then optional.
-
-You may also specify the converter and version used.
-
-
-
-
-
-
-
-
-|Property|Type|Required|Description
-|---|---|---|---|
-|anonymous|[object]|false|No description|
-|» url|string(uri-ref)|true|No description|
-|» format|string|false|No description|
-|» version|string|false|No description|
-|» contentType|string|false|No description|
-|» converter|object|false|No description|
-|»» url|string(uri-ref)|false|No description|
-|»» version|string|false|No description|
-
-
-
-**In the OpenAPI specification v2.0, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-**In the OpenAPI specification v3.x, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-
-## x-preferred
-> x-preferred example
-```json
-"string"
-```
-```yaml
-string
-
-```
-
-
-
-
-
-
-
-A property of the `info` object, `x-preferred` is a Boolean property which distinguishes between multiple versions of the same API. Where the `x-providerName` and `x-serviceName` are the same, only one definition should be marked `x-preferred: true`. This helps users of the APIs.guru collection organise and display the APIs.
-
-
-
-
-
-
-
-|Property|Type|Required|Description
-|---|---|---|---|
-|simple|string|false|No description|
-
-
-
-**In the OpenAPI specification v2.0, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-**In the OpenAPI specification v3.x, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-
-## x-providerName
-> x-providerName example
-```json
-"string"
-```
-```yaml
-string
-
-```
-
-
-
-
-
-
-
-A property of the `info` object, `x-providerName` is used to identify the domain of the API host. It is added automatically by APIs.guru
-
-
-
-
-
-
-
-|Property|Type|Required|Description
-|---|---|---|---|
-|simple|string|false|No description|
-
-
-
-**In the OpenAPI specification v2.0, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-**In the OpenAPI specification v3.x, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-
-## x-serviceName
-> x-serviceName example
-```json
-"string"
-```
-```yaml
-string
-
-```
-
-
-
-
-
-
-
-A property of the `info` object, `x-serviceName` is used to distinguish APIs which are served from the same domain. It may be the subdomain if the API uses one. It is added automatically by APIs.guru
-
-
-
-
-
-
-
-|Property|Type|Required|Description
-|---|---|---|---|
-|simple|string|false|No description|
-
-
-
-**In the OpenAPI specification v2.0, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-**In the OpenAPI specification v3.x, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-
-## x-tags
-> x-tags example
-```json
-[
- "string"
-]
-```
-```yaml
-- string
-
-```
-
-
-
-
-
-
-
-Also a property of the `info` object, `x-tags` is an array of free-form keywords/tags applicable to the API.
-
-
-
-
-
-
-
-|Property|Type|Required|Description
-|---|---|---|---|
-|anonymous|[string]|false|No description|
-
-
-
-**In the OpenAPI specification v2.0, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-**In the OpenAPI specification v3.x, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-
-## x-unofficialSpec
-> x-unofficialSpec example
-```json
-true
-```
-```yaml
-true
-
-```
-
-
-
-
-
-
-
-A property of the `info` object, `x-unofficialSpec` indicates the definition is produced by a third-party, either manually, by scraping existing documentation or converting a proprietary/undocumented format.
-
-
-
-
-
-
-
-|Property|Type|Required|Description
-|---|---|---|---|
-|simple|boolean|false|No description|
-
-
-
-**In the OpenAPI specification v2.0, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-**In the OpenAPI specification v3.x, this extension can be used as follows:**
-
-
-
-
-
-|Object|Description|
-|---|---|
-|InfoObject|The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.|
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/source/asyncapi.html.md b/docs/source/asyncapi.html.md
deleted file mode 100644
index d8618a75..00000000
--- a/docs/source/asyncapi.html.md
+++ /dev/null
@@ -1,417 +0,0 @@
----
-title: AsyncAPI Sample v1.0.0
-language_tabs:
- - javascript--nodejs: Node.JS
- - javascript: JavaScript
- - ruby: Ruby
- - python: Python
- - java: Java
- - go: Go
-headingLevel: 3
-toc_footers:
- - 'See OpenAPI example'
-includes: []
-search: true
-highlight_theme: darkula
-
----
-
-# AsyncAPI Sample v1.0.0
-
-> Scroll down for code samples, example headers and payloads. Select a language for code samples from the tabs above or the mobile navigation menu.
-
-This is a simple example of an _AsyncAPI_ document.
-
-Base URLs:
-
-* mqtt://api.company.com:{port}/{app-id}
-
- * **app-id** - You can find your `app-id` in our control panel, under the auth tab. Default: demo
-
- * **port** - Default: 5676
-
- * 5676
- * 5677
-
-Base Topic: **hitch**
-
-Terms of service
-
-# user
-
-## accounts.1.0.action.user.signup
-
-### publish
-
-Note: **Deprecated**
-
-> Example headers
-
-```json
-
-{
- "qos": 1,
- "retainFlag": false
-}
-```
-
-> Example payload
-
-```json
-
-{
- "user": {
- "full_name": "string",
- "username": "string"
- },
- "signup": {
- "method": "email",
- "datetime": "2018-04-03T07:32:55Z"
- }
-}
-```
-
-> Code Samples
-
-```javascript--nodejs
-const hermes = require('hermesjs');
-const app = hermes();
-
-app.from.client.send({
- topic: 'accounts.1.0.action.user.signup',
- payload: {
- "user": {
- "full_name": "string",
- "username": "string"
- },
- "signup": {
- "method": "email",
- "datetime": "2018-04-03T07:32:55Z"
- }
-}
-});
-
-```
-
-```javascript
-//Coming soon...
-
-```
-
-```ruby
-# Coming soon...
-
-```
-
-```python
-//Coming soon...
-
-```
-
-```java
-/* asyncapi-java-tools */
-try (JmsServer client = builder.build()) {
-
- client.accounts.1.0.action.user.signup()
- .publish({
- "user": {
- "full_name": "string",
- "username": "string"
- },
- "signup": {
- "method": "email",
- "datetime": "2018-04-03T07:32:55Z"
- }
-})
- .toCompletableFuture()
- .get();
-}
-
-```
-
-```go
-//Coming soon...
-
-```
-
-*Action to sign a user up.*
-
-Multiline description of what this action does. **It allows Markdown.**
-
-#### Headers
-
-##### Properties
-
-|Name|Type|Required|Description|
-|---|---|---|---|
-|qos|integer|false|Quality of Service|
-|retainFlag|boolean|false|This flag determines if the message will be saved by the broker for the specified topic as last known good value. New clients that subscribe to that topic will receive the last retained message on that topic instantly after subscribing. More on retained messages and best practices in one of the next posts.|
-
-#### Payload
-
-##### Properties
-
-|Name|Type|Required|Description|
-|---|---|---|---|
-|user|object|false|No description|
-|full_name|string|false|User full name|
-|username|string|true|User handle|
-|signup|object|false|No description|
-|method|string|true|Signup method|
-|datetime|string|true|Date and Time of the message|
-
-
-
-# Default
-
-## accounts.1.0.event.user.signup
-
-### subscribe
-
-> Example payload
-
-```json
-
-{
- "user": {
- "id": "string",
- "full_name": "string",
- "username": "string"
- },
- "signup": {
- "method": "email",
- "datetime": "2018-04-03T07:32:55Z"
- }
-}
-```
-
-> Code Samples
-
-```javascript--nodejs
-const hermes = require('hermesjs');
-const app = hermes();
-
-app.from.client.send({
- topic: 'accounts.1.0.event.user.signup',
- payload: {
- "user": {
- "id": "string",
- "full_name": "string",
- "username": "string"
- },
- "signup": {
- "method": "email",
- "datetime": "2018-04-03T07:32:55Z"
- }
-}
-});
-
-```
-
-```javascript
-//Coming soon...
-
-```
-
-```ruby
-# Coming soon...
-
-```
-
-```python
-//Coming soon...
-
-```
-
-```java
-/* asyncapi-java-tools */
-try (JmsServer client = builder.build()) {
-
- client.accounts.1.0.event.user.signup()
- .publish({
- "user": {
- "id": "string",
- "full_name": "string",
- "username": "string"
- },
- "signup": {
- "method": "email",
- "datetime": "2018-04-03T07:32:55Z"
- }
-})
- .toCompletableFuture()
- .get();
-}
-
-```
-
-```go
-//Coming soon...
-
-```
-
-#### Payload
-
-##### Properties
-
-|Name|Type|Required|Description|
-|---|---|---|---|
-|user|object|false|No description|
-|id|string|true|Resource identifier|
-|full_name|string|false|User full name|
-|username|string|true|User handle|
-|signup|object|false|No description|
-|method|string|true|Signup method|
-|datetime|string|true|Date and Time of the message|
-
-
-
-# Schemas
-
-## id
-
-
-
-```json
-"string"
-```
-
-### Properties
-
-|Name|Type|Required|Description|
-|---|---|---|---|
-|id|[id](#schemaid)|false|Resource identifier|
-
-## username
-
-
-
-```json
-"string"
-```
-
-### Properties
-
-|Name|Type|Required|Description|
-|---|---|---|---|
-|username|[username](#schemausername)|false|User handle|
-
-## datetime
-
-
-
-```json
-"2018-04-03T07:32:55Z"
-```
-
-### Properties
-
-|Name|Type|Required|Description|
-|---|---|---|---|
-|datetime|[datetime](#schemadatetime)(date-time)|false|Date and Time of the message|
-
-## MQTTQoSHeader
-
-
-
-```json
-1
-```
-
-### Properties
-
-|Name|Type|Required|Description|
-|---|---|---|---|
-|qos|[MQTTQoSHeader](#schemamqttqosheader)(int32)|false|Quality of Service|
-
-#### Enumerated Values
-
-|Property|Value|
-|---|---|
-|qos|0|
-|qos|2|
-
-## MQTTRetainHeader
-
-
-
-```json
-false
-```
-
-### Properties
-
-|Name|Type|Required|Description|
-|---|---|---|---|
-|retainFlag|[MQTTRetainHeader](#schemamqttretainheader)|false|This flag determines if the message will be saved by the broker for the specified topic as last known good value. New clients that subscribe to that topic will receive the last retained message on that topic instantly after subscribing. More on retained messages and best practices in one of the next posts.|
-
-## user
-
-
-
-```json
-{
- "id": "string",
- "full_name": "string",
- "username": "string"
-}
-```
-
-### Properties
-
-|Name|Type|Required|Description|
-|---|---|---|---|
-|» id|[id](#schemaid)|true|Resource identifier|
-|» full_name|string|false|User full name|
-|» username|[username](#schemausername)|true|User handle|
-
-## userCreate
-
-
-
-```json
-{
- "full_name": "string",
- "username": "string"
-}
-```
-
-### Properties
-
-|Name|Type|Required|Description|
-|---|---|---|---|
-|» full_name|string|false|User full name|
-|» username|[username](#schemausername)|true|User handle|
-
-## signup
-
-
-
-```json
-{
- "method": "email",
- "datetime": "2018-04-03T07:32:55Z"
-}
-```
-
-### Properties
-
-|Name|Type|Required|Description|
-|---|---|---|---|
-|» method|string|true|Signup method|
-|» datetime|[datetime](#schemadatetime)(date-time)|true|Date and Time of the message|
-
-#### Enumerated Values
-
-|Property|Value|
-|---|---|
-|method|email|
-|method|facebook|
-|method|twitter|
-|method|github|
-|method|google|
-
diff --git a/docs/source/fonts/slate.eot b/docs/source/fonts/slate.eot
deleted file mode 100644
index 13c4839a..00000000
Binary files a/docs/source/fonts/slate.eot and /dev/null differ
diff --git a/docs/source/fonts/slate.svg b/docs/source/fonts/slate.svg
deleted file mode 100644
index 5f349823..00000000
--- a/docs/source/fonts/slate.svg
+++ /dev/null
@@ -1,14 +0,0 @@
-
-
-
diff --git a/docs/source/fonts/slate.ttf b/docs/source/fonts/slate.ttf
deleted file mode 100644
index ace9a46a..00000000
Binary files a/docs/source/fonts/slate.ttf and /dev/null differ
diff --git a/docs/source/fonts/slate.woff b/docs/source/fonts/slate.woff
deleted file mode 100644
index 1e72e0ee..00000000
Binary files a/docs/source/fonts/slate.woff and /dev/null differ
diff --git a/docs/source/fonts/slate.woff2 b/docs/source/fonts/slate.woff2
deleted file mode 100644
index 7c585a72..00000000
Binary files a/docs/source/fonts/slate.woff2 and /dev/null differ
diff --git a/docs/source/images/logo.png b/docs/source/images/logo.png
deleted file mode 100644
index 2a5f45b0..00000000
Binary files a/docs/source/images/logo.png and /dev/null differ
diff --git a/docs/source/images/navbar.png b/docs/source/images/navbar.png
deleted file mode 100644
index df38e90d..00000000
Binary files a/docs/source/images/navbar.png and /dev/null differ
diff --git a/docs/source/include.md b/docs/source/include.md
deleted file mode 100644
index 80333155..00000000
--- a/docs/source/include.md
+++ /dev/null
@@ -1,3 +0,0 @@
-###
-
-This content comes from `include.md`
diff --git a/docs/source/includes/_errors.md b/docs/source/includes/_errors.md
deleted file mode 100644
index 7b35e92b..00000000
--- a/docs/source/includes/_errors.md
+++ /dev/null
@@ -1,22 +0,0 @@
-# Errors
-
-
-
-The Kittn API uses the following error codes:
-
-
-Error Code | Meaning
----------- | -------
-400 | Bad Request -- Your request is invalid.
-401 | Unauthorized -- Your API key is wrong.
-403 | Forbidden -- The kitten requested is hidden for administrators only.
-404 | Not Found -- The specified kitten could not be found.
-405 | Method Not Allowed -- You tried to access a kitten with an invalid method.
-406 | Not Acceptable -- You requested a format that isn't json.
-410 | Gone -- The kitten requested has been removed from our servers.
-418 | I'm a teapot.
-429 | Too Many Requests -- You're requesting too many kittens! Slow down!
-500 | Internal Server Error -- We had a problem with our server. Try again later.
-503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later.
diff --git a/docs/source/includes/_head.md b/docs/source/includes/_head.md
deleted file mode 100644
index 67ca9cca..00000000
--- a/docs/source/includes/_head.md
+++ /dev/null
@@ -1,2 +0,0 @@
-
-
diff --git a/docs/source/index.html.md b/docs/source/index.html.md
deleted file mode 100644
index d69a0abb..00000000
--- a/docs/source/index.html.md
+++ /dev/null
@@ -1,6871 +0,0 @@
----
-title: Postgres API v0.0.0
-language_tabs:
- - shell: Shell
- - http: HTTP
- - javascript: JavaScript
- - ruby: Ruby
- - python: Python
- - php: PHP
- - java: Java
- - go: Go
-toc_footers: []
-includes: []
-search: true
-highlight_theme: darkula
-headingLevel: 2
-
----
-
-
-
-
Postgres API v0.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.
-
-Manage your PostgreSQL database using a RESTful API.
-
-This is still in early development, so most of the functionality is read-only.
-
-The goal of this API is to enable the full management of a Postgres database using a RESTful interface. This includes adding tables, columns, roles, and users at runtime, as well as running ad-hoc queries.
-
-Made by Supabase: https://supabase.io
-
-# Getting started
-
-## Usage
-
-> Basic usage
-
-```sh
-curl -X GET http://localhost:1337/ \
--H 'Content-Type: application/json' \
--H 'X-Connection-Encrypted: ENCRYPTED_STRING'
-```
-```js
-const data = await fetch('http://localhost:1337', {
-method: 'GET',
-headers: {
- 'Content-Type': 'application/json',
- 'X-Connection-Encrypted': 'ENCRYPTED_STRING'
-}
-})
-```
-
-For security reasons, this API is best self-hosted and set up with ENV_VARS with the default connection string.
-
-If you want to use this with multiple Postgres instances, you can pass the connection string as a header but it must be encrypted.
-
-## Self Hosting
-
-```
-https://github.com/supabase/pg-api
-```
-
-We support several different methods for self-hosting, detailed in the [repository](https://github.com/supabase/pg-api).
-
-## Authentication
-
-Authentication is not provided. Make sure you use this inside a secure network or behind a secure API proxy.
-
-Email: Support Web: Support
-License: Apache 2.0
-
-